API Reference
Reference for the Gaur consumption API: endpoints, schemas, and authentication.
The precise reference for Gaur's consumption API, the endpoints an application uses to query a consumer. For task-oriented walkthroughs, see the Integrate track.
All endpoints sit under /v1. Authenticate every request with a Bearer
API key issued for a consumer:
Authorization: Bearer <api_key>A key authorizes exactly one consumer. See Authentication.
The three protocols
A consumer exposes its contracts through three protocols, each with its own endpoint:
| Protocol | Endpoint | Method |
|---|---|---|
| REST query API | /v1/api/{consumer_slug}/query | POST |
| Chat completions API | /v1/api/{consumer_slug}/chat/completions | POST |
| MCP server | /v1/api/{consumer_slug}/mcp | ANY |
Which ones a given consumer accepts depends on the protocols it has enabled.
Response envelope
Successful query-endpoint responses:
{
"data": { /* endpoint-specific payload */ },
"message": null
}Errors: a non-2xx status with
{ "message": string, "code": string, "errors": string[] | null }.
Branch on code, not on message.