Sign in
BYOK

List BYOK provider credentials

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

Query parameters

offsetinteger nullable

Number of records to skip for pagination

Number of records to skip for pagination

limitinteger

Maximum number of records to return (max 100)

Example:50

Maximum number of records to return (max 100)

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

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.

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' | '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

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

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_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

Changed in 37 of the 303 revisions of this API.63441

  • 31b1cd25caca11See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

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

      request-parameter-enum-value-added

  • 4c8b9dc76c4511See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

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

      request-parameter-enum-value-added

  • 91342dd3fd0f1See the full diff
    • ○

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

      response-required-property-added

  • 3066544509b511See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

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

      request-parameter-enum-value-added

  • 2de027b6dfcd11See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

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

      request-parameter-enum-value-added

  • 54ab2e9ba85711See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

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

      request-parameter-enum-value-added

  • 34a00258bec933See the full diff
    • ●

      added the new amazon-bedrock/claude-on-aws enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new anthropic/2 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new claude-on-aws enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value amazon-bedrock/claude-on-aws to the query request parameter provider

      request-parameter-enum-value-added

    • ○

      added the new enum value anthropic/2 to the query request parameter provider

      request-parameter-enum-value-added

    • ○

      added the new enum value claude-on-aws to the query request parameter provider

      request-parameter-enum-value-added

  • 5d13b1d2e3ac11See the full diff
    • ●

      added the new near-ai enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value near-ai to the query request parameter provider

      request-parameter-enum-value-added

  • 029d7d64cf912See the full diff
    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

  • 933a13bf45f0112See the full diff
    • ▲

      removed the enum value prime-intellect from the query request parameter provider

      request-parameter-enum-value-removed

    • ●

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

      response-property-enum-value-added

    • ○

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

      request-parameter-enum-value-added

    • ○

      removed the prime-intellect enum value from the // response property for the response status

      response-property-enum-value-removed