API reference
Telemetry and optimisation
Report the calls made outside the gateway, pick a model for a request, look up and store cached answers, check an agent for a loop, compress long content and query the provider marketplace.
Route summaries and field names are written in English, here and in the file.
/api/ingest
POST /api/ingest
Ingest AI usage events
Authentication
API key
Key scope
ingest:writeBody
events (required)Answers
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 402 budget_exceeded · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, eu_storage_unavailable · 413 validation_failed · 429 ingest_queue_full · 500 internal_error · 503 service_unavailable · 504/api/arbiter
POST /api/arbiter/route
Select optimal model for a request
Authentication
API key
Key scope
inference:writeBody
agentId · promptTokens · mode · qualityFloor · latencyCeilingMs · budgetUsd · candidatesAnswers
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 402 budget_exceeded · 403 policy_blocked, sovereignty_blocked, jurisdiction_blocked, kill_switch_active, human_review_not_resumable, api_key_scope_denied · 429 · 500 internal_error · 503 budget_unavailable, governance_error/api/cache
POST /api/cache/lookup
Look up a cached answer for a prompt
Authentication
API key
Key scope
cache:readBody
prompt (required) · threshold · modelAnswers
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_errorPOST /api/cache/store
Store a prompt and its answer in the cache
Authentication
API key
Key scope
cache:writeBody
prompt (required) · response (required) · model (required) · provider (required) · costUsd · ttlMsAnswers
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error/api/loops
POST /api/loops/check
Check an agent for a loop, reset its counters, or read its state
Authentication
API key
Key scope
advisory:readBody
action · agentId (required) · workflowId · prompt · model · costUsdAnswers
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error/api/v1/compress
POST /api/v1/compress
Compress long reasoning content (levels L1 to L3)
Authentication
API key
Key scope
advisory:readModule
Served where the deployment runs
FEATURE_CCE.Body
content (required) · level · agentId · workflowId · traceIdAnswers
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error · 501 feature_disabled/api/v1/reconstruct
POST /api/v1/reconstruct
Reconstruct compressed content from its id
Authentication
API key
Key scope
advisory:readModule
Served where the deployment runs
FEATURE_CCE.Body
cognitiveStateId (required)Answers
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 501 feature_disabled/api/v1/marketplace
GET /api/v1/marketplace
The best-fit model of the provider marketplace for your constraints
Authentication
API key
Key scope
advisory:readModule
Served where the deployment runs
FEATURE_MARKETPLACE.Parameters
mode · maxCostPer1k · maxLatencyMs · minQuality · requiresVision · requiresTools · minContextWindowAnswers
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 · 429 · 500 internal_error · 501 feature_disabled