OpenAPI

The Skysay API ships a live OpenAPI 3 document. It is the machine-readable source of truth for every REST endpoint, request/response schema, and auth requirement — generated from the running service. It lists only the operations a scoped sky_ key can call.

Open the spec

Point any OpenAPI-aware client at https://skysay.ai/control-plane/openapi.json (also served at https://api.skysay.ai/openapi.json) — Swagger UI, Postman, an SDK generator, or an agent that reads OpenAPI directly. The same scoped sky_ Bearer key authenticates every operation except the unauthenticated ones the document marks with security: [] (health, pricing, the self-hosted install plan and sandbox signup).

Generated reference and handwritten guides

The Generated API reference is a deterministic index of customer SDK operations built from a checked-in snapshot of that canonical OpenAPI schema. The snapshot lets the docs build and review offline; it is not a second hand-maintained API contract. Exact request/response detail remains in the live OpenAPI document.

Growing REST collections use bounded named list pages. The schema publishes each route's item key, strict limit/default/maximum, cursor, continuation metadata and refusal responses. Regenerate an older client before using the new list contract; a page is not the full collection.

Conceptual pages are deliberately handwritten because schemas cannot explain product ownership or safe use. Read Integrations for the signed Action protocol, Customer applications for the call lifecycle, and Post-call results for signed events and advisory extraction.