OpenAPI specification

Download the specification

The document is generated from the same endpoint registry that renders these pages and the API console in the Crayo app, so it always matches what is documented here. It is served as plain JSON.

curl -o crayo-openapi.json "https://crayo.ai/docs/openapi.json"

• Format: OpenAPI 3.1.0, title Crayo API, server https://api.crayo.ai.
• Security: one bearerAuth HTTP bearer scheme applied to every operation. Supply a key that starts with crayo_sk_.
• Coverage: 68 operations across 12 tags, one tag per endpoint group in these docs.

What each operation contains

Operations are keyed by path and lower-case method. Each one carries the endpoint id as operationId, the description and notes from these docs, path and query parameters with enums and defaults, a JSON request body schema with an example where the endpoint takes a body, and a 200 response schema inferred from the example response.

{
  "/v1/projects/{id}/export": {
    "post": {
      "operationId": "export-project",
      "summary": "Export project",
      "tags": [
        "Projects"
      ],
      "x-credits": "1 export credit per second of finished video",
      "x-rate-limit": {
        "tier": "heavy",
        "requests_per_second": 2,
        "requests_per_minute": 10
      }
    }
  }
}

• x-credits is the plain-language cost string shown on every endpoint page.
• x-rate-limit names the tier and its requests per second and per minute, the same numbers as the rate limit tables.
• Error responses are listed per status with example bodies keyed by code. The shared 401, 429 and 500 responses are present on every operation.

Shared schemas

components.schemas defines the Error envelope and the objects that View Tracker responses and webhooks reuse everywhere they appear. A field we do not have is null, never omitted.

Tags