Documentation / API reference

API reference

Every gateway endpoint, parameter, schema, and response from the OpenAPI contract.

This reference is generated from the local OpenAPI contract. Expand fields and response codes to inspect their schemas. Generated schema illustrations contain placeholder values; replace them with your own inputs.

Download the OpenAPI document to use the same contract in your tools.

POST `/v1/decide`

Choose one offered option

Complete formatted model input is limited to 2048 tokens; inference checks its exact tokenizer before encoding and never truncates (413). Body limit is 4 MB compressed and decompressed (413). JSON nesting is limited to 64 (400). Supports gzip, x-gzip and zstd, one layer only. Choice takes 2 to 255 options and score 2 to 10 levels (422 outside). Probabilities cover offered options only. probability is the chosen option's probability. The routing gate acts when probability >= threshold (default 0.9), otherwise asks a human. This configurable routing rule is not a certified precision guarantee. One question per request: send situation (text) or state (JSON), a question, a type and its options or levels. Unknown fields are rejected at every level. Requests that can never succeed are rejected before rate limiting and never get 429. Every response carries X-Request-Id; error bodies are {code, message} and never repeat request content.

Authentication: [{"ApiKey":[]}]

Request body (required)

application/json

DecideRequestschema

oneOf · ChoiceRequest

ChoiceRequestobjectadditionalProperties: false

model required

stringpattern: "^ren-(?:\\d+\\.\\d+\\.\\d+|latest|preview)$"

situation optional

Plain-text situation. Send exactly one of situation or state.

stringminLength: 1

state optional

Structured situation as any non-null JSON value; a string must be nonblank. Send exactly one of situation or state.

schema

question required

The single question the model answers about the situation.

stringminLength: 1

type required

stringconst: "choice"

options required

arrayminItems: 2maxItems: 255

Array items

OptionobjectadditionalProperties: false

id required

stringminLength: 1maxLength: 128

description optional

string

threshold optional

Routing threshold; defaults to 0.9 unless configured by the operator.

numberminimum: 0maximum: 1

oneOf · variant 1

schema

oneOf · variant 2

schema

oneOf · ScoreRequest

ScoreRequest

Levels have unique numeric string IDs from 1 through 10, ordered strictly increasingly. At least two levels are required by the engine.

objectadditionalProperties: false

model required

stringpattern: "^ren-(?:\\d+\\.\\d+\\.\\d+|latest|preview)$"

situation optional

Plain-text situation. Send exactly one of situation or state.

stringminLength: 1

state optional

Structured situation as any non-null JSON value; a string must be nonblank. Send exactly one of situation or state.

schema

question required

The single question the model answers about the situation.

stringminLength: 1

type required

stringconst: "score"

levels required

arrayminItems: 2maxItems: 10

Array items

OptionobjectadditionalProperties: false

id required

stringminLength: 1maxLength: 128

description optional

string

threshold optional

Routing threshold; defaults to 0.9 unless configured by the operator.

numberminimum: 0maximum: 1

oneOf · variant 1

schema

oneOf · variant 2

schema

oneOf · NoulRequest

NoulRequestobjectadditionalProperties: false

model required

stringpattern: "^ren-(?:\\d+\\.\\d+\\.\\d+|latest|preview)$"

situation optional

Plain-text situation. Send exactly one of situation or state.

stringminLength: 1

state optional

Structured situation as any non-null JSON value; a string must be nonblank. Send exactly one of situation or state.

schema

question required

The single question the model answers about the situation.

stringminLength: 1

type required

stringconst: "noul"

threshold optional

Routing threshold; defaults to 0.9 unless configured by the operator.

numberminimum: 0maximum: 1

oneOf · variant 1

schema

oneOf · variant 2

schema

Schema illustration (replace placeholder values)

json

"string"

Responses and error codes

200 Decision with typed fields, routing gate and exact input-token usage

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

X-RateLimit-Limit

Requests allowed in the current one-minute window by the tightest limit (key or account).

integerminimum: 1

X-RateLimit-Remaining

Requests left in the current window by the tightest limit.

integerminimum: 0

X-RateLimit-Reset

Seconds until the current window resets.

integerminimum: 0

application/json

DecideResponseobjectadditionalProperties: false

id required

string

model required

stringpattern: "^ren-\\d+\\.\\d+\\.\\d+$"

choice required

string

probabilities required

object

Additional values

numberminimum: 0maximum: 1

action required

stringenum: ["act","ask_human"]

gate required

objectadditionalProperties: false

threshold required

numberminimum: 0maximum: 1

type required

stringenum: ["choice","score","noul"]

threshold required

numberminimum: 0maximum: 1

expected_score optional

numberminimum: 1maximum: 10

probability required

Calibrated probability of the chosen option. The gate acts when probability >= threshold. For noul, the probability of true is probabilities.true.

numberminimum: 0maximum: 1

usage required

UsageobjectadditionalProperties: false

input_tokens required

integerminimum: 1maximum: 2048

output_tokens required

integerconst: 0

model required

stringpattern: "^ren-\\d+\\.\\d+\\.\\d+$"

Schema illustration (replace placeholder values)

json

{
  "id": "string",
  "model": "string",
  "choice": "string",
  "probabilities": {},
  "action": "act",
  "gate": {
    "threshold": 0
  },
  "type": "choice",
  "threshold": 0,
  "probability": 0,
  "usage": {
    "input_tokens": 1,
    "output_tokens": 0,
    "model": "string"
  }
}

400 Malformed JSON or compression, or JSON nested deeper than 64 levels; unknown model IDs return unknown_model and name ren-1.1.0, ren-latest, ren-preview

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

401 Invalid authentication

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

402 Insufficient organization credits when BILLING_ENFORCED is enabled. Charging is off by default.

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

413 Body over 4 MB or input over 2048 tokens; never truncated

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

415 Unsupported content type or content encoding

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

422 Request does not match the schema: unknown field, option or level count, or blank text

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

429 Rate limited; wait Retry-After seconds (retry-after-ms milliseconds). Only for requests that can succeed later

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

X-RateLimit-Limit

Requests allowed in the current one-minute window by the tightest limit (key or account).

integerminimum: 1

X-RateLimit-Remaining

Requests left in the current window by the tightest limit.

integerminimum: 0

X-RateLimit-Reset

Seconds until the current window resets.

integerminimum: 0

Retry-After

Whole seconds to wait before retrying.

integerminimum: 1

retry-after-ms

Milliseconds to wait before retrying.

integerminimum: 0

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

502 Invalid inference response

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

503 Service unavailable

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

504 Inference timeout

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

529 Inference is overloaded; retry with backoff

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

GET `/v1/models`

models

Authentication: [{"ApiKey":[]}]

Responses and error codes

200 Pinned model, aliases and configured limits

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

object

data required

array

Array items

object

id required

stringpattern: "^ren-(?:\\d+\\.\\d+\\.\\d+|latest|preview)$"

aliases required

array

Array items

string

max_options required

integerconst: 255

max_input_tokens required

integerconst: 2048

price_per_million_input_tokens_usd required

numberminimum: 0

release_date required

Release date of the resolved model (YYYY-MM-DD).

stringformat: "date"pattern: "^\\d{4}-\\d{2}-\\d{2}$"

Schema illustration (replace placeholder values)

json

{
  "data": [
    {
      "id": "string",
      "aliases": [
        "string"
      ],
      "max_options": 255,
      "max_input_tokens": 2048,
      "price_per_million_input_tokens_usd": 0,
      "release_date": "2026-11-13"
    }
  ]
}

401 Invalid authentication

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

GET `/admin/keys`

listKeys

Authentication: [{"Session":[]}]

Responses and error codes

200 Keys without plaintext

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

object

keys required

array

Array items

ApiKeyobjectadditionalProperties: false

id required

string

name required

stringminLength: 1maxLength: 80

prefix required

string

created_at required

string

revoked_at required

string | null

creator_id optional

Original key creator. Organization access survives removal of this member.

string | null

creator_name optional

Creator display name when available.

string | null

Schema illustration (replace placeholder values)

json

{
  "keys": [
    {
      "id": "string",
      "name": "string",
      "prefix": "string",
      "created_at": "string",
      "revoked_at": "string"
    }
  ]
}

400 Malformed JSON or compression, or JSON nested deeper than 64 levels

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

401 Invalid authentication

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

403 Signed in without private beta access

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

413 Body over 4 MB or input over 2048 tokens; never truncated

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

422 Request does not match the schema: unknown field, option or level count, or blank text

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

429 Rate limited; wait Retry-After seconds (retry-after-ms milliseconds). Only for requests that can succeed later

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

Retry-After

Whole seconds to wait before retrying.

integerminimum: 1

retry-after-ms

Milliseconds to wait before retrying.

integerminimum: 0

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

502 Invalid inference response

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

503 Service unavailable

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

504 Inference timeout

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

POST `/admin/keys`

createKey

Authentication: [{"Session":[]}]

Request body (required)

application/json

CreateKeyRequestobjectadditionalProperties: false

name required

stringminLength: 1maxLength: 80

Schema illustration (replace placeholder values)

json

{
  "name": "string"
}

Responses and error codes

201 Plaintext key returned once

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

CreatedKeyobjectadditionalProperties: false

id required

string

name required

stringminLength: 1maxLength: 80

prefix required

string

created_at required

string

revoked_at required

string | null

key required

string

creator_id optional

Original key creator. Organization access survives removal of this member.

string | null

creator_name optional

Creator display name when available.

string | null

Schema illustration (replace placeholder values)

json

{
  "id": "string",
  "name": "string",
  "prefix": "string",
  "created_at": "string",
  "revoked_at": "string",
  "key": "string"
}

400 Malformed JSON or compression, or JSON nested deeper than 64 levels

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

401 Invalid authentication

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

403 Signed in without private beta access

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

413 Body over 4 MB or input over 2048 tokens; never truncated

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

422 Request does not match the schema: unknown field, option or level count, or blank text

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

429 Rate limited; wait Retry-After seconds (retry-after-ms milliseconds). Only for requests that can succeed later

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

Retry-After

Whole seconds to wait before retrying.

integerminimum: 1

retry-after-ms

Milliseconds to wait before retrying.

integerminimum: 0

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

502 Invalid inference response

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

503 Service unavailable

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

504 Inference timeout

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

DELETE `/admin/keys/{id}`

revokeKey

Authentication: [{"Session":[]}]

path: `id` (required)

string

Responses and error codes

204 Revoked

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

400 Malformed JSON or compression, or JSON nested deeper than 64 levels

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

401 Invalid authentication

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

403 Signed in without private beta access

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

404 Unknown key

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

413 Body over 4 MB or input over 2048 tokens; never truncated

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

422 Request does not match the schema: unknown field, option or level count, or blank text

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

429 Rate limited; wait Retry-After seconds (retry-after-ms milliseconds). Only for requests that can succeed later

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

Retry-After

Whole seconds to wait before retrying.

integerminimum: 1

retry-after-ms

Milliseconds to wait before retrying.

integerminimum: 0

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

502 Invalid inference response

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

503 Service unavailable

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

504 Inference timeout

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

GET `/admin/usage`

usage

Authentication: [{"Session":[]}]

query: `limit` (optional)

integerdefault: 50minimum: 1maximum: 100

Responses and error codes

200 Recent account-scoped request metadata

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

AccountUsageobject

usage required

array

Array items

UsageRowobjectadditionalProperties: false

id required

string

key_id required

string

model required

string

status required

integer

input_tokens required

integerminimum: 0

latency_ms required

integerminimum: 0

created_at required

string

output_tokens required

integerconst: 0

estimated_cost_usd required

numberminimum: 0

summary required

UsageSummaryobject

requests required

integerminimum: 0

input_tokens required

integerminimum: 0

estimated_cost_usd required

numberminimum: 0

by_key required

array

Array items

object

requests required

integerminimum: 0

input_tokens required

integerminimum: 0

estimated_cost_usd required

numberminimum: 0

key_id required

string

by_model required

array

Array items

object

requests required

integerminimum: 0

input_tokens required

integerminimum: 0

estimated_cost_usd required

numberminimum: 0

model required

string

daily required

array

Array items

object

requests required

integerminimum: 0

input_tokens required

integerminimum: 0

estimated_cost_usd required

numberminimum: 0

day required

string

limits required

object

per_key_requests_per_minute required

integer

per_account_requests_per_minute required

integer

price_per_million_input_tokens_usd required

numberminimum: 0

Schema illustration (replace placeholder values)

json

{
  "usage": [
    {
      "id": "string",
      "key_id": "string",
      "model": "string",
      "status": 0,
      "input_tokens": 0,
      "latency_ms": 0,
      "created_at": "string",
      "output_tokens": 0,
      "estimated_cost_usd": 0
    }
  ],
  "summary": {
    "requests": 0,
    "input_tokens": 0,
    "estimated_cost_usd": 0
  },
  "by_key": [
    {
      "requests": 0,
      "input_tokens": 0,
      "estimated_cost_usd": 0,
      "key_id": "string"
    }
  ],
  "by_model": [
    {
      "requests": 0,
      "input_tokens": 0,
      "estimated_cost_usd": 0,
      "model": "string"
    }
  ],
  "daily": [
    {
      "requests": 0,
      "input_tokens": 0,
      "estimated_cost_usd": 0,
      "day": "string"
    }
  ],
  "limits": {
    "per_key_requests_per_minute": 0,
    "per_account_requests_per_minute": 0
  },
  "price_per_million_input_tokens_usd": 0
}

400 Malformed JSON or compression, or JSON nested deeper than 64 levels

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

401 Invalid authentication

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

403 Signed in without private beta access

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

413 Body over 4 MB or input over 2048 tokens; never truncated

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

422 Request does not match the schema: unknown field, option or level count, or blank text

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

429 Rate limited; wait Retry-After seconds (retry-after-ms milliseconds). Only for requests that can succeed later

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

Retry-After

Whole seconds to wait before retrying.

integerminimum: 1

retry-after-ms

Milliseconds to wait before retrying.

integerminimum: 0

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

502 Invalid inference response

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

503 Service unavailable

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

504 Inference timeout

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

ErrorobjectadditionalProperties: false

code required

string

message required

string

Schema illustration (replace placeholder values)

json

{
  "code": "string",
  "message": "string"
}

GET `/openapi.json`

openapi

Authentication: []

Responses and error codes

200 OpenAPI 3.1 contract

X-Request-Id

Unique request ID; quote it when contacting support.

stringpattern: "^req_[0-9a-f]{32}$"

application/json

object

Schema illustration (replace placeholder values)

json

{}

Read Markdown ↗

API reference

POST /v1/decide

Choose one offered option

Request body (required)

application/json

Responses and error codes

X-Request-Id

X-RateLimit-Limit

X-RateLimit-Remaining

X-RateLimit-Reset

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

X-RateLimit-Limit

X-RateLimit-Remaining

X-RateLimit-Reset

Retry-After

retry-after-ms

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

application/json

GET /v1/models

models

Responses and error codes

X-Request-Id

application/json

X-Request-Id

application/json

GET /admin/keys

listKeys

Responses and error codes

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

Retry-After

retry-after-ms

application/json

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

application/json

POST /admin/keys

createKey

Request body (required)

application/json

Responses and error codes

X-Request-Id

application/json

X-Request-Id

application/json

X-Request-Id

POST `/v1/decide`

GET `/v1/models`

GET `/admin/keys`

POST `/admin/keys`

DELETE `/admin/keys/{id}`

path: `id` (required)

GET `/admin/usage`

query: `limit` (optional)