API referenceEndpoints

Create connector

Requires platform-administrator authority. Generated from the production route registered in `internal/features/connector/inbound/http.go`.

POST/v1/connectors

Requires platform-administrator authority. Generated from the production route registered in internal/features/connector/inbound/http.go.

Authorization

AuthorizationBearer <token>

Engine-issued API key or tenant-signed JWT.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

One platform connector. The provider type must be able to serve the kind. Registration runs one minimal real call for the kind before storing — a one-token chat, a tiny embedding, a fixed rerank, or one tiny search — unless skip_validation is set: a definitive refusal is 400 and nothing is stored; an unreachable provider is stored and reported in verification.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/connectors" \  -H "Content-Type: application/json" \  -d '{    "key": "string",    "name": "string",    "type": "openai"  }'
{}