Quick Navigation
Authentication Organizations Populations Forecasts

Cortex API

Simulate human response in seconds. Make better decisions, faster.

Cognitive AI platform for content analysis and audience forecasting

🔐 Authentication

POST /rest/api/auth/login
Login to the system and get access and refresh tokens for API authentication.
Request Body Example
{ "username": "yourusername", "password": "yourpassword" }
Response Example
{ "access_token": "eyJhbGciOiJSU....", "expires_in": 691200, }
Security: Requires bearer token authentication for subsequent API calls. You will want to refresh your token before it expires.

🏢 Organizations

GET /rest/api/organizations
List all organizations for the signed-in user with their forecast limit details and access permissions. You will want to grab the uid as an account_id you will need for subsequent calls
Response Example
{ "data": [ { "name": "Your Organization", "uid": "dfa1314e-5670-42...", "forecast_subscription": { "forecasts_limit": 50000, "remaining_forecasts_count": 49000, "is_expired": false } } ] }

👥 Populations & Demographics

GET /rest/api/populations/{account_id}?shallow=true
Return a list of available populations for the provided account ID. Supports shallow mode for basic info.
Path Parameters
[use the org uid for account_id parameter]
Query Parameters
[ { "id": 63, "name": "us", "display_name": "United States", "composite_key": "us", "llm_context": null, }, { "id": 55, "name": "uk", "display_name": "UK Adults", "composite_key": "uk", "llm_context": "United Kingdom", } ]
GET /rest/api/populations/{account_id}/{population_id}
Return detailed information about a specific population including categories, segments, and demographic breakdowns. You will use the results and filter the segments you want. Or you can simply just use the root population payload with categories[] being empty for broad reach.
Path Parameters
[account_id and population_id parameter]
Response Example
{ "id": 56, "name": "us2", "display_name": "US Adults", "composite_key": "us2", "llm_context": "United States of America", "categories": [ { "id": 5442, "name": "gender", "display_name": "Gender", "exclusive": false, "llm_context": null, "enabled": true, "population_id": 56, "composite_key": "us2::gender", "segments": [ { "id": 38168, "name": "female", "display_name": "Female", "enabled": true, "composite_key": "us2::gender::female", "threshold": 150, "llm_context": "", "respondants_count": 0, "category_id": 5442, "org_enabled": true, "org_visible": true, "newSinceLastSave": false, "permanentlyHidden": false } ] } ] }

🔮 Forecasts & Predictions

POST /rest/api/forecasts
Create cognitive AI forecasts to predict human response patterns. Leverage Limbik's advanced models to analyze content believability, virality potential, and audience engagement. Notice you will get uids so that you can retrieve the results of the forecast asynchronously.
Request Body Example
[{ "type": "Message", "displayText": "Formula one next race", "additionalDetail": "The latest dev in Formula...", "messages": [ { "body": "The latest dev in Formula ..." } ], "population": { "id": 56, "name": "us2", "org_enabled": true, "org_visible": true, "categories": [], "display_name": "US Adults", "composite_key": "us2", "enabled": true } }]
Response Example
{ "message": "Forecasting. Please standby!", "uids": [ "085bac74-582c-429d-b5db-344c07886c21" ], "forecastSentimentResults": [] }
POST /rest/api/forecasts/synchronous
Generate instant cognitive AI predictions with complete results returned immediately. Synchronous for real-time single forecast . This call is blocking
Request Body Example
{ "type": "Message", "displayText": "Formula one next race", "additionalDetail": "The latest dev in Formula is great", "messages": [ { "body": "The latest dev in Formula is great" } ], "population": { "id": 56, "name": "us2", "org_enabled": true, "org_visible": true, "categories": [], "display_name": "US Adults", "composite_key": "us2", "enabled": true } }
Response Example
{ "uid": "e078687e-ae6b-49d9-8389-797888321eee", "datetime": "2025-05-30T20:43:56.809+00:00", "userId": "ae965136-1637-473f-b4da-04bbdbda5d26", "accountId": "dfa1314e-5670-42bb-9ddc-30caee7ab01c", "name": "Formula one next rac...", "user_message_context": "", "population": [ { "name": "us2", "categories": [], "llm_context": null, "display_name": "US Adults" } ], "text": "Formula one next race", "summary": "The latest dev in Formula is great", "suggestionExplanation": null, "sharedWithOrg": false, "summary_visible": true, "label": "Message", "img": "", "active": true, "errorId": null, "parentForecastId": null, "color": "#1D5C0C", "model_status": "Success", "predict_model_variant": "llm_v3_2_2", "privacy_compliant": false, "model_outputs": { "bel_model_version": "OAI_ft", "vir_model_version": "OAI_ft", "belmetrics": { "metrics": { "moe": "0.0146", "mean_val": "0.4650", } }, "virmetrics": { "metrics": { "moe": "0.0104", "mean_val": "0.3140", } } }, "modelError": null, "has_successful_suggestion": false, "is_good_score": true, "scoreExplanation": "The Resonance of 46.5% is representative of US Adults .....", "displayed": true, "groupId": null, "parentContentionId": null, "scheduleId": null, "model_sentiment": { "sentiment": null, "confidence": null }, "suggestionCodeCompliance": false }
GET /rest/api/forecasts/{id}
Retrieve detailed results for a specific forecast including believability scores, virality metrics, and model outputs. Make sure to check for model_status = "Success"
Path Parameters
[forecast ID parameter Ex. dfa1314e-5670-42bb-9ddc-30caee7ab01c]
Response Example
{ "uid": "e078687e-ae6b-49d9-8389-797888321eee", "datetime": "2025-05-30T20:43:56.809+00:00", "userId": "ae965136-1637-473f-b4da-04bbdbda5d26", "accountId": "dfa1314e-5670-42bb-9ddc-30caee7ab01c", "name": "Formula one next rac...", "user_message_context": "", "model_status": "Success" "more": "...." }

📋 Getting Started

https://cortex.prod.limbik.com/rest/api
You will land on our swagger ui for live documentation.
  • Identify your orgainzation id ( account_id )
  • Filter for available populations and segments that apply in preparation for forecasting
  • Prepare your forecast payload with population inlined
  • execute the forecast
  • Reteirve the results by it's forecast uid
    • Note: All endpoints require a valid bearer token. Include your account_id in the header for organization-specific operations.