Skip to content

API Reference

The Acrobi Cortex REST API gives you programmatic access to agents, tasks, swarms, memories, skills, integrations, and all platform features.

Base URL

https://api.cortex.acrobi.com

Local development:

http://localhost:3001

Versioning

The API is currently at v1. Breaking changes will be introduced under a new version prefix (e.g. /v2/). The current unversioned routes are stable.

Content Type

All requests and responses use application/json. Always include:

Content-Type: application/json

Authentication

All protected endpoints require a Bearer token in the Authorization header:

Authorization: Bearer <your-api-token>

Tokens are issued via the /api/auth/login endpoint or created as long-lived API keys in the dashboard under Settings → API Keys.

Agent-to-Agent calls

Agents calling the API on behalf of a task should pass X-Agent-Name and X-Task-Id headers for audit tracing.

Standard Response Shapes

Success:

json
{
  "success": true,
  "data": { ... }
}

Success with pagination:

json
{
  "success": true,
  "data": [...],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 143
  }
}

Error:

json
{
  "error": "Human-readable message describing what went wrong"
}

HTTP Status Codes

CodeMeaning
200OK — request succeeded
201Created — resource was created
400Bad Request — missing or invalid parameters
401Unauthorized — missing or invalid auth token
403Forbidden — valid token but insufficient permissions
404Not Found — resource does not exist
429Too Many Requests — rate limit exceeded
500Internal Server Error — something went wrong on our end

Rate Limiting

Every response includes rate limit headers:

HeaderDescription
X-RateLimit-LimitMaximum requests allowed in the window
X-RateLimit-RemainingRequests remaining in the current window
X-RateLimit-ResetUnix timestamp when the window resets
Retry-AfterSeconds to wait (only on 429 responses)

Default limits: 1 000 requests / minute per API key. Burst-heavy operations (execute, swarm deploy) count as 5 requests each.

Pagination

List endpoints accept limit and offset query parameters:

ParameterDefaultMaxDescription
limit20100Number of items to return
offset0Number of items to skip

Example:

bash
curl "https://api.cortex.acrobi.com/api/agents?limit=10&offset=20" \
  -H "Authorization: Bearer <token>"

Scope Headers

Multi-tenant endpoints respect optional scope headers for organization and project isolation:

HeaderDescription
X-Scope-Organization-IdRestrict to a specific organization
X-Scope-Project-IdRestrict to a specific project

API Domains

DomainDescription
AgentsCreate, configure, execute, and monitor agents
TasksKanban tasks with status and agent assignment
SkillsReusable skill handlers assignable to agents
SwarmsMulti-agent swarm orchestration
IntegrationsExternal service connections
WebhooksEvent-driven outbound notifications
Agent StatusReal-time agent status reporting and heartbeats
MemoriesPersistent knowledge storage and search
LLM ProvidersConfigure and test language model providers
ConversationsConversation history and full-text search
Cron JobsScheduled recurring agent tasks
DocumentsStructured document storage

Built by Acrobi