Skip to main content
POST
/
byok
Create a BYOK provider credential
curl --request POST \
  --url https://openrouter.ai/api/v1/byok \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "sk-proj-abc123...",
  "name": "Production OpenAI Key",
  "provider": "openai"
}
'
{
  "data": {
    "allowed_api_key_hashes": null,
    "allowed_models": null,
    "allowed_user_ids": null,
    "created_at": "2025-08-24T10:30:00Z",
    "disabled": false,
    "id": "11111111-2222-3333-4444-555555555555",
    "is_fallback": false,
    "label": "sk-...AbCd",
    "name": "Production OpenAI Key",
    "provider": "openai",
    "sort_order": 0,
    "workspace_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Authorizations

​
Authorization
string
header
required

API key as bearer token in Authorization header

Body

application/json
​
key
string
required

The raw provider API key or credential. This value is encrypted at rest and never returned in API responses.

Minimum string length: 1
Example:

"sk-proj-abc123..."

​
provider
enum<string>
required

The upstream provider this credential authenticates against, as a lowercase slug (e.g. openai, anthropic, amazon-bedrock).

Available options:
ai21,
aion-labs,
akashml,
alibaba,
amazon-bedrock,
amazon-nova,
ambient,
anthropic,
arcee-ai,
atlas-cloud,
avian,
azure,
baidu,
baseten,
black-forest-labs,
byteplus,
cerebras,
chutes,
cirrascale,
clarifai,
cloudflare,
cohere,
crusoe,
darkbloom,
decart,
deepinfra,
deepseek,
dekallm,
digitalocean,
featherless,
fireworks,
friendli,
gmicloud,
google-ai-studio,
google-vertex,
groq,
heygen,
inception,
inceptron,
inferact-vllm,
inference-net,
infermatic,
inflection,
io-net,
ionstream,
liquid,
mancer,
mara,
minimax,
mistral,
modelrun,
modular,
moonshotai,
morph,
ncompass,
nebius,
nex-agi,
nextbit,
novita,
nvidia,
open-inference,
openai,
parasail,
perceptron,
perplexity,
phala,
poolside,
quiver,
recraft,
reka,
relace,
sakana-ai,
sambanova,
seed,
siliconflow,
sourceful,
stepfun,
streamlake,
switchpoint,
tenstorrent,
together,
upstage,
venice,
wafer,
wandb,
xai,
xiaomi,
z-ai
Example:

"openai"

​
allowed_models
string[] | null

Optional allowlist of model slugs this credential may be used for. null means no restriction.

Maximum array length: 100
Example:

null

​
allowed_user_ids
string[] | null

Optional allowlist of user IDs that may use this credential. null means no restriction.

Maximum array length: 100
Example:

null

​
disabled
boolean

Whether this credential should be created in a disabled state.

Example:

false

​
is_fallback
boolean

Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.

Example:

false

​
name
string | null

Optional human-readable name for the credential.

Maximum string length: 255
Example:

"Production OpenAI Key"

​
workspace_id
string<uuid>

Optional workspace ID. Defaults to the authenticated entity's default workspace.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

BYOK credential created successfully

​
data
object
required

The created BYOK credential.

Example:
{
  "allowed_api_key_hashes": null,
  "allowed_models": null,
  "allowed_user_ids": null,
  "created_at": "2025-08-24T10:30:00Z",
  "disabled": false,
  "id": "11111111-2222-3333-4444-555555555555",
  "is_fallback": false,
  "label": "sk-...AbCd",
  "name": "Production OpenAI Key",
  "provider": "openai",
  "sort_order": 0,
  "workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}