Skip to content
Docs
GitHub

Check a provider API key without storing it

Preview

Check whether a provider accepts an API key, without storing it

Used by org setup so a key the provider will reject is caught at entry instead of at the first agent run. Nothing is persisted.

Public APIEverruns Cloud and self-hosted Platform

POST/v1/providers/check-credentials

See authentication for credentials and permissions.

Media typeapplication/json

Request to check a provider credential without storing it.

object
api_key

Single-field credential. Mutually exclusive with credentials.

string | null

Example

sk-proj-...
base_url

Base URL for the provider’s API, when not the driver default.

string | null

Example

https://api.openai.com/v1
credentials

Typed multi-field credential, validated against the driver’s schema exactly as on create.

object | null
provider_type
required

The type of LLM provider (e.g., openai, anthropic).

string

Responses

200Check completed

Check completed

Media typeapplication/json
One of:

The provider accepted the credential.

object
models
required

Number of models the provider listed for this credential.

integer
status
required
string
Allowed values: valid

Example

{
"models": 42,
"status": "valid"
}
400Invalid request

Invalid request

500Internal error

Internal error