AppAIGatewayDocs
API referenceAdmin providers

Probe a provider credential without storing it

POST
/v1/admin/providers/test

Calls the provider with a credential, and reports what it answered. Nothing is stored, and no other endpoint runs this check: a write stores what it is given. Supply exactly one direct provider secret or an existing providerGatewayId.

Authorization

agw_identity_auth.session_token<token>

The console's session cookie. Admin requests from the console also send x-console-request: 1.

In: cookie

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/admin/providers/test" \  -H "Content-Type: application/json" \  -d '{    "type": "openai"  }'
{  "validated": true,  "reason": "no_probe",  "status": 0}