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

POST

/v1/providers/check-credentials

const url = 'https://app.everruns.com/api/v1/providers/check-credentials';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"api_key":"sk-proj-...","base_url":"https://api.openai.com/v1","credentials":"example","provider_type":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://app.everruns.com/api/v1/providers/check-credentials \
  --header 'Content-Type: application/json' \
  --data '{ "api_key": "sk-proj-...", "base_url": "https://api.openai.com/v1", "credentials": "example", "provider_type": "example" }'

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.

Request Body^required

application/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

200

Check completed

application/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"
}

400

Invalid request

500

Internal error

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

Request Bodyrequired

Example

Example

Responses

200

Example

400

500

Request Body^required