Verify an API key

GET

{base_url}

auth

verify

Error

A valid request URL is required to generate request examples

{
  "key_id": "<string>",
  "method": "<string>",
  "user_path": "<string>",
  "valid": true
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "type": "provider_error",
    "provider": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

key_id

string

KeyID identifies the managed auth key that authenticated the request. Absent for every other method.

method

string

Method is "api_key" for a managed key stored in the database, "master_key" for the bootstrap key, an extension-specific value for identities supplied by an authentication extension, or "none" when the request carried no credential this gateway recognizes, which is also when Valid is false.

user_path

string

UserPath is the subtree the credential is bound to. Absent when the credential is global, which every master-key caller is.

valid

boolean

Last modified on September 8, 2026

⌘I

Error

A valid request URL is required to generate request examples

{
  "key_id": "<string>",
  "method": "<string>",
  "user_path": "<string>",
  "valid": true
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "type": "provider_error",
    "provider": "<string>"
  }
}

admin

system

mcp

passthrough

audio

auth

batch

chat

conversations

embeddings

files

images

messages

models

realtime

responses

usage

health

Verify an API key

Authorizations

Response