Sign in
BYOK

Get a BYOK provider credential

Get a single bring-your-own-key (BYOK) provider credential by its id. Management key required.

get/byok/{id}

Path parameters

idstring uuid required

The BYOK credential ID (UUID).

Example:11111111-2222-3333-4444-555555555555

The BYOK credential ID (UUID).

Response

BYOK credential details

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"
  }
}

Changes

Changed in 35 of the 303 revisions of this API.1346

  • 31b1cd25caca1See the full diff
    • ●

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

      response-property-enum-value-added

  • 4c8b9dc76c451See the full diff
    • ●

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

      response-property-enum-value-added

  • 91342dd3fd0f1See the full diff
    • ○

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

      response-required-property-added

  • 3066544509b51See the full diff
    • ●

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

      response-property-enum-value-added

  • 2de027b6dfcd1See the full diff
    • ●

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

      response-property-enum-value-added

  • 54ab2e9ba8571See the full diff
    • ●

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

      response-property-enum-value-added

  • 34a00258bec93See 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

  • 5d13b1d2e3ac1See the full diff
    • ●

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

      response-property-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

  • 933a13bf45f011See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

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

      response-property-enum-value-removed