Skip to main content
GET
/
api
/
keys
List all keys
curl --request GET \
  --url http://localhost:8080/api/keys
[
  {
    "id": "<string>",
    "name": "<string>",
    "value": {
      "value": "<string>",
      "env_var": "<string>",
      "from_env": true
    },
    "models": [
      "<string>"
    ],
    "weight": 123,
    "azure_key_config": {
      "endpoint": {
        "value": "<string>",
        "env_var": "<string>",
        "from_env": true
      },
      "deployments": {},
      "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
      },
      "deployments": {}
    },
    "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
      },
      "deployments": {},
      "batch_s3_config": {
        "buckets": [
          {
            "bucket_name": "<string>",
            "prefix": "<string>",
            "is_default": true
          }
        ]
      }
    },
    "huggingface_key_config": {
      "deployments": {}
    },
    "enabled": true,
    "use_for_batch_api": true
  }
]

Response

Successful response

​
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

​
weight
number

Weight for load balancing

​
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

​
huggingface_key_config
object

Hugging Face-specific key configuration

​
enabled
boolean
​
use_for_batch_api
boolean