Skip to content
Yagra

Send one minimal prompt to the configured provider.

POST
/api/v1/llm/test
curl --request POST \
  --url https://example.com/api/v1/llm/test \
  --header 'Authorization: Bearer <token>'

Deliberately ignores enabled: validating a provider before switching it on is the whole point of the button (the same reasoning as the forwarding-destination test).

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The probe ran; ok says whether the provider answered

Media typeapplication/json

The provider-test outcome. ok: false is a successful request reporting a failed probe — the provider configuration is the caller’s, and the typed error is what tells them which part of it is wrong, so this is not a 5xx.

object
error
string | null
latency_ms
integer | null
ok
required
boolean
reply
string | null
Examplegenerated
{
  "error": "example",
  "latency_ms": 1,
  "ok": true,
  "reply": "example"
}

401

Section titled “401”

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403”

Role lacks the ManageConfig permission

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

Section titled “503”

Skeleton mode: no provider to test

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}