BYOK

List BYOK provider credentials

Changed on

List the bring-your-own-key (BYOK) provider credentials for the authenticated entity's default workspace. Use the workspace_id query parameter to scope the result to a different workspace, or the provider query parameter to filter by upstream provider. Management key required.

get/byok

Request

  • Base URL: https://openrouter.ai/api/v1
  • URL: https://openrouter.ai/api/v1/byok
  • Auth: HTTP bearer

Query parameters

offsetinteger nullable

Number of records to skip for pagination

limitinteger

Maximum number of records to return (max 100)

Example:50
workspace_idstring uuid

Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass workspace_id explicitly.

Example:550e8400-e29b-41d4-a716-446655440000
provider'ai21' | 'aion-labs' | 'akashml' | 'alibaba' | 'amazon-bedrock' | 'amazon-bedrock/claude-on-aws' | 'amazon-nova' | 'ambient' | 'anthropic' | 'anthropic/2' | 'arcee-ai' | 'assemblyai' | 'atlas-cloud' | 'avian' | 'azure' | 'baidu' | 'baseten' | 'black-forest-labs' | 'byteplus' | 'cerebras' | 'chutes' | 'cirrascale' | 'clarifai' | 'claude-on-aws' | 'cloudflare' | 'cohere' | 'coreweave' | 'cosine' | 'crusoe' | 'darkbloom' | 'databricks' | 'decart' | 'deepgram' | 'deepinfra' | 'deepseek' | 'dekallm' | 'digitalocean' | 'elevenlabs' | 'featherless' | 'fireworks' | 'fish-audio' | 'friendli' | 'gmicloud' | 'google-ai-studio' | 'google-vertex' | 'groq' | 'heygen' | 'inception' | 'inceptron' | 'inferact-vllm' | 'inference-net' | 'infermatic' | 'inflection' | 'io-net' | 'ionstream' | 'krea' | 'liquid' | 'makora' | 'mancer' | 'mara' | 'meta' | 'minimax' | 'mistral' | 'modal' | 'modelrun' | 'modular' | 'moonshotai' | 'morph' | 'near-ai' | 'nebius' | 'nex-agi' | 'nextbit' | 'novita' | 'nvidia' | 'ollama' | 'open-inference' | 'openai' | 'parasail' | 'perceptron' | 'perplexity' | 'phala' | 'poolside' | 'primeintellect' | 'quiver' | 'recraft' | 'reka' | 'relace' | 'respan' | 'runway' | 'sail-research' | 'sakana' | 'sakana-ai' | 'sambanova' | 'scaledown' | 'seed' | 'siliconflow' | 'sourceful' | 'stepfun' | 'streamlake' | 'switchpoint' | 'tencent' | 'tenstorrent' | 'thinkingmachines' | 'together' | 'typesafe' | 'unbiased' | 'upstage' | 'venice' | 'voyageai' | 'wafer' | 'wandb' | 'wandb-legacy' | 'xai' | 'xiaomi' | 'z-ai'

Optional provider slug to filter by (e.g. openai, anthropic, amazon-bedrock).

Example:openai

Response

List of BYOK credentials

total_countinteger required

Total number of BYOK credentials matching the filters.

Example response

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

Changes

  • e25de0f50842Revision changes
    • info

      added the required property // to the response with the status

  • 68a12e66c7faRevision changes
    • warning

      added the new elevenlabs enum value to the // response property for the response status

    • info

      added the new enum value elevenlabs to the query request parameter provider