{"openapi":"3.1.1","info":{"title":"Blitframe API","description":"Render Lottie compositions (the \u0060data.json\u0060 that Blitframe for After Effects or Bodymovin exports) to MP4, HLS, PNG or JPEG frames and HTML5 ads on GPUs.\n\nEvery endpoint has a page in the [API reference](/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\u0027s page sends the request from your browser with your API key.\n\n## Authentication\n\nCreate an API key in the [console](https://app.codeartworks.com/blitframe/api-keys), and send it on every request:\n\n\u0060\u0060\u0060\nAuthorization: Bearer blitframe_...\n\u0060\u0060\u0060\n\n## How it works\n\n| Object | What it is |\n|---|---|\n| Project | One piece of motion graphics: the composition you edit and render. Its \u0060headVersionId\u0060 is the head of its \u0060main\u0060 variation, the version edits and renders use by default. |\n| Version | An immutable snapshot of \u0060data.json\u0060 and its files: images, video, fonts, audio and 3D models. Every change to a project keeps one. |\n| Render | Video or images made from one exact version. A render can replace text, fonts, images or video by layer, for that render only. |\n\n1. \u0060POST /v1/projects\u0060 creates an empty project.\n2. \u0060POST /v1/projects/{projectId}/versions\u0060 edits it. Send \u0060data.json\u0060 and its files, and the new version becomes the head. Add \u0060expectedHeadVersionId\u0060 (the head you read) to get \u0060409 head_moved\u0060 instead of overwriting a change made since.\n3. Check that the version is \u0060renderable\u0060. If it is not, fix its \u0060problems\u0060 in another edit.\n4. \u0060POST /v1/renders\u0060 with the \u0060projectId\u0060 queues a render of the head. Its \u0060versionId\u0060 says which version it rendered.\n5. \u0060GET /v1/renders/{renderId}\u0060 returns the render. Send \u0060Prefer: wait=50\u0060 to wait for it to finish, or use a [webhook](/docs/webhooks).\n\nFor many videos from one version, such as one per row of a data sheet, \u0060POST /v1/projects/{projectId}/renders/batch\u0060 queues up to 1,000 renders of one version, each with its own replacements ([editing](/docs/editing#many-videos-from-a-data-sheet)).\n\nFor a lasting alternative in the same project, such as the video in Spanish, \u0060POST /v1/projects/{projectId}/variations\u0060 adds a [variation](/docs/variations) with a head of its own. Edits and renders that name it in \u0060variation\u0060 use that head instead of \u0060main\u0060\u0027s.\n\nThe [quickstart](/docs/quickstart) walks through these steps. The [composition format](/docs/data-json-format) lists what the engine renders and how to write it.\n\n## Conventions\n\n| Topic | Rule |\n|---|---|\n| Format | JSON bodies, camelCase fields, UUID ids, ISO 8601 times |\n| Enums | camelCase strings. Webhook event types are the exception: dotted names such as \u0060render.succeeded\u0060. |\n| Lists | \u0060{ \u0022items\u0022: [...], \u0022next\u0022: \u0022...\u0022 }\u0060. Pass \u0060next\u0060 as \u0060before\u0060 for the next page (as \u0060after\u0060 for project files and library fonts). \u0060next\u0060 is \u0060null\u0060 on the last page. |\n| Errors | \u0060{ \u0022error\u0022: { \u0022code\u0022: \u0022...\u0022, \u0022message\u0022: \u0022...\u0022 } }\u0060. Branch on \u0060code\u0060 ([errors](/docs/errors)). |\n| Retries | Send an \u0060Idempotency-Key\u0060 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 \u0060Idempotent-Replayed: true\u0060, instead of doing it twice ([retrying safely](/docs/api#retrying-safely)). |\n| Rate limit | Requests per minute per workspace, set by your plan (\u0060limits.requestsPerMinute\u0060 in \u0060GET /v1/usage\u0060) and shared by all its API keys and MCP connections. Over it, you get \u0060429\u0060 with a \u0060Retry-After\u0060 header in seconds ([limits](/docs/limits#api-and-workspace)). |\n\n## AI agents\n\nAgents can use the same operations through the MCP server at \u0060/mcp\u0060, with the same API key or by signing in with a Code Artworks account. See [MCP for agents](/docs/mcp).","version":"1.0.0"},"servers":[{"url":"https://blitframe.codeartworks.com"}],"paths":{"/v1/api-keys":{"get":{"tags":["API keys"],"summary":"List API keys","description":"The workspace\u0027s active keys, newest first, with their prefix, who created each, when it expires and when it was last used. Secrets and expired keys are never listed.","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfApiKeyDto"}}}}}}},"/v1/api-keys/{apiKeyId}":{"delete":{"tags":["API keys"],"summary":"Revoke an API key","description":"Requests that use the key fail from now on. A request authenticated with an API key can revoke only that same key, and one sent by an app connected with a Code Artworks account (a signed-in MCP connection) only the keys its person created; anything else gets 403 key_cannot_revoke_keys and is revoked in the console. New keys are created in the console only.","parameters":[{"name":"apiKeyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"204":{"description":"No Content","content":{"application/json":{}}}}}},"/v1/versions/{versionId}/layers":{"get":{"tags":["Editing"],"summary":"List editable layers","description":"The text, image and video layers of the version\u0027s data.json, each with the layer id that replacements use: in a render or a render batch for a changed video alone, or in an edit to change the project itself (a new head). Also the composition\u0027s width and height, its fonts, the version\u0027s audio files and its default soundtrack. A text, name, font or asset id longer than 16,383 characters is listed cut to its first 16,383, ending with \u0027\u2026\u0027.","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayersDto"}}}}}}},"/v1/fonts":{"get":{"tags":["Fonts"],"summary":"List library fonts","description":"Fonts every composition can use without uploading them, ordered by slug. q matches part of the family, style or slug. When next is not null, pass it as after for the next page. previewUrl is a PNG of the font\u0027s name set in the font, valid for an hour.","parameters":[{"name":"q","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32","default":100}},{"name":"after","in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfFontDto"}}}}}}},"/v1/fonts/{slug}":{"get":{"tags":["Fonts"],"summary":"Get a library font","description":"One library font by slug, with its data.json declaration, license and preview image.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"},"example":"montserrat-bold"}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FontDto"}}}}}}},"/v1/problem-reports":{"post":{"tags":["Problem reports"],"summary":"Report a problem","description":"Tells Blitframe support about a problem, optionally with the render or version it concerns. message is at most 2,000 characters. A workspace can send 10 reports an hour.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProblemReportRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateProblemReportRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/CreateProblemReportRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemReportDto"}}}}}}},"/v1/problem-reports/{reportId}":{"get":{"tags":["Problem reports"],"summary":"Get a problem report","description":"status is open until support marks the report resolved.","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemReportDto"}}}}}}},"/v1/projects":{"get":{"tags":["Projects"],"summary":"List projects","description":"The workspace\u0027s projects, newest first, each with the head version of its main variation: 100 a page unless limit asks for another number, up to 1,000. q searches project names. copiedFromVersionId lists the copies made of that version, and copiedFromProjectId the copies made of any version of that project while it exists. When next is not null, pass it as before for older projects. headVersionId is null and renderable null while a project is empty. copiedFromVersionId is the version a copy was made from, kept after that version\u0027s project is deleted, or null. thumbnailUrl is the poster of the latest succeeded video render, or null.","parameters":[{"name":"q","in":"query","schema":{"type":"string"}},{"name":"copiedFromVersionId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"copiedFromProjectId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","schema":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32","default":100}},{"name":"before","in":"query","schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfProjectDto"}}}}}},"post":{"tags":["Projects"],"summary":"Create a project","description":"Creates an empty project, or one that starts from a ZIP or a copy of a version. Pass zipUploadId, a completed upload whose fileName ends in .zip, to import it as version 1; a ZIP with font files also needs fontLicenseAccepted true. The import is waited for like a package import: 201 with the project, the import\u0027s error (the project is not kept), or 202 with the import of a large ZIP still importing. At most 10 imports per workspace wait or run at once (409 import_limit). Pass fromVersionId, any version of the workspace, to duplicate it: the new project starts with that version\u0027s files, soundtrack and name, without its history, and its copiedFromVersionId names that version. Send at most one of zipUploadId and fromVersionId. The project starts with one variation, main. A ZIP whose files total more than the plan\u0027s project size (limits.maxProjectBytes in the usage) fails with 403 project_too_large, and so does a copy that large unless a head of its source project is at least as large. Send an Idempotency-Key header (1 to 200 characters) to make retries safe: for 24 hours the same request with the same key answers with what the first one made, with the header Idempotent-Replayed: true; the same key with a different request is 422 idempotency_key_reused while what the first one made exists, and while the first request is still running 409 idempotency_key_in_use, except that the retry of a ZIP import waits for that import, as the first request does. A request that failed made nothing, so it can be sent again with its key.","parameters":[{"name":"Prefer","in":"header","schema":{"type":"string"},"example":"wait=50"},{"name":"Idempotency-Key","in":"header","description":"Optional. A unique key you choose for this one request, 1 to 200 characters, such as a new UUID. Send the same key again only to retry this request after a lost answer: the retry answers with what the first one made instead of doing it again. Use a new key for every other request; the key in the samples is only an example.","schema":{"type":"string"},"example":"70337cac-0dc6-34ce-8179-c31f144c64bf"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateProjectRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/CreateProjectRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDto"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZipImportDto"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{projectId}":{"get":{"tags":["Projects"],"summary":"Get a project","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDto"}}}}}},"patch":{"tags":["Projects"],"summary":"Rename a project","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RenameRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/RenameRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDto"}}}}}},"delete":{"tags":["Projects"],"summary":"Delete a project","description":"Deletes the project, its variations, versions and renders. Cancel active renders first.","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"204":{"description":"No Content","content":{"application/json":{}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{projectId}/files":{"get":{"tags":["Projects"],"summary":"List project files","description":"Every distinct file across the project\u0027s versions: a path whose content changed appears once per content. versionId is the latest version that holds it. Filter by kind (image, video, audio, font, json, composition, model) and q (part of the path, any case). Pass next as after to page.","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"kind","in":"query","schema":{"$ref":"#/components/schemas/BlobKind"}},{"name":"q","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32","default":100}},{"name":"after","in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfProjectFileDto"}}}}}}},"/v1/projects/{projectId}/package":{"post":{"tags":["Projects"],"summary":"Import a ZIP into a project","description":"Replaces every file of the project with the ZIP\u0027s files as a new version on the head of a variation: variation, or main when it is left out (404 not_found for a variation the project lacks). With expectedHeadVersionId, the head must still be that version (409 head_moved otherwise); without it, the version goes on whatever the head is when the import finishes. zipUploadId names a completed upload whose fileName ends in .zip (409 upload_incomplete before it is completed). The ZIP follows the same rules as a project import, including fontLicenseAccepted true when it contains font files. The request waits up to 50 seconds (Prefer: wait=N changes it, at most 50) and answers 201 with the version, or the import\u0027s error. A larger ZIP still importing then answers 202 with the import; get it until its status is succeeded or failed. At most 10 imports per workspace wait or run at once (409 import_limit). A ZIP whose files total more than the plan\u0027s project size (limits.maxProjectBytes in the usage) is refused with 403 project_too_large, unless the head it replaces is at least as large. Send an Idempotency-Key header (1 to 200 characters) to make retries safe: for 24 hours the same request with the same key answers with what the first one made, with the header Idempotent-Replayed: true; the same key with a different request is 422 idempotency_key_reused while what the first one made exists, and while the first request is still running 409 idempotency_key_in_use, except that the retry of a ZIP import waits for that import, as the first request does. A request that failed made nothing, so it can be sent again with its key.","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Prefer","in":"header","schema":{"type":"string"},"example":"wait=50"},{"name":"Idempotency-Key","in":"header","description":"Optional. A unique key you choose for this one request, 1 to 200 characters, such as a new UUID. Send the same key again only to retry this request after a lost answer: the retry answers with what the first one made instead of doing it again. Use a new key for every other request; the key in the samples is only an example.","schema":{"type":"string"},"example":"c1dcd9b4-822c-dc78-383a-ebe93f22e513"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportPackageRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/ImportPackageRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/ImportPackageRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionDto"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZipImportDto"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{projectId}/package/{importId}":{"get":{"tags":["Projects"],"summary":"Get a ZIP import","description":"Status of an import that answered 202: queued, importing, succeeded (with versionId) or failed (with error: code and message). Send Prefer: wait=N (at most 50) to hold the answer until the import finishes, or N seconds pass.","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Prefer","in":"header","schema":{"type":"string"},"example":"wait=50"}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZipImportDto"}}}}}}},"/v1/renders":{"post":{"tags":["Renders"],"summary":"Create a render","description":"Queues a render of one version and charges its render seconds. Send projectId to render the head of a variation (variation, or main when it is left out), or versionId alone to render that version; an empty project is refused with 422 version_not_renderable. The answer\u0027s sourceVersionId is that version. replacements change text, fonts, images or video by layer for this render only: they are checked against the version at once, and versionId stays null until the render\u0027s own version is made from them, usually within seconds; a new file comes from an upload. The answer and a read of this one render show the replacements as sent; lists, statuses, cancels, batches and webhooks leave them out. A version longer or larger than the plan allows is refused with 403 plan_limit. The body may be up to 64 MB (413 too_large). Send an Idempotency-Key header (1 to 200 characters, no \u0027/\u0027, not starting with \u0027share:\u0027) to make retries safe: for 24 hours the same request with the same key answers with the same render, with the header Idempotent-Replayed: true, rendering the version the first request rendered even if the head has moved since; the same key with a different request is 422 idempotency_key_reused.","parameters":[{"name":"Idempotency-Key","in":"header","description":"Optional. A unique key you choose for this one request, 1 to 200 characters, such as a new UUID. Send the same key again only to retry this request after a lost answer: the retry answers with what the first one made instead of doing it again. Use a new key for every other request; the key in the samples is only an example.","schema":{"type":"string"},"example":"8974531c-0835-b000-e7fb-6210e2195bcc"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRenderRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateRenderRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/CreateRenderRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderDto"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"tags":["Renders"],"summary":"List renders","description":"Newest first, optionally for one project. Pass next as before to page. Frame links and replacements are left out; get one render for them.","parameters":[{"name":"projectId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","schema":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32","default":50}},{"name":"before","in":"query","schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfRenderDto"}}}}}}},"/v1/projects/{projectId}/renders/batch":{"post":{"tags":["Renders"],"summary":"Create a batch of renders","description":"Queues up to 1,000 renders of one version of the project: versionId, or else the head of a variation (variation, or main when it is left out). Each render has the options of a single render request (format, quality, frames, audio, name, replacements). Every render is checked first, its replacements and uploads included; if any is refused, nothing is queued or charged, and the message starts with renders[i]. Each upload can be named by one render only. The answer names the version every render uses, and leaves out each render\u0027s replacements and frame links; get one render for them. The body may be up to 64 MB (413 too_large). Send an Idempotency-Key header (1 to 200 characters, no \u0027/\u0027, not starting with \u0027share:\u0027) to make retries safe: for 24 hours the same batch with the same key answers with the same renders, with the header Idempotent-Replayed: true; the same key with a different request is 422 idempotency_key_reused.","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","description":"Optional. A unique key you choose for this one request, 1 to 200 characters, such as a new UUID. Send the same key again only to retry this request after a lost answer: the retry answers with what the first one made instead of doing it again. Use a new key for every other request; the key in the samples is only an example.","schema":{"type":"string"},"example":"1ddd7b06-55f6-01e4-a59d-4b1376fdb00f"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRenderBatchRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateRenderBatchRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/CreateRenderBatchRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderBatchDto"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/renders/statuses":{"post":{"tags":["Renders"],"summary":"Get many render statuses","description":"Up to 1,000 renders in one call, in the order asked. Ids that are not this workspace\u0027s renders are listed in notFound. Frame links and replacements are left out; get one render for them.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderIdsRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RenderIdsRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/RenderIdsRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderBulkDto"}}}}}}},"/v1/renders/cancel":{"post":{"tags":["Renders"],"summary":"Cancel many renders","description":"Cancels up to 1,000 queued or running renders, refunding them like cancelling each one. Returns the renders as they are now, without frame links or replacements; ids that are not this workspace\u0027s renders are listed in notFound.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderIdsRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RenderIdsRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/RenderIdsRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderBulkDto"}}}}}}},"/v1/renders/download-archive":{"post":{"tags":["Renders"],"summary":"Create a download archive","description":"Queues one ZIP of up to 1,000 succeeded MP4 or HLS renders, each under its download file name. Get the archive until its status is ready for the download URL. Archives are kept for 24 hours. At most 10 archives per workspace wait or build at once (409 archive_limit).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRenderArchiveRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateRenderArchiveRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/CreateRenderArchiveRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderArchiveDto"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/renders/download-archive/{archiveId}":{"get":{"tags":["Renders"],"summary":"Get a download archive","description":"Status (queued, building, ready or failed) and, once ready, a download URL valid for up to an hour. Send Prefer: wait=N (at most 50) to hold the answer until the archive is ready or failed, or N seconds pass.","parameters":[{"name":"archiveId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Prefer","in":"header","schema":{"type":"string"},"example":"wait=50"}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderArchiveDto"}}}}}}},"/v1/renders/{renderId}":{"get":{"tags":["Renders"],"summary":"Get a render","description":"Status and, once succeeded, download links valid for an hour. A running HLS render whose playback is streaming already has a playable hlsUrl. This is the only response that includes frameUrls; lists and webhooks leave them out. Webhooks also leave out hlsUrl. replacements, as sent, appear only here and in the answer to creating the render; lists, statuses, cancels, batches and webhooks leave them out. Send Prefer: wait=N (at most 50) to hold the answer until the render finishes or N seconds pass.","parameters":[{"name":"renderId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Prefer","in":"header","schema":{"type":"string"},"example":"wait=50"}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderDto"}}}}}},"delete":{"tags":["Renders"],"summary":"Delete a render","description":"Deletes a finished render and its output files. Cancel queued or running renders first.","parameters":[{"name":"renderId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"204":{"description":"No Content","content":{"application/json":{}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/renders/{renderId}/cancel":{"post":{"tags":["Renders"],"summary":"Cancel a render","description":"Stops a queued or running render and refunds it, unless it is an HLS render that already started streaming or the balance has been reset since it was queued. A render that already succeeded or failed answers 409 render_finished. The answer leaves out the render\u0027s replacements.","parameters":[{"name":"renderId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderDto"}}}}}}},"/v1/renders/{renderId}/html":{"get":{"tags":["Renders"],"summary":"Export an HTML5 ad","description":"Packages a succeeded MP4 or HLS render for an ad network and returns a download URL. platform is generic unless named. adform, appLovin and unityAds require clickUrl, where a tap or click goes. interaction is video (the ad plays) or tapToContinue (it asks for a tap first); playable networks (appLovin, unityAds, googleAppCampaigns, meta, tikTok, pangle, mintegral, moloco, liftoff) require tapToContinue, their default. The whole ad must be under 5 MB; for theTradeDesk the video must be below 1.1 MB, or at most 2.2 MB with tapToContinue. Render at a lower quality for longer videos.","parameters":[{"name":"renderId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"platform","in":"query","schema":{"default":"generic","$ref":"#/components/schemas/HtmlAdPlatform"}},{"name":"interaction","in":"query","schema":{"$ref":"#/components/schemas/HtmlAdInteraction"}},{"name":"clickUrl","in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HtmlAdDto"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{projectId}/share-links":{"post":{"tags":["Share links"],"summary":"Create a share link","description":"Creates a public page that plays the head of a variation (variation, or main when it is left out), or the pinned versionId, at one quality. A link that follows a variation names it in variation, and is deleted with the variation. It plays a plain succeeded render of that version and quality (no name, the version\u0027s own soundtrack, the plan\u0027s watermark). Opening the page renders nothing; without such a render, the first visitor to press Play renders it once in your workspace. After two failed or cancelled renders it stops rendering until you render the version yourself or create a new link. At most 50 links per project.","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShareLinkRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateShareLinkRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/CreateShareLinkRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareLinkDto"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"tags":["Share links"],"summary":"List share links","description":"The project\u0027s share links, oldest first.","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfShareLinkDto"}}}}}}},"/v1/share-links/{linkId}":{"delete":{"tags":["Share links"],"summary":"Delete a share link","description":"Revokes the link: its page answers 404 from now on. Renders it made stay in your workspace.","parameters":[{"name":"linkId","in":"path","required":true,"schema":{"type":"string"},"example":"Xk3v9QmT2bLr8ZpWc5NdYa"}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"204":{"description":"No Content","content":{"application/json":{}}}}}},"/v1/uploads":{"post":{"tags":["Uploads"],"summary":"Create an upload","description":"fileName must have a supported file extension, or .zip for a project ZIP; its kind\u0027s size limit applies (413 too_large). Up to 100 MB: one presigned PUT URL, valid 1 hour. Above 100 MB (up to 8 GB): a multipart upload with a presigned URL per 64 MB part; PUT each part and keep each response\u0027s ETag. Multipart uploads stay open 24 hours; part URLs last 1 hour and can be issued again. Each URL accepts exactly its declared number of bytes. Then complete the upload, and use its id once: in an edit, a new project, a ZIP import, or a replacement\u0027s file in a render or batch render. A workspace can hold 100 unused uploads; another gets 409 upload_limit. sizeBytes over the plan\u0027s project size (limits.maxProjectBytes in the usage) is refused with 403 project_too_large, except for a ZIP, which its import checks.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUploadRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateUploadRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/CreateUploadRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDto"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/uploads/{uploadId}":{"get":{"tags":["Uploads"],"summary":"Get an upload","description":"status: open (bytes not completed yet), processing (being checked), ready (an edit, a new project, an import or a render\u0027s replacement can use it) or failed (error says why). Send Prefer: wait=N (at most 50) to hold the answer while the upload is processing, up to N seconds.","parameters":[{"name":"uploadId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Prefer","in":"header","schema":{"type":"string"},"example":"wait=50"}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDto"}}}}}},"delete":{"tags":["Uploads"],"summary":"Abort an upload","description":"Discards an upload you no longer need, including the parts of an open multipart upload.","parameters":[{"name":"uploadId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"204":{"description":"No Content","content":{"application/json":{}}}}}},"/v1/uploads/{uploadId}/parts":{"post":{"tags":["Uploads"],"summary":"Issue part URLs again","description":"Fresh 1-hour URLs for the listed partNumbers of an open multipart upload, or for every part when partNumbers or the whole body is left out. Use it to resume.","parameters":[{"name":"uploadId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/UploadPartsRequest"}]}},"text/json":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/UploadPartsRequest"}]}},"application/*\u002Bjson":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/UploadPartsRequest"}]}}}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipartDto"}}}}}}},"/v1/uploads/{uploadId}/complete":{"post":{"tags":["Uploads"],"summary":"Complete an upload","description":"Every upload is completed once its bytes are in place: a single PUT with no body, a multipart upload with every part\u0027s number and the ETag its PUT returned. The upload is then processing while Blitframe checks it, and ready for an edit, a new project, an import or a render\u0027s replacement when that is done; a ZIP is ready at once, since its import checks it. Send Prefer: wait=N (at most 50) to hold the answer until the upload is ready or failed, or N seconds pass. Completing again is harmless: it answers the upload as it is, and resumes one that failed with interrupted, up to three checks in all; after that it fails with check_limit and the file must be uploaded again.","parameters":[{"name":"uploadId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Prefer","in":"header","schema":{"type":"string"},"example":"wait=50"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CompleteUploadRequest"}]}},"text/json":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CompleteUploadRequest"}]}},"application/*\u002Bjson":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CompleteUploadRequest"}]}}}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDto"}}}}}}},"/v1/files/capabilities":{"get":{"tags":["Uploads"],"summary":"Get file capabilities","description":"Each supported file extension with its kind, content type, size limit, dimension and duration limits and suggested folder, plus the upload, ZIP and edit limits. Cache it for up to 5 minutes; the server checks every file when you send it.","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileCapabilitiesDto"}}}}}}},"/v1/usage":{"get":{"tags":["Workspace"],"summary":"Get usage","description":"Plan, remaining render seconds, period end, trial state and the workspace\u0027s limits: longest video, largest resolution, watermark, API requests per minute, and whether custom limits apply in place of the plan\u0027s.","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageDto"}}}}}}},"/v1/projects/{projectId}/variations":{"get":{"tags":["Projects"],"summary":"List variations","description":"The project\u0027s variations, main first, then by name, each with its head version (null only for main while the project is empty). A project has at most 100.","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfVariationDto"}}}}}},"post":{"tags":["Projects"],"summary":"Create a variation","description":"Creates a variation whose head is fromVersionId (any version of this project), or the head of fromVariation, or main\u0027s head when both are left out; the project must have a version. name is 1 to 100 characters: letters, digits, \u0027-\u0027, \u0027_\u0027 or \u0027.\u0027, starting with a letter or digit, kept in lower case. A name the project already has is 409 variation_exists; past 100 variations, main included, 409 variation_limit. A fromVersionId larger than the plan\u0027s project size and than every head of the project, such as a render\u0027s own version made larger by its replacements, is 403 project_too_large. Send an Idempotency-Key header (1 to 200 characters) to make retries safe: for 24 hours the same request with the same key answers with what the first one made, with the header Idempotent-Replayed: true; the same key with a different request is 422 idempotency_key_reused while what the first one made exists, and while the first request is still running 409 idempotency_key_in_use, except that the retry of a ZIP import waits for that import, as the first request does. A request that failed made nothing, so it can be sent again with its key.","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","description":"Optional. A unique key you choose for this one request, 1 to 200 characters, such as a new UUID. Send the same key again only to retry this request after a lost answer: the retry answers with what the first one made instead of doing it again. Use a new key for every other request; the key in the samples is only an example.","schema":{"type":"string"},"example":"05a54079-a200-0def-96cc-7bc9e4c2543a"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVariationRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateVariationRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/CreateVariationRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariationDto"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{projectId}/variations/{name}":{"get":{"tags":["Projects"],"summary":"Get a variation","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"},"example":"spanish"}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariationDto"}}}}}},"delete":{"tags":["Projects"],"summary":"Delete a variation","description":"Deletes the variation, never its versions: renders, exports and share links pinned to them keep working. Share links that follow the variation\u0027s head are deleted with it. main cannot be deleted (400).","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"},"example":"spanish"}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"204":{"description":"No Content","content":{"application/json":{}}}}}},"/v1/projects/{projectId}/versions":{"get":{"tags":["Projects"],"summary":"List version history","description":"Follows parent links from the head of a variation, newest first: variation, or main when it is left out. Pass next as before to page.","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"variation","in":"query","schema":{"type":"string"},"example":"spanish"},{"name":"limit","in":"query","schema":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32","default":50}},{"name":"before","in":"query","schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfVersionDto"}}}}}},"post":{"tags":["Projects"],"summary":"Edit a project","description":"Adds, replaces or deletes files, or replaces layers, on top of the head of a variation (variation, or main when it is left out), as a new version that becomes that variation\u0027s head. With expectedHeadVersionId, the head must still be that version (409 head_moved otherwise); without it, the change applies to whatever the head is, and is made again on a newer head when another change lands first (409 head_moved after three tries). Each file has content, contentBase64, uploadId or fromVersionId (copies that version\u0027s file at fromPath, which defaults to path, from any version of the workspace; the file type must stay the same, and the root data.json copies only to and from another root data.json). An uploadId must name a ready upload whose fileName has the path\u0027s extension: one not completed is 409 upload_incomplete, one still being checked 409 upload_processing (naming every such upload, with Retry-After), and a failed one 409 upload_failed (giving the upload\u0027s own error). name optionally labels the version (at most 200 characters). restoreFromVersionId starts from any version of the project instead of the head, which undoes later changes. A request that adds a font file needs fontLicenseAccepted true (400 font_license_required otherwise). An edit that leaves the files, soundtrack and text fitting baseline as the head has them creates no version: the answer is 200 with the head. It still creates one when the head has problems (the files are checked again), when it gives a name other than the head\u0027s, or when it names an upload. An edit sent again after it used its uploads answers 200 with the version it made, with Idempotent-Replayed: true, when the body is the same. A version whose files would total more than the plan\u0027s project size (limits.maxProjectBytes in the usage) is refused with 403 project_too_large; one already larger may stay that size or shrink. Send an Idempotency-Key header (1 to 200 characters) to make retries safe: for 24 hours the same request with the same key answers with what the first one made, with the header Idempotent-Replayed: true; the same key with a different request is 422 idempotency_key_reused while what the first one made exists, and while the first request is still running 409 idempotency_key_in_use, except that the retry of a ZIP import waits for that import, as the first request does. A request that failed made nothing, so it can be sent again with its key.","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","description":"Optional. A unique key you choose for this one request, 1 to 200 characters, such as a new UUID. Send the same key again only to retry this request after a lost answer: the retry answers with what the first one made instead of doing it again. Use a new key for every other request; the key in the samples is only an example.","schema":{"type":"string"},"example":"7d36583c-7cfe-784c-08d2-148fa0e34888"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditProjectRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/EditProjectRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/EditProjectRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionDto"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionDto"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/versions/{versionId}":{"get":{"tags":["Projects"],"summary":"Get a version","description":"Files, composition details, renderable, problems and warnings.","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionDto"}}}}}}},"/v1/versions/{versionId}/files/{path}":{"get":{"tags":["Projects"],"summary":"Download a file","description":"Redirects to a short-lived download URL for one file of the version.","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"path","in":"path","required":true,"schema":{"type":"string"},"example":"images/logo.png"}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"302":{"description":"Found","content":{"application/json":{}}}}}},"/v1/versions/{versionId}/export":{"post":{"tags":["Projects"],"summary":"Export a version as ZIP","description":"Queues a ZIP of every file in the version, up to 8 GB in total. Get the export until its status is ready for the download URL. A renderable version\u0027s text fitting is baked into the exported data.json and text_fitting.json is left out, so the ZIP renders like the version but no longer carries the fitting rules. A request while an export of the same version is queued, building, or ready with more than an hour left before it expires returns that export. Exports are kept for 24 hours. At most 10 exports per workspace wait or build at once (409 export_limit). The ZIP can be imported again into a new project with zipUploadId, or into an existing one.","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionExportDto"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/versions/{versionId}/export/{exportId}":{"get":{"tags":["Projects"],"summary":"Get a version export","description":"Status (queued, building, ready or failed) and, once ready, a download URL valid for up to an hour. Send Prefer: wait=N (at most 50) to hold the answer until the export is ready or failed, or N seconds pass.","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"exportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Prefer","in":"header","schema":{"type":"string"},"example":"wait=50"}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionExportDto"}}}}}}},"/v1/webhooks":{"get":{"tags":["Webhooks"],"summary":"List webhook endpoints","description":"Every endpoint of the workspace, oldest first. Secrets are never listed.","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfWebhookDto"}}}}}},"post":{"tags":["Webhooks"],"summary":"Add a webhook endpoint","description":"url is an HTTPS URL on port 443 at a public address, without credentials, at most 2,048 characters. Leave out events to receive every event type, including ones added later (allEvents is then true). The response includes the signing secret (whsec_\u2026) once; requests are signed per Standard Webhooks. A workspace has at most 10 endpoints (409 webhook_limit) and adds or repoints them at most 20 times an hour (429 rate_limited). Its owners and admins are emailed which endpoint was added and by whom.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDto"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/{webhookId}":{"get":{"tags":["Webhooks"],"summary":"Get a webhook endpoint","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDto"}}}}}},"patch":{"tags":["Webhooks"],"summary":"Update a webhook endpoint","description":"Changes url, events, enabled or description; a field you leave out is kept. Send description as an empty string to clear it. A new url follows the same rules as when the endpoint was added, counts toward the 20 adds or repoints a workspace makes an hour (429 rate_limited), and is emailed to the workspace\u0027s owners and admins. Send allEvents: true instead of events to receive every event type again, including ones added later. Disabling stops queued retries; enabling again clears disabledReason.","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookRequest"}},"application/*\u002Bjson":{"schema":{"$ref":"#/components/schemas/UpdateWebhookRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDto"}}}}}},"delete":{"tags":["Webhooks"],"summary":"Delete a webhook endpoint","description":"Removes the endpoint with its queued deliveries and delivery log.","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"204":{"description":"No Content","content":{"application/json":{}}}}}},"/v1/webhooks/{webhookId}/rotate-secret":{"post":{"tags":["Webhooks"],"summary":"Rotate the signing secret","description":"Returns the new secret once. For gracePeriodSeconds (0 to 86,400, default 86,400) every request is signed with both the new and the previous secret, then only the new one. Send 0 to stop signing with the previous secret at once, for example after it leaked.","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/RotateWebhookSecretRequest"}]}},"text/json":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/RotateWebhookSecretRequest"}]}},"application/*\u002Bjson":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/RotateWebhookSecretRequest"}]}}}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSecretDto"}}}}}}},"/v1/webhooks/{webhookId}/deliveries":{"get":{"tags":["Webhooks"],"summary":"List deliveries","description":"The endpoint\u0027s deliveries of the last 30 days, newest first. Pass next as before for older ones.","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","schema":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32","default":50}},{"name":"before","in":"query","schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfWebhookDeliveryDto"}}}}}}},"/v1/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver":{"post":{"tags":["Webhooks"],"summary":"Redeliver an event","description":"Queues the delivery\u0027s event again as a new delivery with the same webhook-id, so receivers that deduplicate still see one event. An endpoint takes at most 30 test events and redeliveries an hour, and none while 100 of its deliveries are waiting (429 rate_limited).","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"deliveryId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryDto"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/{webhookId}/test":{"post":{"tags":["Webhooks"],"summary":"Send a test event","description":"Queues a webhook.test event for the endpoint, whatever event types it picked. It is signed, logged and retried like any other event. The endpoint must be enabled. An endpoint takes at most 30 test events and redeliveries an hour, and none while 100 of its deliveries are waiting (429 rate_limited).","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryDto"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhooks/{webhookId}/recover":{"post":{"tags":["Webhooks"],"summary":"Resend missed events","description":"Queues again, once each, the events in the delivery log that never reached the endpoint, logged at or after since (leave it out for the whole 30-day log). Each keeps its webhook-id. The endpoint must be enabled.","parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/RecoverWebhookRequest"}]}},"text/json":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/RecoverWebhookRequest"}]}},"application/*\u002Bjson":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/RecoverWebhookRequest"}]}}}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRecoveryDto"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"ApiError":{"required":["code","message"],"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}},"ApiKeyDto":{"required":["id","name","prefix","createdAt","lastUsedAt","expiresAt","createdBy","creatorLeft"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"prefix":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":["null","string"],"format":"date-time"},"expiresAt":{"type":["null","string"],"format":"date-time"},"createdBy":{"type":["null","string"]},"creatorLeft":{"type":"boolean"}}},"AudioTrack":{"examples":[{"path":"audio/music.mp3","offsetSeconds":0}],"required":["path"],"type":"object","properties":{"path":{"type":"string"},"offsetSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$","type":["number","string"],"format":"double","default":0}}},"BlobKind":{"enum":["composition","json","image","video","audio","font","model"]},"CompletedPart":{"required":["partNumber","etag"],"type":"object","properties":{"partNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"etag":{"type":["null","string"]}}},"CompleteUploadRequest":{"examples":[{"parts":[{"partNumber":1,"etag":"\u00225d41402abc4b2a76\u0022"},{"partNumber":2,"etag":"\u00227c2b8e3f1a9d4c6b\u0022"}]}],"type":"object","properties":{"parts":{"type":["null","array"],"items":{"$ref":"#/components/schemas/CompletedPart"}}}},"CompositionDto":{"required":["width","height","frameRate","durationSeconds","frameCount"],"type":"object","properties":{"width":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"height":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"frameRate":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$","type":["number","string"],"format":"double"},"durationSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$","type":["number","string"],"format":"double"},"frameCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}},"CompositionFontDto":{"required":["name","family","style","source"],"type":"object","properties":{"name":{"type":"string"},"family":{"type":"string"},"style":{"type":"string"},"source":{"$ref":"#/components/schemas/FontSource"}}},"CreateProblemReportRequest":{"examples":[{"renderId":"0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f","message":"The logo flickers between 0:03 and 0:05."}],"required":["message"],"type":"object","properties":{"message":{"type":["null","string"]},"renderId":{"type":["null","string"],"format":"uuid"},"versionId":{"type":["null","string"],"format":"uuid"}}},"CreateProjectRequest":{"examples":[{"name":"Summer sale"}],"required":["name"],"type":"object","properties":{"name":{"type":"string"},"zipUploadId":{"type":["null","string"],"format":"uuid"},"fromVersionId":{"type":["null","string"],"format":"uuid"},"fontLicenseAccepted":{"type":"boolean","default":false}}},"CreateRenderArchiveRequest":{"examples":[{"renderIds":["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f","1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"],"name":"Summer campaign"}],"required":["renderIds"],"type":"object","properties":{"renderIds":{"type":["null","array"],"items":{"type":"string","format":"uuid"}},"name":{"type":["null","string"]}}},"CreateRenderBatchRequest":{"examples":[{"versionId":"5c3d7a8e-2f41-4b6a-9d10-7e2f5a9c1b34","renders":[{"format":"mp4","name":"Spanish","replacements":[{"layer":"/layers/0","text":"Rebajas de verano"}]},{"format":"hls","quality":"medium"}]}],"type":"object","properties":{"versionId":{"type":["null","string"],"format":"uuid"},"renders":{"type":["null","array"],"items":{"$ref":"#/components/schemas/RenderBatchItem"}},"variation":{"type":["null","string"]}}},"CreateRenderRequest":{"examples":[{"projectId":"3f9b2c1d-8e4a-4d7b-b6c5-2a1e0f9d8c7b","format":"mp4","quality":"high"}],"type":"object","properties":{"projectId":{"type":["null","string"],"format":"uuid"},"versionId":{"type":["null","string"],"format":"uuid"},"format":{"$ref":"#/components/schemas/RenderFormat"},"quality":{"$ref":"#/components/schemas/RenderQuality"},"frames":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/FrameRange"}]},"audio":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/AudioTrack"}]},"name":{"type":["null","string"]},"replacements":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Replacement"}},"variation":{"type":["null","string"]},"codec":{"$ref":"#/components/schemas/VideoCodec"},"encoding":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/RenderEncoding"}]}}},"CreateShareLinkRequest":{"examples":[{"quality":"high"}],"type":"object","properties":{"quality":{"$ref":"#/components/schemas/RenderQuality"},"versionId":{"type":["null","string"],"format":"uuid"},"variation":{"type":["null","string"]}}},"CreateUploadRequest":{"examples":[{"fileName":"background.mp4","sizeBytes":48211933}],"required":["fileName","sizeBytes"],"type":"object","properties":{"fileName":{"type":"string"},"sizeBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"}}},"CreateVariationRequest":{"examples":[{"name":"spanish","fromVariation":"main"}],"required":["name"],"type":"object","properties":{"name":{"type":"string"},"fromVersionId":{"type":["null","string"],"format":"uuid"},"fromVariation":{"type":["null","string"]}}},"CreateWebhookRequest":{"examples":[{"url":"https://example.com/blitframe-webhook","events":["render.succeeded","render.failed"],"description":"Production"}],"required":["url"],"type":"object","properties":{"url":{"type":"string"},"events":{"type":["null","array"],"items":{"$ref":"#/components/schemas/WebhookEventType"}},"description":{"type":["null","string"]}}},"EditFile":{"examples":[{"path":"images/logo.png","uploadId":"8a1f0c2e-6b3d-4e59-a7c4-1d2e3f4a5b6c"}],"required":["path"],"type":"object","properties":{"path":{"type":"string"},"content":{"type":["null","string"]},"contentBase64":{"type":["null","string"]},"uploadId":{"type":["null","string"],"format":"uuid"},"fromVersionId":{"type":["null","string"],"format":"uuid"},"fromPath":{"type":["null","string"]}}},"EditProjectRequest":{"examples":[{"expectedHeadVersionId":"5c3d7a8e-2f41-4b6a-9d10-7e2f5a9c1b34","message":"Change the headline","files":[{"path":"data.json","content":"{\u0022v\u0022:\u00225.12.2\u0022,\u0022nm\u0022:\u0022Summer sale\u0022,\u0022fr\u0022:30,\u0022ip\u0022:0,\u0022op\u0022:150,\u0022w\u0022:1920,\u0022h\u0022:1080,\u0022assets\u0022:[],\u0022layers\u0022:[]}"},{"path":"images/logo.png","contentBase64":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk\u002BM9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="}],"delete":["images/old-logo.png"]}],"type":"object","properties":{"expectedHeadVersionId":{"type":["null","string"],"format":"uuid"},"message":{"type":["null","string"]},"files":{"type":["null","array"],"items":{"$ref":"#/components/schemas/EditFile"}},"delete":{"type":["null","array"],"items":{"type":"string"}},"restoreFromVersionId":{"type":["null","string"],"format":"uuid"},"name":{"type":["null","string"]},"fontLicenseAccepted":{"type":"boolean","default":false},"soundtrack":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/AudioTrack"}]},"textFittingBaselineVersionId":{"type":["null","string"],"format":"uuid"},"replacements":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Replacement"}},"variation":{"type":["null","string"]}}},"ErrorResponse":{"required":["error"],"type":"object","properties":{"error":{"$ref":"#/components/schemas/ApiError"}}},"FileCapabilitiesDto":{"required":["upload","zip","maxFilesPerVersion","maxInlineEditBytes","compositionPath","textFittingPath","files"],"type":"object","properties":{"upload":{"$ref":"#/components/schemas/UploadCapabilities"},"zip":{"$ref":"#/components/schemas/ZipCapabilities"},"maxFilesPerVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"maxInlineEditBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"compositionPath":{"type":"string"},"textFittingPath":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/FileTypeCapability"}}}},"FileDto":{"required":["path","sizeBytes","contentType","sha256"],"type":"object","properties":{"path":{"type":"string"},"sizeBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"contentType":{"type":"string"},"sha256":{"type":"string"}}},"FileTypeCapability":{"required":["extension","kind","contentType","maxSizeBytes","defaultFolder"],"type":"object","properties":{"extension":{"type":"string"},"kind":{"$ref":"#/components/schemas/BlobKind"},"contentType":{"type":"string"},"maxSizeBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"defaultFolder":{"type":"string"},"maxWidth":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"maxHeight":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"maxDurationSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$","type":["null","number","string"],"format":"double"},"fontLicenseRequired":{"type":"boolean","default":false}}},"FontDeclaration":{"required":["fName","fFamily","fStyle"],"type":"object","properties":{"fName":{"type":"string"},"fFamily":{"type":"string"},"fStyle":{"type":"string"}}},"FontDto":{"required":["family","style","slug","declaration","license","previewUrl"],"type":"object","properties":{"family":{"type":"string"},"style":{"type":"string"},"slug":{"type":"string"},"declaration":{"$ref":"#/components/schemas/FontDeclaration"},"license":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/FontLicense"}]},"previewUrl":{"type":["null","string"]}}},"FontLicense":{"enum":["ofl","apache","ufl"]},"FontSource":{"enum":["project","library","missing"]},"FrameFormat":{"enum":["png","jpeg","tga"],"default":"png"},"FrameRange":{"examples":[{"start":0,"end":30,"format":"png"}],"required":["start","end"],"type":"object","properties":{"start":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"end":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"format":{"$ref":"#/components/schemas/FrameFormat"}}},"H264Profile":{"enum":["baseline","main","high"]},"HtmlAdDto":{"required":["url"],"type":"object","properties":{"url":{"type":"string"}}},"HtmlAdInteraction":{"enum":["video","tapToContinue"]},"HtmlAdPlatform":{"enum":["generic","googleCampaignManager360","googleDisplayVideo360","theTradeDesk","adform","appLovin","unityAds","googleAppCampaigns","meta","tikTok","pangle","mintegral","moloco","liftoff"]},"ImportPackageRequest":{"examples":[{"zipUploadId":"8a1f0c2e-6b3d-4e59-a7c4-1d2e3f4a5b6c","expectedHeadVersionId":"5c3d7a8e-2f41-4b6a-9d10-7e2f5a9c1b34","fontLicenseAccepted":true}],"required":["zipUploadId"],"type":"object","properties":{"zipUploadId":{"type":["null","string"],"format":"uuid"},"expectedHeadVersionId":{"type":["null","string"],"format":"uuid"},"fontLicenseAccepted":{"type":"boolean","default":false},"variation":{"type":["null","string"]}}},"LayersDto":{"required":["width","height","textLayers","imageLayers","videoLayers","fonts","audioFiles","soundtrack"],"type":"object","properties":{"width":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"height":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"textLayers":{"type":"array","items":{"$ref":"#/components/schemas/TextLayerDto"}},"imageLayers":{"type":"array","items":{"$ref":"#/components/schemas/MediaLayerDto"}},"videoLayers":{"type":"array","items":{"$ref":"#/components/schemas/MediaLayerDto"}},"fonts":{"type":"array","items":{"$ref":"#/components/schemas/CompositionFontDto"}},"audioFiles":{"type":"array","items":{"type":"string"}},"soundtrack":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/AudioTrack"}]}}},"MediaFit":{"enum":["contain","cover"]},"MediaLayerDto":{"required":["layer","name","assetId","path","width","height"],"type":"object","properties":{"layer":{"type":"string"},"name":{"type":["null","string"]},"assetId":{"type":"string"},"path":{"type":["null","string"]},"width":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"height":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}},"MultipartDto":{"required":["partSize","partCount","urlsExpireAt","parts"],"type":"object","properties":{"partSize":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"partCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"urlsExpireAt":{"type":"string","format":"date-time"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/UploadPartDto"}}}},"PageOfApiKeyDto":{"required":["items","next"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyDto"}},"next":{"type":["null","string"]}}},"PageOfFontDto":{"required":["items","next"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FontDto"}},"next":{"type":["null","string"]}}},"PageOfProjectDto":{"required":["items","next"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProjectDto"}},"next":{"type":["null","string"]}}},"PageOfProjectFileDto":{"required":["items","next"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProjectFileDto"}},"next":{"type":["null","string"]}}},"PageOfRenderDto":{"required":["items","next"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RenderDto"}},"next":{"type":["null","string"]}}},"PageOfShareLinkDto":{"required":["items","next"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ShareLinkDto"}},"next":{"type":["null","string"]}}},"PageOfVariationDto":{"required":["items","next"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/VariationDto"}},"next":{"type":["null","string"]}}},"PageOfVersionDto":{"required":["items","next"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/VersionDto"}},"next":{"type":["null","string"]}}},"PageOfWebhookDeliveryDto":{"required":["items","next"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDeliveryDto"}},"next":{"type":["null","string"]}}},"PageOfWebhookDto":{"required":["items","next"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDto"}},"next":{"type":["null","string"]}}},"PlanLimitsDto":{"required":["maxDurationSeconds","maxLongEdge","maxShortEdge","watermark","requestsPerMinute","custom","customUntil","maxStorageBytes","maxProjectBytes","monthlyDownloadBytes","shareLinks","advancedEncoding","priorityRendering"],"type":"object","properties":{"maxDurationSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"maxLongEdge":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"maxShortEdge":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"watermark":{"type":"boolean"},"requestsPerMinute":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"custom":{"type":"boolean"},"customUntil":{"type":["null","string"],"format":"date-time"},"maxStorageBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"maxProjectBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"monthlyDownloadBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"shareLinks":{"type":"boolean"},"advancedEncoding":{"type":"boolean"},"priorityRendering":{"type":"boolean"}}},"PlaybackState":{"enum":["preparing","streaming","complete"]},"ProblemReportDto":{"required":["id","renderId","versionId","message","status","createdAt","resolvedAt","resolution"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"renderId":{"type":["null","string"],"format":"uuid"},"versionId":{"type":["null","string"],"format":"uuid"},"message":{"type":"string"},"status":{"$ref":"#/components/schemas/ProblemReportStatus"},"createdAt":{"type":"string","format":"date-time"},"resolvedAt":{"type":["null","string"],"format":"date-time"},"resolution":{"type":["null","string"]}}},"ProblemReportStatus":{"enum":["open","resolved"]},"ProjectDto":{"required":["id","name","createdAt","headVersionId","renderable","copiedFromVersionId"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"headVersionId":{"type":["null","string"],"format":"uuid"},"renderable":{"type":["null","boolean"]},"copiedFromVersionId":{"type":["null","string"],"format":"uuid"},"thumbnailUrl":{"type":["null","string"]}}},"ProjectFileDto":{"required":["path","kind","sizeBytes","contentType","sha256","versionId","versionNumber"],"type":"object","properties":{"path":{"type":"string"},"kind":{"$ref":"#/components/schemas/BlobKind"},"sizeBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"contentType":{"type":"string"},"sha256":{"type":"string"},"versionId":{"type":"string","format":"uuid"},"versionNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}},"RateControl":{"enum":["quality","vbr","cbr"]},"RecoverWebhookRequest":{"type":"object","properties":{"since":{"type":["null","string"],"format":"date-time"}}},"RenameRequest":{"examples":[{"name":"Summer sale 2026"}],"required":["name"],"type":"object","properties":{"name":{"type":"string"}}},"RenderArchiveDto":{"required":["id","status","renderIds","fileName","url","sizeBytes","error","createdAt","finishedAt","expiresAt"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/RenderArchiveStatus"},"renderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"fileName":{"type":"string"},"url":{"type":["null","string"]},"sizeBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"error":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ApiError"}]},"createdAt":{"type":"string","format":"date-time"},"finishedAt":{"type":["null","string"],"format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}}},"RenderArchiveStatus":{"enum":["queued","building","ready","failed"]},"RenderBatchDto":{"required":["versionId","renders"],"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"renders":{"type":"array","items":{"$ref":"#/components/schemas/RenderDto"}}}},"RenderBatchItem":{"examples":[{"format":"mp4","quality":"high","name":"Spanish","replacements":[{"layer":"/layers/0","text":"Rebajas de verano"}]}],"type":"object","properties":{"format":{"$ref":"#/components/schemas/RenderFormat"},"quality":{"$ref":"#/components/schemas/RenderQuality"},"frames":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/FrameRange"}]},"audio":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/AudioTrack"}]},"name":{"type":["null","string"]},"replacements":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Replacement"}},"codec":{"$ref":"#/components/schemas/VideoCodec"},"encoding":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/RenderEncoding"}]}}},"RenderBulkDto":{"required":["renders","notFound"],"type":"object","properties":{"renders":{"type":"array","items":{"$ref":"#/components/schemas/RenderDto"}},"notFound":{"type":"array","items":{"type":"string","format":"uuid"}}}},"RenderDto":{"required":["id","projectId","versionId","sourceVersionId","format","quality","frames","audio","status","error","chargedSeconds","refundedSeconds","createdAt","startedAt","finishedAt","output"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","format":"uuid"},"versionId":{"type":["null","string"],"format":"uuid"},"sourceVersionId":{"type":"string","format":"uuid"},"format":{"$ref":"#/components/schemas/RenderFormat"},"quality":{"$ref":"#/components/schemas/RenderQuality"},"frames":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/FrameRange"}]},"audio":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/AudioTrack"}]},"status":{"$ref":"#/components/schemas/RenderStatus"},"error":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ApiError"}]},"chargedSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"refundedSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"createdAt":{"type":"string","format":"date-time"},"startedAt":{"type":["null","string"],"format":"date-time"},"finishedAt":{"type":["null","string"],"format":"date-time"},"output":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/RenderOutputDto"}]},"name":{"type":["null","string"]},"playback":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/PlaybackState"}]},"replacements":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Replacement"},"description":"The replacements the render was created with. Left out unless one render is read: only the answer to creating a render and \u0060GET /v1/renders/{renderId}\u0060 carry it, and only for a render with replacements."},"codec":{"oneOf":[{"type":"null"},{"description":"The video codec of an mp4 or hls render: h264, hevc or av1. Left out for frames.","$ref":"#/components/schemas/VideoCodec"}]},"encoding":{"oneOf":[{"type":"null"},{"description":"The encoder settings the render asked for. Left out when its quality level set the bitrate.","$ref":"#/components/schemas/RenderEncoding"}]}}},"RenderEncoding":{"type":"object","properties":{"rateControl":{"$ref":"#/components/schemas/RateControl"},"bitrateKbps":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"maxBitrateKbps":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"keyframeIntervalSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$","type":["null","number","string"],"format":"double"},"h264Profile":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/H264Profile"}]}},"description":"Encoder settings a render asks for; without them its quality level sets a variable bitrate."},"RenderFormat":{"enum":["mp4","hls","frames"]},"RenderIdsRequest":{"examples":[{"renderIds":["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f","1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"]}],"required":["renderIds"],"type":"object","properties":{"renderIds":{"type":["null","array"],"items":{"type":"string","format":"uuid"}}}},"RenderOutputDto":{"required":["mp4Url","hlsUrl","frameUrls","expiresAt"],"type":"object","properties":{"mp4Url":{"type":["null","string"]},"hlsUrl":{"type":["null","string"]},"frameUrls":{"type":["null","array"],"items":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time"},"posterUrl":{"type":["null","string"]}}},"RenderQuality":{"enum":["low","medium","high","extraHigh"]},"RenderStatus":{"enum":["queued","rendering","succeeded","failed","cancelled"]},"Replacement":{"examples":[{"layer":"/layers/0","text":"Summer sale","font":"montserrat-bold"}],"required":["layer"],"type":"object","properties":{"layer":{"type":"string"},"text":{"type":["null","string"]},"font":{"type":["null","string"]},"path":{"type":["null","string"]},"file":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/EditFile"}]},"fit":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/MediaFit"}]}}},"RotateWebhookSecretRequest":{"examples":[{"gracePeriodSeconds":0}],"type":"object","properties":{"gracePeriodSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ShareLinkDto":{"required":["id","projectId","versionId","variation","quality","url","createdAt"],"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","format":"uuid"},"versionId":{"type":["null","string"],"format":"uuid"},"variation":{"type":["null","string"]},"quality":{"$ref":"#/components/schemas/RenderQuality"},"url":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"TextLayerDto":{"required":["layer","name","text","font","fontSize","textFit"],"type":"object","properties":{"layer":{"type":"string"},"name":{"type":["null","string"]},"text":{"type":"string"},"font":{"type":["null","string"]},"fontSize":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?(?:[eE][\u002B-]?\\d\u002B)?$","type":["null","number","string"],"format":"double"},"textFit":{"type":"boolean"}}},"UpdateWebhookRequest":{"examples":[{"events":["render.succeeded","download_archive.ready"],"enabled":true}],"type":"object","properties":{"url":{"type":["null","string"]},"events":{"type":["null","array"],"items":{"$ref":"#/components/schemas/WebhookEventType"}},"enabled":{"type":["null","boolean"]},"description":{"type":["null","string"]},"allEvents":{"type":["null","boolean"]}}},"UploadCapabilities":{"required":["maxSizeBytes","singlePutMaxBytes","multipartPartSizeBytes","singleUploadLifetimeSeconds","multipartUploadLifetimeSeconds","partUrlLifetimeSeconds"],"type":"object","properties":{"maxSizeBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"singlePutMaxBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"multipartPartSizeBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"singleUploadLifetimeSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"multipartUploadLifetimeSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"partUrlLifetimeSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}},"UploadDto":{"required":["id","status","url","method","expiresAt"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/UploadStatus"},"url":{"type":["null","string"]},"method":{"type":["null","string"]},"expiresAt":{"type":"string","format":"date-time"},"multipart":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/MultipartDto"}]},"error":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ApiError"}]}}},"UploadPartDto":{"required":["partNumber","url"],"type":"object","properties":{"partNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"url":{"type":"string"}}},"UploadPartsRequest":{"type":"object","properties":{"partNumbers":{"type":["null","array"],"items":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}}},"UploadStatus":{"enum":["open","processing","ready","failed"]},"UsageDto":{"required":["plan","renderSecondsRemaining","monthlyRenderSeconds","periodEndsAt","trial","planEnded","noTrial","limits"],"type":"object","properties":{"plan":{"type":"string"},"renderSecondsRemaining":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"monthlyRenderSeconds":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"periodEndsAt":{"type":"string","format":"date-time"},"trial":{"type":"boolean"},"planEnded":{"type":"boolean"},"noTrial":{"type":"boolean"},"limits":{"$ref":"#/components/schemas/PlanLimitsDto"},"storageBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64","default":0},"downloadBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64","default":0}}},"VariationDto":{"required":["name","headVersionId","createdAt"],"type":"object","properties":{"name":{"type":"string"},"headVersionId":{"type":["null","string"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"}}},"VersionDto":{"required":["id","projectId","parentVersionId","number","message","createdAt","composition","renderable","problems","warnings","soundtrack","textFittingBaselineVersionId","files","name"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","format":"uuid"},"parentVersionId":{"type":["null","string"],"format":"uuid"},"number":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"message":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"composition":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CompositionDto"}]},"renderable":{"type":"boolean"},"problems":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"soundtrack":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/AudioTrack"}]},"textFittingBaselineVersionId":{"type":["null","string"],"format":"uuid"},"files":{"type":["null","array"],"items":{"$ref":"#/components/schemas/FileDto"}},"name":{"type":["null","string"]}}},"VersionExportDto":{"required":["id","versionId","status","fileName","url","sizeBytes","error","createdAt","finishedAt","expiresAt"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/VersionExportStatus"},"fileName":{"type":"string"},"url":{"type":["null","string"]},"sizeBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"error":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ApiError"}]},"createdAt":{"type":"string","format":"date-time"},"finishedAt":{"type":["null","string"],"format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}}},"VersionExportStatus":{"enum":["queued","building","ready","failed"]},"VideoCodec":{"enum":["h264","hevc","av1"]},"WebhookDeliveryDto":{"required":["id","messageId","eventType","status","attempts","lastStatusCode","lastError","lastResponse","createdAt","lastAttemptAt","nextAttemptAt","deliveredAt"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"messageId":{"type":"string","format":"uuid"},"eventType":{"$ref":"#/components/schemas/WebhookEventType"},"status":{"$ref":"#/components/schemas/WebhookDeliveryStatus"},"attempts":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"lastStatusCode":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"lastError":{"type":["null","string"]},"lastResponse":{"type":["null","string"]},"createdAt":{"type":"string","format":"date-time"},"lastAttemptAt":{"type":["null","string"],"format":"date-time"},"nextAttemptAt":{"type":["null","string"],"format":"date-time"},"deliveredAt":{"type":["null","string"],"format":"date-time"}}},"WebhookDeliveryStatus":{"enum":["pending","delivered","failed"]},"WebhookDto":{"required":["id","url","description","allEvents","events","enabled","disabledReason","disabledAt","previousSecretExpiresAt","createdAt"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"url":{"type":"string"},"description":{"type":["null","string"]},"allEvents":{"type":"boolean"},"events":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEventType"}},"enabled":{"type":"boolean"},"disabledReason":{"type":["null","string"]},"disabledAt":{"type":["null","string"],"format":"date-time"},"previousSecretExpiresAt":{"type":["null","string"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"secret":{"type":["null","string"]}}},"WebhookEventType":{"enum":["render.succeeded","render.failed","render.cancelled","download_archive.ready","download_archive.failed","version_export.ready","version_export.failed","balance.low","webhook.test"]},"WebhookRecoveryDto":{"required":["queued"],"type":"object","properties":{"queued":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}},"WebhookSecretDto":{"required":["secret","previousSecretExpiresAt"],"type":"object","properties":{"secret":{"type":"string"},"previousSecretExpiresAt":{"type":["null","string"],"format":"date-time"}}},"ZipCapabilities":{"required":["maxFiles","maxUncompressedBytes","maxCompressionRatio"],"type":"object","properties":{"maxFiles":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"maxUncompressedBytes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"maxCompressionRatio":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}},"ZipImportDto":{"required":["id","projectId","status","versionId","error","createdAt","finishedAt"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/ZipImportStatus"},"versionId":{"type":["null","string"],"format":"uuid"},"error":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ApiError"}]},"createdAt":{"type":"string","format":"date-time"},"finishedAt":{"type":["null","string"],"format":"date-time"}}},"ZipImportStatus":{"enum":["queued","importing","succeeded","failed"]}},"securitySchemes":{"ApiKey":{"type":"http","description":"API key from the developer console.","scheme":"bearer","bearerFormat":"Blitframe API key"}}},"security":[{"ApiKey":[]}],"tags":[{"name":"API keys"},{"name":"Editing"},{"name":"Fonts"},{"name":"Problem reports"},{"name":"Projects"},{"name":"Renders"},{"name":"Share links"},{"name":"Uploads"},{"name":"Workspace"},{"name":"Webhooks"}]}