Skip to main content
PUT
/
api
/
providers
/
{provider}
/
keys
/
{key_id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "name": "<string>",
  "value": {
    "value": "<string>",
    "env_var": "<string>",
    "from_env": true
  },
  "models": [
    "<string>"
  ],
  "blacklisted_models": [
    "<string>"
  ],
  "weight": 123,
  "aliases": {},
  "azure_key_config": {
    "endpoint": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "api_version": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "client_id": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "client_secret": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "tenant_id": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "scopes": [
      "<string>"
    ]
  },
  "vertex_key_config": {
    "project_id": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "project_number": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "region": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "auth_credentials": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    }
  },
  "bedrock_key_config": {
    "access_key": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "secret_key": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "session_token": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "region": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "arn": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "batch_s3_config": {
      "buckets": [
        {
          "bucket_name": "<string>",
          "prefix": "<string>",
          "is_default": true
        }
      ]
    }
  },
  "vllm_key_config": {
    "url": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "model_name": "<string>"
  },
  "ollama_key_config": {
    "url": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    }
  },
  "sgl_key_config": {
    "url": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    }
  },
  "replicate_key_config": {
    "use_deployments_endpoint": true
  },
  "enabled": true,
  "use_for_batch_api": true,
  "config_hash": "<string>",
  "status": "<string>",
  "description": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with sk-bf-) can also be passed here.

Path Parameters

​
provider
string
required

Provider name

​
key_id
string
required

Key ID

Body

application/json

API key configuration

​
id
string

Unique identifier for the key

​
name
string

Name of the key

​
value
object

API key value (redacted in responses)

​
models
string[]

List of models this key can access (whitelist)

​
blacklisted_models
string[]

List of models this key cannot access (blacklist)

​
weight
number

Weight for load balancing

​
aliases
object

Model alias mappings — maps a user-facing model name to a provider-specific identifier (deployment name, inference profile ID, fine-tuned model ID, etc.)

​
azure_key_config
object

Azure-specific key configuration

​
vertex_key_config
object

Vertex-specific key configuration

​
bedrock_key_config
object

AWS Bedrock-specific key configuration

​
vllm_key_config
object

VLLM-specific key configuration

​
ollama_key_config
object

Ollama-specific key configuration

​
sgl_key_config
object

SGLang-specific key configuration

​
replicate_key_config
object

Replicate-specific key configuration

​
enabled
boolean

Whether the key is active (defaults to true)

​
use_for_batch_api
boolean

Whether this key can be used for batch API operations

​
config_hash
string

Hash of config.json version, used for change detection

​
status
string

Status of key (e.g., success, list_models_failed)

​
description
string

Error or status description for the key

Response

Key updated successfully

API key configuration

​
id
string

Unique identifier for the key

​
name
string

Name of the key

​
value
object

API key value (redacted in responses)

​
models
string[]

List of models this key can access (whitelist)

​
blacklisted_models
string[]

List of models this key cannot access (blacklist)

​
weight
number

Weight for load balancing

​
aliases
object

Model alias mappings — maps a user-facing model name to a provider-specific identifier (deployment name, inference profile ID, fine-tuned model ID, etc.)

​
azure_key_config
object

Azure-specific key configuration

​
vertex_key_config
object

Vertex-specific key configuration

​
bedrock_key_config
object

AWS Bedrock-specific key configuration

​
vllm_key_config
object

VLLM-specific key configuration

​
ollama_key_config
object

Ollama-specific key configuration

​
sgl_key_config
object

SGLang-specific key configuration

​
replicate_key_config
object

Replicate-specific key configuration

​
enabled
boolean

Whether the key is active (defaults to true)

​
use_for_batch_api
boolean

Whether this key can be used for batch API operations

​
config_hash
string

Hash of config.json version, used for change detection

​
status
string

Status of key (e.g., success, list_models_failed)

​
description
string

Error or status description for the key