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/models | List models |
| GET | /v1/models/{model} | Retrieve a model |
Chat Completions
The OpenAI Chat Completions API, streamed or buffered.
| POST | /v1/chat/completions | Create a chat completion |
Responses
The OpenAI Responses API, with server-side conversation state.
| POST | /v1/responses | Create a response |
Messages
The Anthropic Messages API, for Claude Code and the Anthropic SDKs.
| POST | /v1/messages | Create a message |
| POST | /v1/messages/count_tokens | Count message tokens |
Gemini
The Google Gemini API, for the google-genai SDK.
| GET | /v1beta/models | List models (Gemini) |
| GET | /v1beta/models/{model} | Retrieve a model (Gemini) |
| POST | /v1beta/models/{model}:generateContent | Generate content (Gemini) |
| POST | /v1beta/models/{model}:streamGenerateContent | Stream generated content (Gemini) |
| POST | /v1beta/models/{model}:countTokens | Count tokens (Gemini) |
Embeddings
Text and token-ID embeddings.
| POST | /v1/embeddings | Create embeddings |
Images
Generate and edit images.
| POST | /v1/images/generations | Generate images |
| POST | /v1/images/edits | Edit an image |
Audio
Text to speech and speech to text.
| POST | /v1/audio/speech | Create speech |
| POST | /v1/audio/transcriptions | Transcribe audio |
Videos
Asynchronous video generation jobs.
| GET | /v1/videos | List videos |
| POST | /v1/videos | Create a video |
| GET | /v1/videos/{video_id} | Retrieve a video |
| DELETE | /v1/videos/{video_id} | Delete a video |
| GET | /v1/videos/{video_id}/content | Download a video |
Decisions
Typed classification, choice and scoring answers with probabilities.
| POST | /v1/decisions | Create a decision |
| POST | /v1/systemone | Create a SystemOne decision |
Batches
Run a JSONL file of requests asynchronously on batch models.
| GET | /v1/batches | List batches |
| POST | /v1/batches | Create a batch |
| GET | /v1/batches/{batch_id} | Retrieve a batch |
| POST | /v1/batches/{batch_id}/cancel | Cancel a batch |
Files
Upload batch input and download batch results.
| POST | /v1/files | Upload a file |
| GET | /v1/files/{file_id} | Retrieve a file |
| GET | /v1/files/{file_id}/content | Download a file |
Management API (/api)
Account
Who the key belongs to, your keys and their limits.
| GET | /api/gateway/keys/{api_key_id}/limits | Read one key's effective limits |
| GET | /api/keys | List the organization's API keys |
| GET | /api/orgs/{org_id}/pending-holds | List pending credit holds |
| GET | /api/whoami | Identify the organization behind this key |
Models
Browse the catalog and add your own models and deployments.
| GET | /api/gateway/catalog | Get the catalog as your organization resolves it |
| GET | /api/models | List catalog models |
| POST | /api/models | Create a custom model |
| GET | /api/models/{slug} | Get a catalog model |
| GET | /api/models/{slug}/providers | List a model's deployments |
| POST | /api/models/{slug}/providers | Add a deployment to a model |
| PUT | /api/models/{slug}/providers/{provider_row_id}/endpoint-credential | Rotate or clear an endpoint API key |
| GET | /api/plan-discounts | Get plan discounts per model |
Waterfalls
The ordered lanes a model is served from, per organization.
| GET | /api/models/{slug}/waterfall | Get a model's waterfall |
| PUT | /api/models/{slug}/waterfall | Replace your waterfall |
| PATCH | /api/models/{slug}/waterfall | Edit your waterfall step by step |
| DELETE | /api/models/{slug}/waterfall | Reset your waterfall to the default |
Provider connections
Bring your own provider keys (BYOK) and manage account pools.
| GET | /api/orgs/{org_id}/provider-connections | List provider connections |
| POST | /api/orgs/{org_id}/provider-connections/{provider} | Add a provider account |
| PUT | /api/orgs/{org_id}/provider-connections/{provider} | Rotate a provider account |
| DELETE | /api/orgs/{org_id}/provider-connections/{provider} | Disconnect a provider account |
| POST | /api/orgs/{org_id}/provider-connections/{provider}/accounts/{setup_alias}/routing | Set provider account routing |
| POST | /api/orgs/{org_id}/provider-connections/{provider}/check | Check a provider account |
| POST | /api/orgs/{org_id}/provider-connections/{provider}/spend-refresh | Refresh provider account spend |
| GET | /api/orgs/{org_id}/provider-connections/accounts/usage | List provider account usage |
| POST | /api/orgs/{org_id}/provider-connections/reorder | Reorder provider accounts |
Plan accounts
Serve requests from OpenAI and Anthropic subscription plans.
| GET | /api/orgs/{org_id}/provider-connections/{provider}/plans | Check plan account availability |
| POST | /api/orgs/{org_id}/provider-connections/{provider}/plans/{setup_alias}/refresh-usage | Refresh plan account usage |
| POST | /api/orgs/{org_id}/provider-connections/{provider}/plans/import | Import a plan sign-in |
| POST | /api/orgs/{org_id}/provider-connections/{provider}/plans/sign-in | Start a plan sign-in |
| POST | /api/orgs/{org_id}/provider-connections/{provider}/plans/sign-in/complete | Complete a plan sign-in |
Data controls
Zero data retention, no-training routing, prompt capture and trace export.
| GET | /api/orgs/{org_id}/observation-export | Read the Langfuse live export setting |
| PUT | /api/orgs/{org_id}/observation-export | Connect Langfuse and turn live export on or off |
| DELETE | /api/orgs/{org_id}/observation-export | Turn Langfuse live export off |
| GET | /api/orgs/{org_id}/provider-data-controls | Read the provider data-handling posture matrix |
| GET | /api/orgs/{org_id}/provider-policy | Read the organization's provider data-control policy |
| PUT | /api/orgs/{org_id}/provider-policy | Update the provider data-control policy |
| DELETE | /api/orgs/{org_id}/provider-policy | Remove the provider data-control policy |
| GET | /api/orgs/{org_id}/telemetry-settings | Read the prompt and response storage switch |
| PUT | /api/orgs/{org_id}/telemetry-settings | Turn prompt and response storage on or off |
| GET | /api/orgs/{org_id}/zero-data-retention | Read the account-wide zero-data-retention switch |
| PUT | /api/orgs/{org_id}/zero-data-retention | Turn account-wide zero data retention on or off |
Usage
Usage rollups by day, provider, label, key and identity.
| GET | /api/gateway/usage/daily | Get grouped daily usage |
| GET | /api/gateway/usage/events | List settled usage events |
| POST | /api/gateway/usage/import | Import historical local usage |
| GET | /api/orgs/{org_id}/usage/by-identity | Roll up usage per identity |
| GET | /api/orgs/{org_id}/usage/by-key | Roll up usage per API key |
| GET | /api/orgs/{org_id}/usage/by-label | Roll up usage per end-user label |
| GET | /api/orgs/{org_id}/usage/by-provider | Roll up usage per provider |
| GET | /api/orgs/{org_id}/usage/imported | Get imported historical usage |
| GET | /api/orgs/{org_id}/usage/latency | Get window latency percentiles |
| GET | /api/orgs/{org_id}/usage/timeseries | Get bucketed usage over a window |
Request log
Individual requests, their attempts and captured content.
| GET | /api/orgs/{org_id}/usage/requests | List requests |
| GET | /api/orgs/{org_id}/usage/requests/{request_id} | Get one request |
| GET | /api/orgs/{org_id}/usage/requests/{request_id}/attempts | List a request's provider attempts |
| GET | /api/orgs/{org_id}/usage/requests/{request_id}/prompt | Get a request's captured prompt and response |
Spend
Exact spend queries, series, exports and saved analyses.
Identities and budgets
End-user identities, customer plans and monthly budgets.
| GET | /api/orgs/{org_id}/budgets | List budgets for a month |
| PUT | /api/orgs/{org_id}/budgets | Set a monthly budget |
| DELETE | /api/orgs/{org_id}/budgets/{budget_id} | Delete a budget |
| GET | /api/orgs/{org_id}/identities | List identities |
| POST | /api/orgs/{org_id}/identities | Create an identity |
| PATCH | /api/orgs/{org_id}/identities/{identity_id} | Rename or redescribe an identity |
| GET | /api/orgs/{org_id}/identities/{identity_id}/allowances | Get an identity's plan allowances |
| GET | /api/orgs/{org_id}/identities/{identity_id}/customer-plan | Get an identity's customer plan |
| PUT | /api/orgs/{org_id}/identities/{identity_id}/customer-plan | Assign a customer plan |
OpenRouter compatible
OpenRouter's account API, for SDKs pointed at /api/v1.
| GET | /api/v1/activity | Get daily activity by model and provider |
| GET | /api/v1/credits | Get the organization credit balance |
| GET | /api/v1/endpoints/zdr | List zero-data-retention endpoints |
| GET | /api/v1/generation | Get cost and tokens for one request |
| GET | /api/v1/key | Get the presented key's usage and limit |
| GET | /api/v1/keys | List API keys in OpenRouter's shape |
| POST | /api/v1/keys | Create 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/models | List callable models with OpenRouter-style ids |
| GET | /api/v1/models/{author}/{slug}/endpoints | List the provider endpoints serving one model |
| GET | /api/v1/providers | List routable providers |
| GET | /api/v1/usage | Page through settled requests with cost and attribution |
| POST | /api/v1/usage/exports | Queue 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}/download | Get a short-lived download link for an export |
Provider console
For inference providers selling their models through Experiential.
| GET | /api/orgs/{org_id}/provider | Get the provider home |
| GET | /api/orgs/{org_id}/provider/application | Get the provider application |
| POST | /api/orgs/{org_id}/provider/apply | Apply to become a provider |
| PUT | /api/orgs/{org_id}/provider/credential | Store or rotate the provider house key |
| DELETE | /api/orgs/{org_id}/provider/credential | Remove the provider house key |
| PUT | /api/orgs/{org_id}/provider/lanes/{lane_id}/listing | List or unlist a model lane |
| GET | /api/orgs/{org_id}/provider/requests | List change requests |
| POST | /api/orgs/{org_id}/provider/requests | File a change request |
| GET | /api/orgs/{org_id}/provider/usage | Get daily lane usage |
| GET | /api/orgs/{org_id}/provider/usage/by-model | Get 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/wallet | Get the provider wallet |