Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Manic Platform REST API

The Manic Platform API is the hosted control plane around the portable Manic engine. Use it to validate source, manage projects and API keys, run Manic AI, and submit hosted renders. Your .manic source remains the portable artifact.

Open the interactive reference at docs.maniclang.com/api. It includes the request forms, response schemas, scoped authentication, and a downloadable OpenAPI document.

Start safely

  1. Create a scoped key from Manic Account.
  2. Use a mk_test_… key while integrating; use mk_live_… only for production.
  3. Send it as Authorization: Bearer mk_live_… (or X-API-Key).
  4. For render and AI creation requests, always generate an Idempotency-Key and retry with that same key after an uncertain network failure.
curl https://api.maniclang.com/v1/check \
  -H 'Authorization: Bearer mk_test_…' \
  -H 'Content-Type: application/json' \
  --data '{"source":"title(\\"Hello\\"); canvas(\\"16:9\\");"}'

POST /v1/check is synchronous and uses no credits. Hosted rendering and AI are asynchronous: submit, then poll GET /v1/jobs/{id} until the job reaches a terminal state. The interactive reference lists only shipped public endpoints; it never exposes render-host or provisioning endpoints.

For the architectural contract, resource lifecycle, retention, and error semantics, see the repository’s platform API contract.