API Reference

Response Body

`application/json`

curl -X GET "https://example.com/v1/auth/me"

{
  "username": "string",
  "role": "string"
}

Response Body

`application/json`

curl -X GET "https://example.com/v1/responses/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "string",
  "object": "response",
  "created_at": 0,
  "model": "string",
  "status": "in_progress",
  "incomplete_details": {
    "reason": "max_output_tokens"
  },
  "output": [
    {
      "type": "message",
      "id": "string",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "string",
          "annotations": [
            null
          ]
        }
      ]
    }
  ],
  "error": {
    "code": "string",
    "message": "string"
  },
  "usage": {
    "input_tokens": 0,
    "output_tokens": 0,
    "total_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens_details": {
      "reasoning_tokens": 0
    }
  },
  "service_tier": "default"
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/responses/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "string",
  "object": "response",
  "created_at": 0,
  "model": "string",
  "status": "in_progress",
  "incomplete_details": {
    "reason": "max_output_tokens"
  },
  "output": [
    {
      "type": "message",
      "id": "string",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "string",
          "annotations": [
            null
          ]
        }
      ]
    }
  ],
  "error": {
    "code": "string",
    "message": "string"
  },
  "usage": {
    "input_tokens": 0,
    "output_tokens": 0,
    "total_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens_details": {
      "reasoning_tokens": 0
    }
  },
  "service_tier": "default"
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

limit?integer

Default100

stream_id?string|null

Response Body

`application/json`

curl -X GET "https://example.com/v1/responses"

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "response",
      "created_at": 0,
      "model": "string",
      "status": "in_progress"
    }
  ],
  "has_more": false
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model*string

Model identifier, e.g. "zai-org/GLM-5"

input*|array<>

Input for the completion. Either a plain string (shorthand for a single user message) or an array of OpenAI Responses input items.

instructions?|

Developer instructions (system prompt).

tools?array<>|null

tool_choice?|string|null

max_output_tokens?integer|null

temperature?|

Rangevalue <= 2

top_p?|

Rangevalue <= 1

include_reasoning?boolean

Defaulttrue

enable_thinking?boolean|null

reasoning?|null

include?array<string>|

Ignored. Every value OpenAI defines here (web search, code interpreter, computer use, file search, logprobs, encrypted reasoning) depends on a feature this API does not implement, so the requested extra data is never present in the response regardless. Silently ignored rather than rejected: upstream routers such as requesty.ai count a 400 as a failed request against our reliability, while an ignored include degrades gracefully — the caller simply gets none of the extra data they would not have received anyway.

background?boolean

Defaultfalse

stream?boolean

Defaultfalse

text?|null

prompt_cache_key?|

Stable identifier for a sequence of requests that share a long prefix (a chat session, an agent loop). Requests with the same key are routed to the same worker while it stays warm, so the shared prefix is served from its prompt cache. Without it, placement is inferred from the input text.

service_tier?|

Processing tier for the request. "flex" selects flex processing (beta) on flex-enabled accounts: discounted tokens in exchange for lower scheduling priority and best-effort completion — the request may queue significantly longer than default-tier requests, so raise your client timeout accordingly, or use background: true and poll. All other accepted values (auto, default, scale, priority) are served at the default tier. Responses echo the tier actually served in service_tier.

metadata?

Extra metadata including "completion_window" ("24h" is the only supported value; requires background=true) and optional "stream_id" for grouping.

Response Body

`application/json`

curl -X POST "https://example.com/v1/responses" \  -H "Content-Type: application/json" \  -d '{    "model": "string",    "input": "string"  }'

{
  "id": "string",
  "object": "response",
  "created_at": 0,
  "model": "string",
  "status": "in_progress",
  "incomplete_details": {
    "reason": "max_output_tokens"
  },
  "output": [
    {
      "type": "message",
      "id": "string",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "string",
          "annotations": [
            null
          ]
        }
      ]
    }
  ],
  "error": {
    "code": "string",
    "message": "string"
  },
  "usage": {
    "input_tokens": 0,
    "output_tokens": 0,
    "total_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens_details": {
      "reasoning_tokens": 0
    }
  },
  "service_tier": "default"
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

stream_id?string|null

limit?integer

Default20

starting_after?string|null

ending_before?string|null

wait_ms?integer

Default0

Response Body

`application/json`

curl -X GET "https://example.com/v1/responses/events"

{
  "object": "list",
  "data": [
    {
      "completion_id": "string",
      "response_id": "string",
      "custom_id": "string",
      "status": "string",
      "result": {
        "property1": null,
        "property2": null
      },
      "error": {
        "property1": null,
        "property2": null
      },
      "prompt_tokens": 0,
      "completion_tokens": 0,
      "total_tokens": 0,
      "cost_micros": 0,
      "completed_at": "string"
    }
  ],
  "has_more": true
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model*string

messages*array<>

temperature?number|null

top_p?number|null

presence_penalty?|

Range-2 <= value <= 2

frequency_penalty?|

Range-2 <= value <= 2

max_tokens?integer|null

max_completion_tokens?integer|null

top_k?|

Range-1 <= value

min_p?|

Rangevalue <= 1

repetition_penalty?|

Rangevalue <= 2

stop?string|array<string>|null

seed?integer|null

stream?boolean

Defaultfalse

stream_options?|null

tools?array<>|null

tool_choice?|string|null

response_format?|null

reasoning_effort?string|null

enable_thinking?boolean|null

prompt_cache_key?|

service_tier?|

Processing tier for the request. "flex" selects flex processing (beta) on flex-enabled accounts: discounted tokens in exchange for lower scheduling priority and best-effort completion — the request may queue significantly longer than default-tier requests, so raise your client timeout accordingly. A flex request that cannot complete in time fails with 408 (OpenAI SDKs retry it automatically). All other accepted values (auto, default, scale, priority) are served at the default tier. Responses echo the tier actually served in service_tier.

Response Body

`application/json`

curl -X POST "https://example.com/v1/chat/completions" \  -H "Content-Type: application/json" \  -d '{    "model": "string",    "messages": [      {        "role": "string"      }    ]  }'

{
  "property1": null,
  "property2": null
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model*string

input*string|array<string>|array<integer>|array<array<integer>>

encoding_format?string

Default"float"

Value in"float" | "base64"

dimensions?integer|null

user?string|null

Response Body

`application/json`

curl -X POST "https://example.com/v1/embeddings" \  -H "Content-Type: application/json" \  -d '{    "model": "string",    "input": "string"  }'

{
  "property1": null,
  "property2": null
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

beta?boolean|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model*string

max_tokens*integer

messages*array<>

system?string|array<>|array<>|null

stop_sequences?array<string>|null

stream?boolean

Defaultfalse

temperature?number|null

top_p?number|null

top_k?integer|null

tools?array<>|null

tool_choice?|string|null

thinking?|null

enable_thinking?boolean|null

Response Body

`application/json`

curl -X POST "https://example.com/v1/messages" \  -H "Content-Type: application/json" \  -d '{    "model": "string",    "max_tokens": 0,    "messages": [      {        "role": "user",        "content": "string"      }    ]  }'

{
  "property1": null,
  "property2": null
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Response Body

`application/json`

curl -X GET "https://example.com/v1/models"

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "model",
      "created": 0,
      "owned_by": "sference",
      "display_name": "string",
      "modality": "text_generation",
      "capabilities": {
        "image_input": {
          "supported": false
        },
        "pdf_input": {
          "supported": false
        },
        "thinking": {
          "supported": false,
          "types": {
            "enabled": {
              "supported": false
            },
            "adaptive": {
              "supported": false
            }
          }
        },
        "tools": {
          "supported": false
        },
        "dimensions": 0
      },
      "context_tokens": 0,
      "provider": "string",
      "pricing": {
        "input_per_million_usd": 0,
        "output_per_million_usd": 0,
        "cached_input_per_million_usd": 0
      },
      "released": "string"
    }
  ]
}

Path Parameters

batch_id*string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/batches/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"

{
  "id": "string",
  "status": "pending",
  "window": "24h",
  "request_count": 0,
  "created_at": "string",
  "updated_at": "string",
  "completed_at": "string",
  "total_prompt_tokens": 0,
  "total_completion_tokens": 0,
  "total_tokens": 0,
  "total_cost_micros": 0
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Response Body

`application/json`

curl -X GET "https://example.com/v1/batches"

{
  "items": [
    {
      "id": "string",
      "status": "pending",
      "window": "24h",
      "request_count": 0,
      "created_at": "string",
      "updated_at": "string",
      "completed_at": "string",
      "total_prompt_tokens": 0,
      "total_completion_tokens": 0,
      "total_tokens": 0,
      "total_cost_micros": 0
    }
  ]
}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

window?string

Completion window for every row in the batch ("24h" is the only supported value).

Default"24h"

requests*array<>

One or more inference rows sharing the same body.model. Each body is normalized to chat-completions shape at create (Responses input → messages), validated, then enqueued. Invalid rows return HTTP 400 with requests[i] and optional custom_id.

Items1 <= items

Response Body

`application/json`

curl -X POST "https://example.com/v1/batches" \  -H "Content-Type: application/json" \  -d '{    "requests": [      {        "body": {          "property1": null,          "property2": null        }      }    ]  }'

{
  "id": "string",
  "status": "pending",
  "window": "24h",
  "request_count": 0,
  "created_at": "string",
  "updated_at": "string",
  "completed_at": "string",
  "total_prompt_tokens": 0,
  "total_completion_tokens": 0,
  "total_tokens": 0,
  "total_cost_micros": 0
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Path Parameters

batch_id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/batches/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "string",
  "status": "pending",
  "window": "24h",
  "request_count": 0,
  "created_at": "string",
  "updated_at": "string",
  "completed_at": "string",
  "total_prompt_tokens": 0,
  "total_completion_tokens": 0,
  "total_tokens": 0,
  "total_cost_micros": 0
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Path Parameters

batch_id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/batches/497f6eca-6276-4993-bfeb-53cbbbba6f08/results"

{
  "batch_id": "string",
  "status": "pending",
  "output_url": "string",
  "completed_at": "string",
  "results": [
    {
      "property1": null,
      "property2": null
    }
  ]
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Path Parameters

batch_id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/batches/497f6eca-6276-4993-bfeb-53cbbbba6f08/results.jsonl"

"string"

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model_id*string

Length1 <= length <= 512

display_name?|

Lengthlength <= 512

modality?string

Default"text_generation"

Value in"text_generation" | "text_embedding"

architecture*string

architecture_detail?|

Lengthlength <= 1024

artifact_type?string

Default"full"

Value in"full" | "lora"

base_model_id?|

Lengthlength <= 512

hf_repo?|

Lengthlength <= 512

hf_revision?|

Lengthlength <= 256

private_repo?boolean

Defaultfalse

hf_token?|

Lengthlength <= 2048

notes?|

Lengthlength <= 4000

Response Body

`application/json`

curl -X POST "https://example.com/control/v1/models/custom" \  -H "Content-Type: application/json" \  -d '{    "model_id": "string",    "architecture": "qwen"  }'

{
  "id": "string",
  "display_name": "string",
  "provider": "string",
  "platform_status": "available",
  "modality": "string",
  "context_tokens": 0,
  "released": "string",
  "deprecated": "string",
  "input_per_million_usd": 0,
  "output_per_million_usd": 0,
  "cached_input_per_million_usd": 0,
  "tpm_limit": "unlimited",
  "rpm_limit": "unlimited",
  "requests_per_hour": "—",
  "deployed_on_platform": true,
  "capabilities": {
    "image_input": {
      "supported": false
    },
    "pdf_input": {
      "supported": false
    },
    "thinking": {
      "supported": false,
      "types": {
        "enabled": {
          "supported": false
        },
        "adaptive": {
          "supported": false
        }
      }
    },
    "tools": {
      "supported": false
    },
    "dimensions": 0
  },
  "ownership": "platform",
  "deploy_status": "pending_deploy",
  "architecture": "string",
  "has_hf_token": true,
  "status_reason": "string"
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

model_id*string

Custom model id (e.g. org/name)

Response Body

`application/json`

curl -X DELETE "https://example.com/control/v1/models/custom?model_id=string"

Empty

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Response Body

`application/json`

curl -X GET "https://example.com/control/v1/models/catalog"

{
  "models": [
    {
      "id": "string",
      "display_name": "string",
      "provider": "string",
      "platform_status": "available",
      "modality": "string",
      "context_tokens": 0,
      "released": "string",
      "deprecated": "string",
      "input_per_million_usd": 0,
      "output_per_million_usd": 0,
      "cached_input_per_million_usd": 0,
      "tpm_limit": "unlimited",
      "rpm_limit": "unlimited",
      "requests_per_hour": "—",
      "deployed_on_platform": true,
      "capabilities": {
        "image_input": {
          "supported": false
        },
        "pdf_input": {
          "supported": false
        },
        "thinking": {
          "supported": false,
          "types": {
            "enabled": {
              "supported": false
            },
            "adaptive": {
              "supported": false
            }
          }
        },
        "tools": {
          "supported": false
        },
        "dimensions": 0
      },
      "ownership": "platform",
      "deploy_status": "pending_deploy",
      "architecture": "string",
      "has_hf_token": true,
      "status_reason": "string"
    }
  ]
}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model_id*string

Length1 <= length <= 512

display_name?|

Lengthlength <= 512

Response Body

`application/json`

curl -X POST "https://example.com/control/v1/models/request-deployment" \  -H "Content-Type: application/json" \  -d '{    "model_id": "string"  }'

{
  "ok": true
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

q?|

Filter by model id, display name, or provider

modality?string

Default"text_generation"

status?string

One of: "available", "coming_soon", "deprecated", "all"

Default"all"

Response Body

`application/json`

curl -X GET "https://example.com/control/v1/models/search"

{
  "items": [
    {
      "id": "string",
      "display_name": "string",
      "provider": "string",
      "modality": "text_generation",
      "context_tokens": 0,
      "released": "string",
      "input_per_million_usd": 0,
      "output_per_million_usd": 0,
      "cached_input_per_million_usd": 0,
      "tpm_limit": "unlimited",
      "rpm_limit": "unlimited",
      "requests_per_hour": "—",
      "catalog_status": "available",
      "deployed_on_platform": true,
      "source": "catalog"
    }
  ]
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Response Body

`application/json`

curl -X GET "https://example.com/control/v1/deployments"

{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "model_source": "platform",
      "model_id": "string",
      "region": "string",
      "performance": "cost_saving",
      "min_replicas": 0,
      "max_replicas": 0,
      "notes": "string",
      "status": "pending_deploy",
      "status_reason": "string",
      "activated_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 256

model_source*string

Value in"platform" | "custom"

model_id*string

Length1 <= length <= 512

region?string

Default"emea"

Value in"emea" | "global"

performance?string

Default"standard"

Value in"cost_saving" | "standard" | "turbo"

min_replicas?integer

Default0

Range0 <= value <= 1000

max_replicas?integer

Default1

Range0 <= value <= 1000

notes?|

Lengthlength <= 4000

Response Body

`application/json`

curl -X POST "https://example.com/control/v1/deployments" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "model_source": "platform",    "model_id": "string"  }'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "model_source": "platform",
  "model_id": "string",
  "region": "string",
  "performance": "cost_saving",
  "min_replicas": 0,
  "max_replicas": 0,
  "notes": "string",
  "status": "pending_deploy",
  "status_reason": "string",
  "activated_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Path Parameters

deployment_id*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/control/v1/deployments/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Length3 <= length <= 320

Response Body

`application/json`

curl -X POST "https://example.com/control/v1/teams/me/members" \  -H "Content-Type: application/json" \  -d '{    "email": "string"  }'

{
  "user_id": "string",
  "email": "string",
  "role": "string",
  "is_active": true,
  "created_at": "2019-08-24T14:15:22Z"
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Response Body

`application/json`

curl -X GET "https://example.com/control/v1/teams/me"

{
  "id": "string",
  "name": "string",
  "email_domain": "string",
  "role": "string",
  "zero_data_retention_enabled": false,
  "members": [
    {
      "user_id": "string",
      "email": "string",
      "role": "string",
      "is_active": true,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

zero_data_retention_enabled?boolean|null

Response Body

`application/json`

curl -X PATCH "https://example.com/control/v1/teams/me" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "name": "string",
  "email_domain": "string",
  "role": "string",
  "zero_data_retention_enabled": false,
  "members": [
    {
      "user_id": "string",
      "email": "string",
      "role": "string",
      "is_active": true,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Path Parameters

user_id*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*string

New team role for the member

Value in"admin" | "member"

Response Body

`application/json`

curl -X PATCH "https://example.com/control/v1/teams/me/members/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "role": "admin"  }'

{
  "user_id": "string",
  "email": "string",
  "role": "string",
  "is_active": true,
  "created_at": "2019-08-24T14:15:22Z"
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Path Parameters

user_id*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/control/v1/teams/me/members/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Path Parameters

request_id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/control/v1/activity/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "string",
  "status": "pending",
  "model": "string",
  "custom_id": "string",
  "type": "standalone",
  "batch_id": "string",
  "stream_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "prompt_tokens": 0,
  "completion_tokens": 0,
  "total_tokens": 0,
  "cached_prompt_tokens": 0,
  "cost_micros": 0,
  "body_json": {},
  "result_json": {},
  "error_json": {}
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

page?integer

Default1

Range1 <= value

page_size?integer

Default25

Range1 <= value <= 100

type?string|null

status?string|null

model?string|null

created_after?string|null

created_before?string|null

api_key_id?|

Filter activity to one API key

user_id?|

Team admins: filter activity to one member

Response Body

`application/json`

curl -X GET "https://example.com/control/v1/activity"

{
  "items": [
    {
      "id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "completed_at": "2019-08-24T14:15:22Z",
      "status": "pending",
      "model": "string",
      "custom_id": "string",
      "type": "standalone",
      "batch_id": "string",
      "stream_id": "string",
      "prompt_tokens": 0,
      "completion_tokens": 0,
      "total_tokens": 0,
      "cached_prompt_tokens": 0,
      "cost_micros": 0,
      "error": {},
      "api_key_id": "string",
      "api_key_name": "string",
      "api_key_prefix": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

user_id?|

Team admins: filter models to one member

Response Body

`application/json`

curl -X GET "https://example.com/control/v1/activity/models"

[
  "string"
]

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

period_start?|null

period_end?|null

Response Body

`application/json`

curl -X POST "https://example.com/control/v1/billing/invoices" \  -H "Content-Type: application/json" \  -d '{}'

{
  "stripe_invoice_id": "string",
  "hosted_invoice_url": "string",
  "amount_cents": 0,
  "currency": "string",
  "period_start": "2019-08-24T14:15:22Z",
  "period_end": "2019-08-24T14:15:22Z",
  "status": "string"
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

nonce*string

Client-generated nonce to stabilize idempotency.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount_usd*string

Response Body

`application/json`

curl -X POST "https://example.com/control/v1/billing/topups?nonce=string" \  -H "Content-Type: application/json" \  -d '{    "amount_usd": "string"  }'

{
  "stripe_session_id": "string",
  "checkout_url": "string"
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

days?integer

Default30

Range1 <= value <= 365

Response Body

`application/json`

curl -X GET "https://example.com/control/v1/billing/summary"

{
  "summary": {
    "days": 0,
    "total_prompt_tokens": 0,
    "total_completion_tokens": 0,
    "total_tokens": 0,
    "total_cached_prompt_tokens": 0,
    "total_requests": 0,
    "estimated_cost_micros": 0,
    "credit_balance_micros": 0
  },
  "by_model": [
    {
      "model": "string",
      "service_tier": "default",
      "prompt_tokens": 0,
      "completion_tokens": 0,
      "total_tokens": 0,
      "cached_prompt_tokens": 0,
      "total_requests": 0,
      "cost_micros": 0,
      "pricing": {
        "model": "string",
        "prompt_token_price_micros": 0,
        "completion_token_price_micros": 0,
        "effective_from": "2019-08-24T14:15:22Z"
      }
    }
  ]
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

limit?integer

Default25

Range1 <= value <= 100

starting_after?string|null

Response Body

`application/json`

curl -X GET "https://example.com/control/v1/billing/transactions"

{
  "items": [
    {
      "id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "type": "string",
      "amount_micros": 0,
      "balance_after_micros": 0,
      "description": "string",
      "external_provider": "string",
      "external_payment_id": "string"
    }
  ],
  "next_starting_after": "string"
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

days?integer

Number of days to look back

Default30

Range1 <= value <= 365

user_id?|

Team admins: filter usage to one member

Response Body

`application/json`

curl -X GET "https://example.com/control/v1/usage/daily"

{
  "items": [
    {
      "date": "string",
      "model": "string",
      "prompt_tokens": 0,
      "completion_tokens": 0,
      "total_tokens": 0,
      "cached_prompt_tokens": 0,
      "request_count": 0,
      "cost_micros": 0
    }
  ]
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

Query Parameters

days?integer

Number of days to look back

Default30

Range1 <= value <= 365

user_id?|

Team admins: filter usage to one member

Response Body

`application/json`

curl -X GET "https://example.com/control/v1/usage/summary"

{
  "summary": {
    "total_prompt_tokens": 0,
    "total_completion_tokens": 0,
    "total_tokens": 0,
    "total_cached_prompt_tokens": 0,
    "total_requests": 0,
    "total_cost_micros": 0
  },
  "by_model": [
    {
      "model": "string",
      "service_tier": "default",
      "total_prompt_tokens": 0,
      "total_completion_tokens": 0,
      "total_tokens": 0,
      "total_cached_prompt_tokens": 0,
      "total_requests": 0,
      "total_cost_micros": 0
    }
  ]
}

{
  "status_code": 400,
  "detail": "Bad Request",
  "extra": {}
}

CLI

Install the sference CLI and authenticate with an API key.

Inference API

All Inference API operations.

200application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

200application/json

400application/json

200application/json

201application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

201application/json

400application/json

204

400application/json

200application/json

200application/json

400application/json

200application/json

400application/json

200application/json

201application/json

400application/json

204

400application/json

201application/json

400application/json

200application/json

200application/json

400application/json

200application/json

400application/json

204

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

201application/json

400application/json

201application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`