APIInference

Inference Connections_test

Verifies the endpoint accepts the stored credential, so a bad key fails here rather than in use.

POST
/inference/connections/{connection_id}/test

Verifies the endpoint accepts the stored credential, so a bad key fails here rather than in use.

Authorization

ApiKeyAuth
headerAuthorizationBearer <token>

Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.

Required permission

manage_inference

Path Parameters

connection_id*string
Formatuuid

Response Body

The request has succeeded.

application/json
  1. response

Result of a connection check.

ok*boolean
error_message?string
curl -X POST "https://example.com/inference/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/test"
{  "ok": true,  "error_message": "string"}