Skip to main content
POST
Validate a BYOK provider key

Authorizations

Authorization
string
header
required

JWT authentication token

Path Parameters

provider
enum<string>
required

Provider identifier

Available options:
openrouter,
anthropic,
openai,
google,
xai,
vercel-gateway,
google-vertex,
amazon-bedrock,
azure-foundry

Body

application/json
api_key
string
required

The provider API key to validate. For google-vertex: must be the full GCP service account JSON string (containing type, client_email, private_key, project_id).

location
string | null

Cloud region or endpoint URL for location-aware providers:

  • google-vertex: GCP region for Vertex AI (e.g. "us-central1", "us-east5"). Defaults to "us-central1".
  • amazon-bedrock: AWS region (e.g. "us-east-1"). Defaults to "us-east-1".
  • azure-foundry: Foundry endpoint URL (e.g. "https://{resource}.openai.azure.com" or legacy "https://{resource}.services.ai.azure.com"). Required. Accepted only for azure-foundry, amazon-bedrock and google-vertex. Saving a key for any other provider with a location is refused with 400.

Response

Validation result

valid
boolean
required

Whether the API key is valid

details
string

Additional details about the validation result

error
string

Error message if validation failed