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. |
POST /v1/projectscreates an empty project.POST /v1/projects/{projectId}/versionsedits it. Senddata.jsonand its files, and the new version becomes the head. AddexpectedHeadVersionId(the head you read) to get409 head_movedinstead of overwriting a change made since.- Check that the version is
renderable. If it is not, fix itsproblemsin another edit. POST /v1/renderswith theprojectIdqueues a render of the head. ItsversionIdsays which version it rendered.GET /v1/renders/{renderId}returns the render. SendPrefer: wait=50to 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
- GET
/v1/projectsList projects - POST
/v1/projectsCreate a project - GET
/v1/projects/{projectId}Get a project - PATCH
/v1/projects/{projectId}Rename a project - DELETE
/v1/projects/{projectId}Delete a project - GET
/v1/projects/{projectId}/filesList project files - POST
/v1/projects/{projectId}/packageImport a ZIP into a project - GET
/v1/projects/{projectId}/package/{importId}Get a ZIP import - GET
/v1/projects/{projectId}/variationsList variations - POST
/v1/projects/{projectId}/variationsCreate a variation - GET
/v1/projects/{projectId}/variations/{name}Get a variation - DELETE
/v1/projects/{projectId}/variations/{name}Delete a variation - GET
/v1/projects/{projectId}/versionsList version history - POST
/v1/projects/{projectId}/versionsEdit a project - GET
/v1/versions/{versionId}Get a version - GET
/v1/versions/{versionId}/files/{path}Download a file - POST
/v1/versions/{versionId}/exportExport a version as ZIP - GET
/v1/versions/{versionId}/export/{exportId}Get a version export
Renders
- POST
/v1/rendersCreate a render - GET
/v1/rendersList renders - POST
/v1/projects/{projectId}/renders/batchCreate a batch of renders - POST
/v1/renders/statusesGet many render statuses - POST
/v1/renders/cancelCancel many renders - POST
/v1/renders/download-archiveCreate a download archive - GET
/v1/renders/download-archive/{archiveId}Get a download archive - GET
/v1/renders/{renderId}Get a render - DELETE
/v1/renders/{renderId}Delete a render - POST
/v1/renders/{renderId}/cancelCancel a render - GET
/v1/renders/{renderId}/htmlExport an HTML5 ad
Share links
- POST
/v1/projects/{projectId}/share-linksCreate a share link - GET
/v1/projects/{projectId}/share-linksList share links - DELETE
/v1/share-links/{linkId}Delete a share link
Uploads
- POST
/v1/uploadsCreate an upload - GET
/v1/uploads/{uploadId}Get an upload - DELETE
/v1/uploads/{uploadId}Abort an upload - POST
/v1/uploads/{uploadId}/partsIssue part URLs again - POST
/v1/uploads/{uploadId}/completeComplete an upload - GET
/v1/files/capabilitiesGet file capabilities
Workspace
Webhooks
- GET
/v1/webhooksList webhook endpoints - POST
/v1/webhooksAdd a webhook endpoint - GET
/v1/webhooks/{webhookId}Get a webhook endpoint - PATCH
/v1/webhooks/{webhookId}Update a webhook endpoint - DELETE
/v1/webhooks/{webhookId}Delete a webhook endpoint - POST
/v1/webhooks/{webhookId}/rotate-secretRotate the signing secret - GET
/v1/webhooks/{webhookId}/deliveriesList deliveries - POST
/v1/webhooks/{webhookId}/deliveries/{deliveryId}/redeliverRedeliver an event - POST
/v1/webhooks/{webhookId}/testSend a test event - POST
/v1/webhooks/{webhookId}/recoverResend missed events
Models
Models lists every object the requests send and the responses return, field by field.