API documentation

Overview

Create an API key and send your first request.

The API base URL (endpoint) is provided individually when your access is set up. Replace YOUR_API_BASE in the samples with the base URL you were given.

Authentication

Pass your API key as a Bearer token in the Authorization header on every request.

HTTP header

Authorization: Bearer YOUR_API_KEY

The full key is shown only once, at issuance on the API Keys page. Store it securely — it cannot be displayed again.

Health check

Liveness endpoint. No authentication required.

GET /v1/health

curl

curl https://YOUR_API_BASE/v1/health

List models

Returns the models available for forecasting. Requires authentication.

GET /v1/models

curl

curl https://YOUR_API_BASE/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

200 response

{
  "object": "list",
  "data": [
    {
      "id": "yoft",
      "version": "v1"
    }
  ]
}