Start free →

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.

All of the API reference

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:write
Body
events (required)

/api/arbiter

POST /api/arbiter/route

Select optimal model for a request

Authentication
API key
Key scope
inference:write
Body
agentId · promptTokens · mode · qualityFloor · latencyCeilingMs · budgetUsd · candidates

/api/cache

POST /api/cache/lookup

Look up a cached answer for a prompt

Authentication
API key
Key scope
cache:read
Body
prompt (required) · threshold · model

POST /api/cache/store

Store a prompt and its answer in the cache

Authentication
API key
Key scope
cache:write
Body
prompt (required) · response (required) · model (required) · provider (required) · costUsd · ttlMs

/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:read
Body
action · agentId (required) · workflowId · prompt · model · costUsd

/api/v1/compress

POST /api/v1/compress

Compress long reasoning content (levels L1 to L3)

Authentication
API key
Key scope
advisory:read
Module
Served where the deployment runs FEATURE_CCE.
Body
content (required) · level · agentId · workflowId · traceId

/api/v1/reconstruct

POST /api/v1/reconstruct

Reconstruct compressed content from its id

Authentication
API key
Key scope
advisory:read
Module
Served where the deployment runs FEATURE_CCE.
Body
cognitiveStateId (required)

/api/v1/marketplace

GET /api/v1/marketplace

The best-fit model of the provider marketplace for your constraints

Authentication
API key
Key scope
advisory:read
Module
Served where the deployment runs FEATURE_MARKETPLACE.
Parameters
mode · maxCostPer1k · maxLatencyMs · minQuality · requiresVision · requiresTools · minContextWindow