API Overview
The Cortex API is an HTTP API for building applications and automation on Cortex.
Base URL
https://api.cortex.cognit-dx.comRequest Format
- JSON endpoints expect
Content-Type: application/json. - Protected endpoints require
Authorization: Bearer <token>. - Path IDs are UUIDs unless an endpoint states otherwise.
- List endpoints use
limitandoffsetwhere pagination is supported.
API Types
| Type | Purpose |
|---|---|
| Platform API | Endpoints for applications, SDKs, CLI workflows, and automations. |
| Organization Administration | Endpoints for administrators managing the current organization. |
| System Operations | Endpoints for Cortex system administrators. |
Response Conventions
- List endpoints commonly return
{ items, total?, limit?, offset? }. - Errors use
{ error, code?, details? }. - Async execution endpoints return queued or running records first; clients then read run state and events.