API reference

Render Lottie compositions (the data.json that Blitframe for After Effects or Bodymovin exports) to MP4, HLS, PNG or JPEG frames and HTML5 ads on GPUs.

Every endpoint has a page in the API reference with its parameters and its request and response fields. Each page has a ready-to-run request in curl, Python, Node.js, PHP, Ruby, Go, C# and Java. Try it on an endpoint's page sends the request from your browser with your API key.

Authentication

Create an API key in the console, and send it on every request:

Authorization: Bearer blitframe_...

How it works

Object What it is
Project One piece of motion graphics: the composition you edit and render. Its headVersionId is the head of its main variation, the version edits and renders use by default.
Version An immutable snapshot of data.json and its files: images, video, fonts, audio and 3D models. Every change to a project keeps one.
Render Video or images made from one exact version. A render can replace text, fonts, images or video by layer, for that render only.
  1. POST /v1/projects creates an empty project.
  2. POST /v1/projects/{projectId}/versions edits it. Send data.json and its files, and the new version becomes the head. Add expectedHeadVersionId (the head you read) to get 409 head_moved instead of overwriting a change made since.
  3. Check that the version is renderable. If it is not, fix its problems in another edit.
  4. POST /v1/renders with the projectId queues a render of the head. Its versionId says which version it rendered.
  5. GET /v1/renders/{renderId} returns the render. Send Prefer: wait=50 to wait for it to finish, or use a webhook.

For many videos from one version, such as one per row of a data sheet, POST /v1/projects/{projectId}/renders/batch queues up to 1,000 renders of one version, each with its own replacements (editing).

For a lasting alternative in the same project, such as the video in Spanish, POST /v1/projects/{projectId}/variations adds a variation with a head of its own. Edits and renders that name it in variation use that head instead of main's.

The quickstart walks through these steps. The composition format lists what the engine renders and how to write it.

Conventions

Topic Rule
Format JSON bodies, camelCase fields, UUID ids, ISO 8601 times
Enums camelCase strings. Webhook event types are the exception: dotted names such as render.succeeded.
Lists { "items": [...], "next": "..." }. Pass next as before for the next page (as after for project files and library fonts). next is null on the last page.
Errors { "error": { "code": "...", "message": "..." } }. Branch on code (errors).
Retries Send an Idempotency-Key header when you create a project or variation, edit, import a ZIP or render, and the same key when you retry. The retry returns what the first request made, with Idempotent-Replayed: true, instead of doing it twice (retrying safely).
Rate limit Requests per minute per workspace, set by your plan (limits.requestsPerMinute in GET /v1/usage) and shared by all its API keys and MCP connections. Over it, you get 429 with a Retry-After header in seconds (limits).

AI agents

Agents can use the same operations through the MCP server at /mcp, with the same API key or by signing in with a Code Artworks account. See MCP for agents.

API keys

Editing

Fonts

Problem reports

Projects

Renders

Uploads

Workspace

Webhooks

Models

Models lists every object the requests send and the responses return, field by field.