APIリファレンス

Every endpoint a customer API key can call, with request and response examples.

Inference API (/v1)

Models

List the models your key can call, with prices and data posture.

GET/v1/modelsList models
GET/v1/models/{model}Retrieve a model

Chat Completions

The OpenAI Chat Completions API, streamed or buffered.

POST/v1/chat/completionsCreate a chat completion

Responses

The OpenAI Responses API, with server-side conversation state.

POST/v1/responsesCreate a response

Messages

The Anthropic Messages API, for Claude Code and the Anthropic SDKs.

POST/v1/messagesCreate a message
POST/v1/messages/count_tokensCount message tokens

Gemini

The Google Gemini API, for the google-genai SDK.

GET/v1beta/modelsList models (Gemini)
GET/v1beta/models/{model}Retrieve a model (Gemini)
POST/v1beta/models/{model}:generateContentGenerate content (Gemini)
POST/v1beta/models/{model}:streamGenerateContentStream generated content (Gemini)
POST/v1beta/models/{model}:countTokensCount tokens (Gemini)

Embeddings

Text and token-ID embeddings.

POST/v1/embeddingsCreate embeddings

Images

Generate and edit images.

POST/v1/images/generationsGenerate images
POST/v1/images/editsEdit an image

Audio

Text to speech and speech to text.

POST/v1/audio/speechCreate speech
POST/v1/audio/transcriptionsTranscribe audio

Videos

Asynchronous video generation jobs.

GET/v1/videosList videos
POST/v1/videosCreate a video
GET/v1/videos/{video_id}Retrieve a video
DELETE/v1/videos/{video_id}Delete a video
GET/v1/videos/{video_id}/contentDownload a video

Decisions

Typed classification, choice and scoring answers with probabilities.

POST/v1/decisionsCreate a decision
POST/v1/systemoneCreate a SystemOne decision

Batches

Run a JSONL file of requests asynchronously on batch models.

GET/v1/batchesList batches
POST/v1/batchesCreate a batch
GET/v1/batches/{batch_id}Retrieve a batch
POST/v1/batches/{batch_id}/cancelCancel a batch

Files

Upload batch input and download batch results.

POST/v1/filesUpload a file
GET/v1/files/{file_id}Retrieve a file
GET/v1/files/{file_id}/contentDownload a file

Management API (/api)

Account

Who the key belongs to, your keys and their limits.

GET/api/gateway/keys/{api_key_id}/limitsRead one key's effective limits
GET/api/keysList the organization's API keys
GET/api/orgs/{org_id}/pending-holdsList pending credit holds
GET/api/whoamiIdentify the organization behind this key

Models

Browse the catalog and add your own models and deployments.

GET/api/gateway/catalogGet the catalog as your organization resolves it
GET/api/modelsList catalog models
POST/api/modelsCreate a custom model
GET/api/models/{slug}Get a catalog model
GET/api/models/{slug}/providersList a model's deployments
POST/api/models/{slug}/providersAdd a deployment to a model
PUT/api/models/{slug}/providers/{provider_row_id}/endpoint-credentialRotate or clear an endpoint API key
GET/api/plan-discountsGet plan discounts per model

Waterfalls

The ordered lanes a model is served from, per organization.

GET/api/models/{slug}/waterfallGet a model's waterfall
PUT/api/models/{slug}/waterfallReplace your waterfall
PATCH/api/models/{slug}/waterfallEdit your waterfall step by step
DELETE/api/models/{slug}/waterfallReset your waterfall to the default

Provider connections

Bring your own provider keys (BYOK) and manage account pools.

Plan accounts

Serve requests from OpenAI and Anthropic subscription plans.

Data controls

Zero data retention, no-training routing, prompt capture and trace export.

GET/api/orgs/{org_id}/observation-exportRead the Langfuse live export setting
PUT/api/orgs/{org_id}/observation-exportConnect Langfuse and turn live export on or off
DELETE/api/orgs/{org_id}/observation-exportTurn Langfuse live export off
GET/api/orgs/{org_id}/provider-data-controlsRead the provider data-handling posture matrix
GET/api/orgs/{org_id}/provider-policyRead the organization's provider data-control policy
PUT/api/orgs/{org_id}/provider-policyUpdate the provider data-control policy
DELETE/api/orgs/{org_id}/provider-policyRemove the provider data-control policy
GET/api/orgs/{org_id}/telemetry-settingsRead the prompt and response storage switch
PUT/api/orgs/{org_id}/telemetry-settingsTurn prompt and response storage on or off
GET/api/orgs/{org_id}/zero-data-retentionRead the account-wide zero-data-retention switch
PUT/api/orgs/{org_id}/zero-data-retentionTurn account-wide zero data retention on or off

Usage

Usage rollups by day, provider, label, key and identity.

GET/api/gateway/usage/dailyGet grouped daily usage
GET/api/gateway/usage/eventsList settled usage events
POST/api/gateway/usage/importImport historical local usage
GET/api/orgs/{org_id}/usage/by-identityRoll up usage per identity
GET/api/orgs/{org_id}/usage/by-keyRoll up usage per API key
GET/api/orgs/{org_id}/usage/by-labelRoll up usage per end-user label
GET/api/orgs/{org_id}/usage/by-providerRoll up usage per provider
GET/api/orgs/{org_id}/usage/importedGet imported historical usage
GET/api/orgs/{org_id}/usage/latencyGet window latency percentiles
GET/api/orgs/{org_id}/usage/timeseriesGet bucketed usage over a window

Request log

Individual requests, their attempts and captured content.

Spend

Exact spend queries, series, exports and saved analyses.

POST/api/orgs/{org_id}/spend/activityList Spend activity
POST/api/orgs/{org_id}/spend/analyticsLoad Spend analytics
GET/api/orgs/{org_id}/spend/analytics/{analysis_id}Poll a Spend analytics load
DELETE/api/orgs/{org_id}/spend/analytics/{analysis_id}/comparisonCancel a pending comparison
POST/api/orgs/{org_id}/spend/buildsPrepare a Spend report
GET/api/orgs/{org_id}/spend/builds/{build_id}Get a Spend build
GET/api/orgs/{org_id}/spend/builds/{build_id}/exportExport a completed build as CSV
GET/api/orgs/{org_id}/spend/builds/{build_id}/reportPage a completed build report
GET/api/orgs/{org_id}/spend/builds/{build_id}/seriesRead a completed build series
POST/api/orgs/{org_id}/spend/exportExport Spend as CSV
POST/api/orgs/{org_id}/spend/facetsSearch filter values
POST/api/orgs/{org_id}/spend/latestRead the latest completed report
POST/api/orgs/{org_id}/spend/model-seriesRead model series
POST/api/orgs/{org_id}/spend/queryQuery a Spend report
POST/api/orgs/{org_id}/spend/seriesRead dimension series
POST/api/orgs/{org_id}/spend/snapshotFreeze a Spend snapshot
POST/api/orgs/{org_id}/spend/viewRead a report and its chart

Identities and budgets

End-user identities, customer plans and monthly budgets.

GET/api/orgs/{org_id}/budgetsList budgets for a month
PUT/api/orgs/{org_id}/budgetsSet a monthly budget
DELETE/api/orgs/{org_id}/budgets/{budget_id}Delete a budget
GET/api/orgs/{org_id}/identitiesList identities
POST/api/orgs/{org_id}/identitiesCreate an identity
PATCH/api/orgs/{org_id}/identities/{identity_id}Rename or redescribe an identity
GET/api/orgs/{org_id}/identities/{identity_id}/allowancesGet an identity's plan allowances
GET/api/orgs/{org_id}/identities/{identity_id}/customer-planGet an identity's customer plan
PUT/api/orgs/{org_id}/identities/{identity_id}/customer-planAssign a customer plan

OpenRouter compatible

OpenRouter's account API, for SDKs pointed at /api/v1.

GET/api/v1/activityGet daily activity by model and provider
GET/api/v1/creditsGet the organization credit balance
GET/api/v1/endpoints/zdrList zero-data-retention endpoints
GET/api/v1/generationGet cost and tokens for one request
GET/api/v1/keyGet the presented key's usage and limit
GET/api/v1/keysList API keys in OpenRouter's shape
POST/api/v1/keysCreate an API key
GET/api/v1/keys/{hash}Get one API key
PATCH/api/v1/keys/{hash}Update an API key
DELETE/api/v1/keys/{hash}Revoke an API key
GET/api/v1/modelsList callable models with OpenRouter-style ids
GET/api/v1/models/{author}/{slug}/endpointsList the provider endpoints serving one model
GET/api/v1/providersList routable providers
GET/api/v1/usagePage through settled requests with cost and attribution
POST/api/v1/usage/exportsQueue a bulk usage export for one key
GET/api/v1/usage/exports/{export_id}Get a usage export's status
GET/api/v1/usage/exports/{export_id}/downloadGet a short-lived download link for an export

Provider console

For inference providers selling their models through Experiential.

GET/api/orgs/{org_id}/providerGet the provider home
GET/api/orgs/{org_id}/provider/applicationGet the provider application
POST/api/orgs/{org_id}/provider/applyApply to become a provider
PUT/api/orgs/{org_id}/provider/credentialStore or rotate the provider house key
DELETE/api/orgs/{org_id}/provider/credentialRemove the provider house key
PUT/api/orgs/{org_id}/provider/lanes/{lane_id}/listingList or unlist a model lane
GET/api/orgs/{org_id}/provider/requestsList change requests
POST/api/orgs/{org_id}/provider/requestsFile a change request
GET/api/orgs/{org_id}/provider/usageGet daily lane usage
GET/api/orgs/{org_id}/provider/usage/by-modelGet daily usage per model
GET/api/orgs/{org_id}/provider/usage/model/{alias}Get one model's daily health and earnings
GET/api/orgs/{org_id}/provider/walletGet the provider wallet