BUILD WITH INFERMAX
Managed Inference
Discover entitled models and integrate Chat Completions with explicit readiness and request state.
GET
/v1/modelsGET/v1/model-catalogGET/v1/model-catalog/{id}GET/v1/endpointsGET/v1/endpoints/{id}/revisionGET/v1/operations/{id}GET/v1/models/{id}/healthPOST/v1/chat/completionsGET/v1/inference/limitsGET/v1/inference/requestsGET/v1/inference/requests/{id}POST/v1/inference/requests/{id}/cancelGET/v1/requests/{id}/receiptEligible model catalog; listing does not mean a runtime is ready
Up to 100 explicitly entitled published models. availability reflects fresh deployment probes; check model health before admission.
Authorization: Bearer · project scope
Parameters
No additional parameters are declared.
Responses
200 Persisted contract response; runtime readiness is not implied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"object": {
"type": "string",
"enum": [
"list"
]
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"enum": [
"model"
]
},
"created": {
"type": "integer"
},
"owned_by": {
"type": "string"
},
"display_name": {
"type": "string"
},
"context_window": {
"type": "integer"
},
"max_output_tokens": {
"type": "integer"
},
"availability": {
"type": "string",
"enum": [
"available",
"unavailable"
]
}
}
}
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Source-backed catalog search; availability remains proof-checked and separate from entitlement
Authorization: Bearer · project scope
Parameters
No additional parameters are declared.
Responses
200 Successful operation.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductCatalogPage"
}400 Invalid request
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}401 Missing, expired or revoked authentication
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}403 Role, scope, Origin or CSRF denied
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}404 Resource absent or not visible
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}409 Idempotency, version or state conflict
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}413 Body exceeds64KiB
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}422 Invalid reference or value
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}500 Internal server error
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}503 Dependency unavailable
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}Visible model details; hidden and unpublished IDs return 404
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductCatalogDetail"
}400 Invalid request
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}401 Missing, expired or revoked authentication
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}403 Role, scope, Origin or CSRF denied
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}404 Resource absent or not visible
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}409 Idempotency, version or state conflict
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}413 Body exceeds64KiB
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}422 Invalid reference or value
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}500 Internal server error
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}503 Dependency unavailable
application/json
Schema · JSON
{
"$ref": "#/components/schemas/ProductManagementErrorEnvelope"
}List project endpoints
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
limitquery | Optional | {
"maximum": 100,
"default": 50,
"type": "number"
} |
afterquery | Optional | {
"type": "string"
} |
searchquery | Optional | {
"type": "string"
} |
sortquery | Optional | {
"type": "string",
"enum": [
"id",
"name"
]
} |
directionquery | Optional | {
"type": "string",
"enum": [
"asc",
"desc"
]
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": true
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Read the endpoint revision
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": true
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Read operation state
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": true
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Model readiness, separate from API/database health
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Persisted contract response; runtime readiness is not implied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"model": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"unavailable"
]
},
"reason": {
"type": "string"
},
"acceptingRequests": {
"type": "boolean"
},
"runtimeCapabilities": {
"type": "object",
"properties": {
"adapter": {
"type": "string"
},
"liveQualified": {
"type": "boolean"
},
"version": {
"type": "string"
},
"textChatTokenization": {
"type": "boolean"
},
"requestStatus": {
"type": "string"
},
"cancellationAcknowledgement": {
"type": "string"
},
"disconnectCancellation": {
"type": "string"
},
"modelWeightRevision": {
"type": "string"
}
}
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Chat completion or SSE stream from an admitted private runtime
Bounded text/tool Chat Completions with JSON/SSE and qualified reasoning deltas. Active endpoint revision admission and durable request mapping precede dispatch. Missing Idempotency-Key creates an independent attempt; explicit-key replay never redispatches. Unkeyed client retries may create new attempts after ambiguous failures. Response content is not retained. Legacy text fixtures remain compatible; no implicit fallback from an assigned unready V1 route, images or customer-selected upstream URL.
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
Idempotency-Keyheader | Optional | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
X-Infermax-Attributionheader | Optional | Optional JSON: feature (DIRECT_API, AGENT, SUB_AGENT, TASK), runId UUID, parentRunId UUID. Max1024 characters. SUB_AGENT requires an existing same-project parent. Immutable lineage; no content or personal data. Text modality is server-recorded; omitted feature stays unknown. {
"type": "string",
"maxLength": 1024
} |
Request body · required
application/json
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"model",
"messages"
],
"properties": {
"model": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9._-]{1,99}$"
},
"messages": {
"type": "array",
"minItems": 1,
"maxItems": 64,
"items": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"role",
"content"
],
"properties": {
"role": {
"type": "string",
"enum": [
"system",
"user"
]
},
"content": {
"type": "string",
"maxLength": 32000
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"role",
"content"
],
"properties": {
"role": {
"type": "string",
"enum": [
"assistant"
]
},
"content": {
"type": "string",
"maxLength": 32000,
"nullable": true
},
"reasoning_content": {
"type": "string",
"maxLength": 32000,
"nullable": true
},
"tool_calls": {
"type": "array",
"minItems": 1,
"maxItems": 32,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"function"
],
"properties": {
"id": {
"type": "string",
"maxLength": 128
},
"type": {
"type": "string",
"enum": [
"function"
]
},
"function": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"arguments"
],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"arguments": {
"type": "string",
"maxLength": 32000
}
}
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"role",
"content",
"tool_call_id"
],
"properties": {
"role": {
"type": "string",
"enum": [
"tool"
]
},
"content": {
"type": "string",
"maxLength": 32000
},
"tool_call_id": {
"type": "string",
"maxLength": 128
}
}
}
]
}
},
"stream": {
"type": "boolean",
"default": false
},
"max_completion_tokens": {
"type": "integer",
"minimum": 1,
"maximum": 100000,
"default": 256
},
"max_tokens": {
"type": "integer",
"minimum": 1,
"maximum": 100000,
"description": "Alias; if both caps are supplied they must agree."
},
"tools": {
"type": "array",
"maxItems": 32,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"function"
],
"properties": {
"type": {
"type": "string",
"enum": [
"function"
]
},
"function": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"parameters"
],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"description": {
"type": "string",
"maxLength": 8192
},
"parameters": {
"type": "object",
"additionalProperties": true
},
"strict": {
"type": "boolean"
}
}
}
}
}
},
"tool_choice": {
"oneOf": [
{
"type": "string",
"enum": [
"auto",
"none",
"required"
]
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"function"
],
"properties": {
"type": {
"type": "string",
"enum": [
"function"
]
},
"function": {
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
}
}
}
}
]
},
"stream_options": {
"type": "object",
"additionalProperties": false,
"required": [
"include_usage"
],
"properties": {
"include_usage": {
"type": "boolean"
}
}
},
"temperature": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"top_p": {
"type": "number",
"exclusiveMinimum": true,
"minimum": 0,
"maximum": 1
},
"parallel_tool_calls": {
"type": "boolean"
}
}
}Responses
200 Completion or SSE stream; runtime-reported usage only
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"object": {
"type": "string"
},
"model": {
"type": "string"
},
"choices": {
"type": "array",
"items": {
"type": "object"
}
},
"usage": {
"type": "object"
}
}
}text/event-stream
Schema · JSON
{
"type": "string"
}400 Invalid request or CONTEXT_LIMIT_EXCEEDED: chat-template input plus requested output cannot fit the catalog/runtime window; no inference dispatch or usage
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid"
},
"retryable": {
"type": "boolean"
},
"dispatched": {
"type": "boolean"
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 REPLAY_UNAVAILABLE: inspect request status; content is not retained
No response body schema is declared for this status.
413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 CONCURRENCY_LIMIT; Retry-After: 1
No response body schema is declared for this status.
502 Runtime failed or deadline exceeded; inspect durable request status before retrying
No response body schema is declared for this status.
503 MODEL_NOT_READY or tokenizer/version/model/revision/template verification failed or timed out. No inference dispatched; no token usage or monetary event created.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Bounded readiness/admission rejection code; includes MODEL_NOT_READY and tokenizer/lineage failures"
},
"message": {
"type": "string"
},
"type": {
"type": "string"
},
"requestId": {
"type": "string",
"format": "uuid"
},
"retryable": {
"type": "boolean",
"enum": [
false
]
}
}
}
}
}Example · JSON
{
"error": {
"code": "MODEL_NOT_READY",
"message": "No qualified model runtime is connected. No inference was executed or billed.",
"type": "service_unavailable",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"retryable": false
}
}GET /v1/inference/limits
Authorization: Bearer · project scope
Parameters
No additional parameters are declared.
Responses
200 Persisted contract response; runtime readiness is not implied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"configuredConcurrency": {
"type": "integer"
},
"acceptingRequests": {
"type": "boolean"
},
"runtimeCapabilities": {
"type": "object",
"properties": {
"adapter": {
"type": "string"
},
"liveQualified": {
"type": "boolean"
},
"version": {
"type": "string"
},
"textChatTokenization": {
"type": "boolean"
},
"requestStatus": {
"type": "string"
},
"cancellationAcknowledgement": {
"type": "string"
},
"disconnectCancellation": {
"type": "string"
},
"modelWeightRevision": {
"type": "string"
}
}
},
"runtimeConnected": {
"type": "boolean"
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}List inference requests
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
limitquery | Optional | {
"maximum": 100,
"default": 50,
"type": "number"
} |
afterquery | Optional | {
"type": "string"
} |
Responses
200 Persisted contract response; runtime readiness is not implied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"api_key_id": {
"type": "string",
"format": "uuid"
},
"model_id": {
"type": "string"
},
"deployment_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"state": {
"type": "string",
"enum": [
"REJECTED",
"ADMITTED",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLED",
"UNKNOWN"
]
},
"error_code": {
"type": "string",
"nullable": true
},
"max_output_tokens": {
"type": "integer"
},
"runtime_digest": {
"type": "string",
"nullable": true
},
"probe_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deadline_at": {
"type": "string",
"format": "date-time"
},
"started_at": {
"type": "string",
"format": "date-time"
},
"completed_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dispatch_started_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Durable inference dispatch boundary; does not prove GPU execution."
}
}
}
},
"nextCursor": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Read an inference request
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
Responses
200 Persisted contract response; runtime readiness is not implied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"api_key_id": {
"type": "string",
"format": "uuid"
},
"model_id": {
"type": "string"
},
"deployment_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"state": {
"type": "string",
"enum": [
"REJECTED",
"ADMITTED",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLED",
"UNKNOWN"
]
},
"error_code": {
"type": "string",
"nullable": true
},
"max_output_tokens": {
"type": "integer"
},
"runtime_digest": {
"type": "string",
"nullable": true
},
"probe_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deadline_at": {
"type": "string",
"format": "date-time"
},
"started_at": {
"type": "string",
"format": "date-time"
},
"completed_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dispatch_started_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Durable inference dispatch boundary; does not prove GPU execution."
}
}
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Request cancellation
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
Idempotency-Keyheader | Required | {
"type": "string",
"minLength": 1,
"maxLength": 128
} |
idpath | Required | {
"type": "string"
} |
Responses
200 Successful operation.
application/json
Schema · JSON
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": true
}202
No response body schema is declared for this status.
400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Read a request receipt
Authorization: Bearer · project scope
Parameters
| Name / location | Requirement | Definition |
|---|---|---|
idpath | Required | {
"type": "string"
} |
projectpath | Required | {
"type": "string"
} |
Responses
200 Project-scoped durable attempt and original usage receipt. Export acknowledgement is not native meter reconciliation or a charge.
application/json
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"properties": {
"request": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"state": {
"type": "string"
},
"modelId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time"
},
"completedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"required": [
"id",
"state",
"modelId",
"startedAt",
"completedAt"
]
},
"receipt": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"NOT_RECORDED"
]
}
},
"required": [
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"RECORDED"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"sourceEventId": {
"type": "string"
},
"recordedAt": {
"type": "string",
"format": "date-time"
},
"measurementStatus": {
"type": "string",
"enum": [
"MEASURED",
"UNKNOWN"
]
},
"executionMode": {
"type": "string",
"enum": [
"REAL",
"SIMULATED"
]
},
"inputTokens": {
"type": "string",
"nullable": true
},
"outputTokens": {
"type": "string",
"nullable": true
},
"cachedInputTokens": {
"type": "string",
"nullable": true
}
},
"required": [
"status",
"id",
"sourceEventId",
"recordedAt",
"measurementStatus",
"executionMode",
"inputTokens",
"outputTokens",
"cachedInputTokens"
]
}
]
},
"export": {
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"NOT_ENQUEUED",
"ACKNOWLEDGED",
"FAILED",
"PENDING"
]
},
"acknowledgedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"attempts": {
"type": "integer",
"nullable": true,
"minimum": 0
},
"reconciliation": {
"type": "string",
"enum": [
"NOT_CHECKED"
]
}
},
"required": [
"status",
"acknowledgedAt",
"attempts",
"reconciliation"
]
},
"trace": {
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"RESTRICTED",
"UNAVAILABLE",
"RECORDED"
]
},
"reason": {
"type": "string"
},
"traceId": {
"type": "string",
"pattern": "^[a-f0-9]{32}$"
},
"spanId": {
"type": "string",
"pattern": "^[a-f0-9]{16}$"
},
"recordedAt": {
"type": "string",
"format": "date-time"
},
"ingestion": {
"type": "string",
"enum": [
"NOT_VERIFIED"
]
},
"links": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"kind": {
"type": "string",
"enum": [
"LANGFUSE",
"SIGNOZ"
]
},
"label": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"authenticationRequired": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"kind",
"label",
"url",
"authenticationRequired"
]
}
}
},
"required": [
"status",
"links"
]
},
"financialStatus": {
"type": "string",
"enum": [
"NOT_EVALUATED"
]
}
},
"required": [
"request",
"receipt",
"export",
"trace",
"financialStatus"
]
}400 Invalid request
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 Missing or revoked API key
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}403 Role or policy denied
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}404 Resource absent or not visible
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}409 Idempotency, capacity, quota or state conflict
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}413 Request body exceeds 64 KiB
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}422 Invalid reference
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}429 Rate limit; honor Retry-After
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}503 Dependency unavailable
application/json
Schema · JSON
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Schema definitions
Expand a named definition to resolve #/components/schemas/… references in this contract. These definitions contain only schemas reachable from the published Customer operations.
ProductCatalogPage
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductCatalogItem"
},
"maxItems": 100
},
"nextCursor": {
"type": "string",
"nullable": true
}
}
}ProductCatalogItem
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"displayName",
"family",
"modalities",
"capabilities",
"limits",
"visibility",
"entitled",
"availability",
"qualification",
"metadataSource",
"price"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"displayName": {
"type": "string"
},
"family": {
"type": "string",
"nullable": true
},
"modalities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"text",
"image",
"audio",
"video"
]
},
"nullable": true
},
"capabilities": {
"$ref": "#/components/schemas/ProductCatalogCapabilities"
},
"limits": {
"$ref": "#/components/schemas/ProductCatalogLimits"
},
"visibility": {
"type": "string",
"enum": [
"PUBLISHED"
]
},
"entitled": {
"type": "boolean"
},
"availability": {
"$ref": "#/components/schemas/ProductCatalogAvailability"
},
"qualification": {
"$ref": "#/components/schemas/ProductCatalogQualification"
},
"metadataSource": {
"type": "string",
"nullable": true
},
"price": {
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency",
"unit",
"source",
"version",
"approvedAt"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^[0-9]{1,18}([.][0-9]{1,12})?$"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"unit": {
"type": "string",
"enum": [
"MILLION_INPUT_TOKENS",
"MILLION_OUTPUT_TOKENS",
"REQUEST"
]
},
"source": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"approvedAt": {
"type": "string",
"format": "date-time"
}
},
"nullable": true
}
}
}ProductCatalogCapabilities
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"tools",
"streaming",
"structuredOutput"
],
"properties": {
"tools": {
"type": "boolean",
"nullable": true
},
"streaming": {
"type": "boolean",
"nullable": true
},
"structuredOutput": {
"type": "boolean",
"nullable": true
}
}
}ProductCatalogLimits
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"contextTokens",
"maxOutputTokens"
],
"properties": {
"contextTokens": {
"type": "integer",
"minimum": 1
},
"maxOutputTokens": {
"type": "integer",
"minimum": 1
}
}
}ProductCatalogAvailability
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"status",
"reason",
"executionMode"
],
"properties": {
"status": {
"type": "string",
"enum": [
"AVAILABLE",
"UNAVAILABLE"
]
},
"reason": {
"type": "string",
"enum": [
"NOT_ENTITLED",
"REVISION_PROOF_CURRENT",
"NO_FRESH_READY_REVISION"
]
},
"executionMode": {
"type": "string",
"enum": [
"SIMULATED",
"REAL",
null
],
"nullable": true
}
}
}ProductCatalogQualification
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"REAL_PROOF_CURRENT",
"FIXTURE_PROOF_CURRENT",
"UNVERIFIED"
]
}
}
}ProductManagementErrorEnvelope
Schema · JSON
{
"oneOf": [
{
"$ref": "#/components/schemas/ProductManagementFilterError"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"code": {
"enum": [
"RATE_LIMITED"
],
"type": "string"
}
}
}
}
}
]
}ProductManagementFilterError
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"additionalProperties": false,
"required": [
"code",
"message",
"type",
"requestId",
"retryable",
"dispatched"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"server_error",
"rate_limit_error",
"invalid_request_error"
]
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"dispatched": {
"enum": [
false
],
"type": "boolean"
},
"details": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}ProductCatalogDetail
Schema · JSON
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"displayName",
"family",
"modalities",
"capabilities",
"limits",
"visibility",
"entitled",
"availability",
"qualification",
"metadataSource",
"price",
"apiExample",
"configurationGuidance"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"displayName": {
"type": "string"
},
"family": {
"type": "string",
"nullable": true
},
"modalities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"text",
"image",
"audio",
"video"
]
},
"nullable": true
},
"capabilities": {
"$ref": "#/components/schemas/ProductCatalogCapabilities"
},
"limits": {
"$ref": "#/components/schemas/ProductCatalogLimits"
},
"visibility": {
"type": "string",
"enum": [
"PUBLISHED"
]
},
"entitled": {
"type": "boolean"
},
"availability": {
"$ref": "#/components/schemas/ProductCatalogAvailability"
},
"qualification": {
"$ref": "#/components/schemas/ProductCatalogQualification"
},
"metadataSource": {
"type": "string",
"nullable": true
},
"price": {
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency",
"unit",
"source",
"version",
"approvedAt"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^[0-9]{1,18}([.][0-9]{1,12})?$"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"unit": {
"type": "string",
"enum": [
"MILLION_INPUT_TOKENS",
"MILLION_OUTPUT_TOKENS",
"REQUEST"
]
},
"source": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"approvedAt": {
"type": "string",
"format": "date-time"
}
},
"nullable": true
},
"apiExample": {
"type": "object",
"additionalProperties": false,
"required": [
"method",
"path",
"body"
],
"properties": {
"method": {
"type": "string",
"enum": [
"POST"
]
},
"path": {
"type": "string",
"enum": [
"/v1/chat/completions"
]
},
"body": {
"type": "object",
"additionalProperties": false,
"required": [
"model",
"messages",
"stream",
"max_tokens"
],
"properties": {
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"role",
"content"
],
"properties": {
"role": {
"type": "string",
"enum": [
"user"
]
},
"content": {
"type": "string"
}
}
},
"minItems": 1,
"maxItems": 1
},
"stream": {
"enum": [
false
],
"type": "boolean"
},
"max_tokens": {
"type": "integer",
"minimum": 1,
"maximum": 128
}
}
}
},
"nullable": true
},
"configurationGuidance": {
"type": "array",
"items": {
"type": "string"
}
}
}
}ManagedQuoteInput
Schema · JSON
{
"type": "object",
"properties": {
"offerId": {
"type": "string"
},
"requestedEndAt": {
"type": "string"
}
},
"required": [
"offerId",
"requestedEndAt"
]
}WaitlistInput
Schema · JSON
{
"type": "object",
"properties": {
"intentId": {
"type": "string"
},
"email": {
"type": "boolean"
}
},
"required": [
"intentId",
"email"
]
}ReservationInput
Schema · JSON
{
"type": "object",
"properties": {
"acceptedQuoteId": {
"type": "string",
"description": "Exact immutable liability quote accepted for a budget-controlled allocation."
},
"acceptedPolicyId": {
"type": "string",
"description": "Exact approved compute policy accepted by customer; required for policy-backed supply."
},
"offerId": {
"type": "string"
},
"units": {
"type": "number",
"example": 1,
"description": "Whole allocation units, not fractional GPUs."
},
"requestedEndAt": {
"type": "string",
"example": "2026-11-01T12:00:00Z",
"description": "UTC end time, within 31 days. Expiry triggers operator review, not automatic destruction."
}
},
"required": [
"offerId",
"units",
"requestedEndAt"
]
}InstanceInput
Schema · JSON
{
"type": "object",
"properties": {
"reservationId": {
"type": "string"
}
},
"required": [
"reservationId"
]
}Object
Schema · JSON
{
"type": "object",
"properties": {}
}