API REFERENCE

The interfaces behind Clyvel.

A compact reference for Gateway requests and the operational APIs used by the Clyvel product.

Authentication

Send the Clyvel key in the Authorization header.

Authorization: Bearer <CLYVEL_API_KEY>

MethodEndpointPurpose

POST/v1/chat/completionsOpenAI-compatible Gateway request

GET/api/v1/requestsQuery captured request telemetry

GET/api/v1/overviewRead operational overview metrics

Gateway example

POST /v1/chat/completions

{
  "model": "gpt-5-mini",
  "messages": [
    {
      "role": "user",
      "content": "Summarize this request"
    }
  ]
}