Create, edit, reframe, caption, organize, generate, and export short-form videos with BlitzReels.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Add an opening title card (hook) or generic text overlay to a project timeline. Defaults to classic white: black text on a white card.
UUID string.
Retry key. Reuse only with identical inputs.
title_card is an opening hook. overlay is generic on-video text.
Title-card size. Ignored for overlay.
Title-card look. classic_white is black text on a white card. Ignored for overlay.
Expected sequence revision, or null.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Tool list last changed Oct 25, 2026.
Add an opening title card (hook) or generic text overlay to a project timeline. Defaults to classic white: black text on a white card.
| Argument | Type | Description |
|---|---|---|
| kind | string | title_card is an opening hook. overlay is generic on-video text. |
| name | string | |
| size | string | Title-card size. Ignored for overlay. |
| text* | string | |
| theme | string | Title-card look. classic_white is black text on a white card. Ignored for overlay. |
| projectId* | string | UUID string. |
| layerIndex | integer | |
| startSeconds | number | |
| idempotencyKey* | string | Retry key. Reuse only with identical inputs. |
| durationSeconds | number | |
| expectedRevision | integer | Expected sequence revision, or null. |
{
"type": "object",
"required": [
"projectId",
"text",
"idempotencyKey"
],
"properties": {
"kind": {
"enum": [
"overlay",
"title_card"
],
"type": "string",
"default": "title_card",
"description": "title_card is an opening hook. overlay is generic on-video text."
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"size": {
"enum": [
"compact",
"default",
"bold"
],
"type": "string",
"default": "default",
"description": "Title-card size. Ignored for overlay."
},
"text": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"theme": {
"enum": [
"classic_white",
"legend_white",
"white_black_outline",
"stacked_black_white",
"red_on_black",
"black_on_yellow",
"red_block"
],
"type": "string",
"default": "classic_white",
"description": "Title-card look. classic_white is black text on a white card. Ignored for overlay."
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"layerIndex": {
"type": "integer",
"minimum": 0
},
"startSeconds": {
"type": "number",
"default": 0,
"minimum": 0
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8,
"description": "Retry key. Reuse only with identical inputs."
},
"durationSeconds": {
"type": "number",
"default": 4,
"maximum": 3600,
"minimum": 0,
"exclusiveMinimum": 0
},
"expectedRevision": {
"type": "integer",
"minimum": 0,
"description": "Expected sequence revision, or null."
}
},
"additionalProperties": false
}Add a timed transition effect, optionally attached to one timeline item and paired with sound.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| easing | string | |
| preset | string | |
| intensity | number | |
| projectId* | string | UUID string. |
| includeSfx | boolean | |
| layerIndex | integer | |
| startSeconds* | number | |
| idempotencyKey* | string | Retry key. Reuse only with identical inputs. |
| timelineItemId | string | |
| durationSeconds | number | |
Update timing, trim, layer, or state for up to 100 timeline items in one sequence transaction.
| Argument | Type | Description |
|---|---|---|
| updates* | array | Each update needs at least one field to change besides timelineItemId. |
| projectId* | string | UUID string. |
| idempotencyKey* | string | Retry key. Reuse only with identical inputs. |
| expectedRevision | integer | Expected sequence revision, or null. |
{
"type": "object",
"required": [
"projectId",
"updates",
"idempotencyKey"
],
"properties": {
"updates": {
"type": "array",
"items": {
"type": "object",
"required": [
"timelineItemId"
],
"properties": {
"ignored": {
"type": "boolean"
},
"layerIndex": {
"type": "integer",
"minimum": 0
},
"startSeconds": {
"type": "number",
"minimum": 0
},
"timelineItemId": {
"type": "string",
"format": "uuid"
},
"trimEndSeconds": {
"type": "number",
"minimum": 0
},
"durationSeconds": {
"type": "number",
"exclusiveMinimum": 0
},
"trimStartSeconds": {
"type": "number",
"minimum": 0
},
"blurredBackground": {
"type": "boolean"
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Each update needs at least one field to change besides timelineItemId."
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8,
"description": "Retry key. Reuse only with identical inputs."
},
"expectedRevision": {
"type": "integer",
"minimum": 0,
"description": "Expected sequence revision, or null."
}
},
"additionalProperties": false
}Apply a verified caption look to one project. Preserves word overrides unless clearWordOverrides=true. Existing captions are restyled; spoken audio is preserved.
| Argument | Type | Description |
|---|---|---|
| lookId* | string | null | |
| projectId* | string | null | UUID string. |
| workspaceId | string | UUID string. |
| idempotencyKey* | string | null | |
| clearWordOverrides | boolean |
{
"type": "object",
"required": [
"projectId",
"lookId",
"idempotencyKey"
],
"properties": {
"lookId": {
"type": [
"string",
"null"
],
"default": null
},
"projectId": {
"type": [
"string",
"null"
],
"format": "uuid",
"default": null,
"description": "UUID string."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"idempotencyKey": {
"type": [
"string",
"null"
],
"default": null
},
"clearWordOverrides": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}Restore editable project captions from the selected source's completed canonical transcript. Keeps the full recording and avoids duplicate captions on identical retries. Requires source transcription first; no-speech is an explicit successful state.
| Argument | Type | Description |
|---|---|---|
| assetId* | string | UUID string. |
| projectId* | string | UUID string. |
| workspaceId* | any | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"projectId",
"assetId"
],
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}List built-in caption looks and saved caption themes available to a workspace.
| Argument | Type | Description |
|---|---|---|
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| includeSavedThemes | boolean | Include saved workspace caption themes. |
| includeBuiltInLooks | boolean | Include built-in caption looks. |
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
},
"includeSavedThemes": {
"type": "boolean",
"default": true,
"description": "Include saved workspace caption themes."
},
"includeBuiltInLooks": {
"type": "boolean",
"default": true,
"description": "Include built-in caption looks."
}
},
"additionalProperties": false
}Replace selected caption words by their stable IDs. Preserves timing and the other captions; this does not change the spoken audio.
| Argument | Type | Description |
|---|---|---|
| updates* | array | |
| projectId* | string | UUID string. |
| workspaceId* | any | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"projectId",
"updates"
],
"properties": {
"updates": {
"type": "array",
"items": {
"type": "object",
"required": [
"wordId",
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"wordId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
},
"maxItems": 200,
"minItems": 1
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Read bounded editable caption words and stable word IDs for one project, optionally matching text.
| Argument | Type | Description |
|---|---|---|
| limit* | integer | |
| offset* | integer | |
| matchText* | any | |
| projectId* | string | UUID string. |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"projectId",
"matchText",
"limit",
"offset"
],
"properties": {
"limit": {
"type": "integer",
"default": 100,
"maximum": 200,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"matchText": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
],
"default": null
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Replace this carousel's styling with the workspace's saved brand theme.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| workspaceId | any | |
| idempotencyKey* | string |
{
"type": "object",
"required": [
"idempotencyKey",
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Replace one carousel slide with a saved private template.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| slideIndex* | integer | |
| workspaceId | any | |
| idempotencyKey* | string | |
| savedTemplateId* | string |
{
"type": "object",
"required": [
"idempotencyKey",
"projectId",
"savedTemplateId",
"slideIndex"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"slideIndex": {
"type": "integer",
"maximum": 34,
"minimum": 0
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"savedTemplateId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Replace this carousel's styling with an existing saved theme.
| Argument | Type | Description |
|---|---|---|
| themeId* | string | |
| projectId* | string | UUID string. |
| workspaceId | any | |
| idempotencyKey* | string |
{
"type": "object",
"required": [
"idempotencyKey",
"projectId",
"themeId"
],
"properties": {
"themeId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Duplicate a carousel onto a new project. Copies slots. Icon and shot values may be pack filenames or asset:<media_asset_id>.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| projectId* | string | UUID string. |
| workspaceId | any | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"idempotencyKey",
"projectId"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Create or replace a carousel project from a slide document. Server owns chip layout, safezones, and exact export pixels.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| style | object | |
| locale | string | |
| slides* | array | |
| platform* | string | |
| series_id | string | |
| project_id | string | |
| workspaceId | any | |
| clear_existing | boolean | |
| idempotencyKey* | string |
Delete one saved private carousel slide template.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| workspaceId | any | |
| idempotencyKey* | string | |
| savedTemplateId* | string |
{
"type": "object",
"required": [
"idempotencyKey",
"projectId",
"savedTemplateId"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"savedTemplateId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Delete one saved private carousel theme.
| Argument | Type | Description |
|---|---|---|
| themeId* | string | |
| projectId* | string | UUID string. |
| workspaceId | any | |
| idempotencyKey* | string |
{
"type": "object",
"required": [
"idempotencyKey",
"projectId",
"themeId"
],
"properties": {
"themeId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Turn a named recipe or a brief into compile-ready named-template slides. Expand never publishes and never invents metrics.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| brief | string | |
| offer | string | |
| locale | string | |
| product | string | |
| audience | string | |
| platform | string | |
| recipeId* | string | |
| workspaceId | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"recipeId"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"brief": {
"type": "string",
"maxLength": 8000,
"minLength": 1
},
"offer": {
"type": "string",
"maxLength": 400,
"minLength": 1
},
"locale": {
"type": "string",
"maxLength": 12,
"minLength": 2
},
"product": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"audience": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"platform": {
"enum": [
"tiktok_photo",
"instagram_4x5",
"linkedin"
],
"type": "string"
},
"recipeId": {
"enum": [
"curiosity_gap_ugc_7",
"result_first_demo_6",
"myth_guillotine_8",
"before_after_5",
"from_brief"
],
"type": "string"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}Read the carousel slot document and the named template catalog.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| workspaceId | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}Rebuild a compile slot document from a legacy overlay carousel. Then patch slots like any compiled deck.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| workspaceId | any | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"idempotencyKey",
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Patch native slots/media or select a completed Remotion frame artifact and crop. Requires expectedRevision; identical keys replay.
| Argument | Type | Description |
|---|---|---|
| crop | any | |
| lines | array | |
| slots | object | |
| projectId* | string | UUID string. |
| slideIndex* | integer | |
| templateId | string | |
| workspaceId | any | |
| mediaAssetId | string | |
| idempotencyKey* | string | |
| expectedRevision* | integer | |
Render and store private JPEG previews for the selected carousel slides. Replaces cached previews at deterministic storage keys; preserves the source project and slide document.
| Argument | Type | Description |
|---|---|---|
| chrome* | string | |
| projectId* | string | UUID string. |
| workspaceId | any | |
| slideIndexes | array | |
| idempotencyKey* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"idempotencyKey",
"projectId",
"chrome"
],
"properties": {
"chrome": {
"enum": [
"tiktok",
"instagram",
"none"
],
"type": "string",
"default": "none"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"slideIndexes": {
"type": "array",
"items": {
"type": "integer",
"maximum": 34,
"minimum": 0
},
"maxItems": 35
},
"idempotencyKey": {
"anyOf": [
{
"type": "string",
"maxLength": 200,
"minLength": 8
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Save one carousel slide as a private template; removes the oldest saved template when the 40-template limit is reached.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| scope | string | |
| projectId* | string | UUID string. |
| slideIndex* | integer | |
| workspaceId | any | |
| idempotencyKey* | string |
{
"type": "object",
"required": [
"idempotencyKey",
"projectId",
"name",
"slideIndex"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"scope": {
"enum": [
"project",
"brand"
],
"type": "string"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"slideIndex": {
"type": "integer",
"maximum": 34,
"minimum": 0
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Save and activate the current carousel styling as a private theme; removes the oldest saved theme when the 40-theme limit is reached.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| scope | string | |
| projectId* | string | UUID string. |
| workspaceId | any | |
| idempotencyKey* | string |
{
"type": "object",
"required": [
"idempotencyKey",
"projectId",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"scope": {
"enum": [
"project",
"brand"
],
"type": "string"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Insert one new carousel slide from a named template or copy an existing slide. Preserves existing slide content.
| Argument | Type | Description |
|---|---|---|
| index* | integer | |
| projectId* | string | UUID string. |
| templateId | string | |
| sourceIndex | integer | |
| workspaceId | any | |
| idempotencyKey* | string |
{
"type": "object",
"required": [
"idempotencyKey",
"projectId",
"index"
],
"properties": {
"index": {
"type": "integer",
"maximum": 34,
"minimum": 0
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"templateId": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"sourceIndex": {
"type": "integer",
"maximum": 34,
"minimum": 0
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Remove one carousel slide and its content from the project.
| Argument | Type | Description |
|---|---|---|
| index* | integer | |
| projectId* | string | UUID string. |
| workspaceId | any | |
| idempotencyKey* | string |
{
"type": "object",
"required": [
"idempotencyKey",
"projectId",
"index"
],
"properties": {
"index": {
"type": "integer",
"maximum": 34,
"minimum": 0
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Move one carousel slide to a new index. Replaces the existing slide order.
| Argument | Type | Description |
|---|---|---|
| to* | integer | |
| from* | integer | |
| projectId* | string | UUID string. |
| workspaceId | any | |
| idempotencyKey* | string |
{
"type": "object",
"required": [
"idempotencyKey",
"projectId",
"from",
"to"
],
"properties": {
"to": {
"type": "integer",
"maximum": 34,
"minimum": 0
},
"from": {
"type": "integer",
"maximum": 34,
"minimum": 0
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Restore the previous carousel document revision, replacing the current slide document.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| workspaceId | any | |
| idempotencyKey* | string |
{
"type": "object",
"required": [
"idempotencyKey",
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Create or update a reference-based character for repeatable faceless story generation.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| type | string | |
| species | string | |
| storyFacts | array | |
| characterId | string | |
| workspaceId | string | Optional workspace UUID. Defaults to the user's default workspace. UUID string. |
| defaultVoiceId | string | |
| idempotencyKey* | string | |
| defaultVoiceStyle | string | |
| referenceAssetIds | array | |
Inspect one reusable character and its ordered reference-image set before planning a story.
| Argument | Type | Description |
|---|---|---|
| characterId* | string | |
| workspaceId | string | Optional workspace UUID. Defaults to the user's default workspace. UUID string. |
{
"type": "object",
"required": [
"characterId"
],
"properties": {
"characterId": {
"type": "string"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace UUID. Defaults to the user's default workspace. UUID string."
}
},
"additionalProperties": false
}List bounded reusable characters with identity, voice, facts, and image-reference metadata.
| Argument | Type | Description |
|---|---|---|
| limit | number | |
| offset | number | |
| workspaceId | string | Optional workspace UUID. Defaults to the user's default workspace. UUID string. |
| includeArchived | boolean |
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"default": 20,
"maximum": 50,
"minimum": 1
},
"offset": {
"type": "number",
"default": 0,
"minimum": 0
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace UUID. Defaults to the user's default workspace. UUID string."
},
"includeArchived": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}Preview or delete a terminal clip batch. Dry-run is the default; real deletion requires explicit confirmation, retention choice, workspace delete permission, and an idempotency key.
| Argument | Type | Description |
|---|---|---|
| dryRun | boolean | |
| batchId* | string | UUID string. |
| retention | string | |
| workspaceId | string | UUID string. |
| confirmDelete | boolean | |
| idempotencyKey* | string |
{
"type": "object",
"required": [
"batchId",
"idempotencyKey"
],
"properties": {
"dryRun": {
"type": "boolean",
"default": true
},
"batchId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"retention": {
"enum": [
"retain_projects_and_exports",
"delete_projects_and_exports"
],
"type": "string",
"default": "retain_projects_and_exports"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 8
}
},
"additionalProperties": false
}Read whether the source video's clip share page is public and which clips are visible. Does not publish content.
| Argument | Type | Description |
|---|---|---|
| assetId* | string | UUID string. |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"assetId"
],
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Make the selected source video's clip page public with reviewed title, description and explicit download permission. Requires confirmPublicSharing=true from the user. Returns the verified public URL; no social network post is made.
| Argument | Type | Description |
|---|---|---|
| title* | string | |
| assetId* | string | UUID string. |
| description* | string | |
| workspaceId* | any | |
| allowDownloads* | boolean | |
| idempotencyKey* | string | |
| confirmPublicSharing* | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"assetId",
"title",
"description",
"allowDownloads",
"confirmPublicSharing"
],
"properties": {
"title": {
"type": "string",
"maxLength": 140,
"minLength": 1
},
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"description": {
"type": "string",
"default": "",
"maxLength": 500
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"allowDownloads": {
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"confirmPublicSharing": {
"type": "boolean",
"const": true
}
},
"additionalProperties": false
}Disable public access to the selected clip page. Changes an existing publication; preserves private projects and exports.
| Argument | Type | Description |
|---|---|---|
| assetId* | string | UUID string. |
| workspaceId* | any | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"assetId"
],
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Show or hide one identified clip on an existing public review page after explicit user confirmation. Preserves the other clips and private project data.
| Argument | Type | Description |
|---|---|---|
| clipId* | string | |
| assetId* | string | UUID string. |
| visibility* | string | |
| workspaceId* | any | |
| idempotencyKey* | string | |
| confirmPublicSharing* | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"assetId",
"clipId",
"visibility",
"confirmPublicSharing"
],
"properties": {
"clipId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"visibility": {
"enum": [
"visible",
"hidden"
],
"type": "string"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"confirmPublicSharing": {
"type": "boolean",
"const": true
}
},
"additionalProperties": false
}Read existing suggested moments with source ranges, hooks, transcript excerpts and thumbnails before producing videos. Results are bounded; this does not generate suggestions or render clips.
| Argument | Type | Description |
|---|---|---|
| limit* | integer | |
| offset* | integer | |
| assetId* | string | UUID string. |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"assetId",
"limit",
"offset"
],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Create a private BlitzReels clip batch from an existing asset or a user-provided video URL. Supports public social videos, Google Drive, and direct media URLs.
| Argument | Type | Description |
|---|---|---|
| url | string | Video URL to import before clipping. Supports social video links, Google Drive file links, and direct video file URLs. |
| assetId | string | Existing BlitzReels video asset ID. Provide assetId or url, not both. UUID string. |
| seriesId | string | Optional Series UUID. Omitted inherits the source Series; null creates standalone clips. |
| clipCount | integer | Maximum clips requested. Available source moments and account limits can yield fewer. |
| selection | any | Existing asset only: reviewed candidate IDs to include in order or exclude. Resolve IDs with clips_candidates_list first. Null delegates selection. |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| clipPresetId | string | Clip style preset. Use high-retention for High Retention clips or demo-focus for product and screen demos. |
Make one completed export the accepted delivery for a clip after explicit visual-QA confirmation. Replaces the delivery pointer and preserves earlier exports.
| Argument | Type | Description |
|---|---|---|
| clipId* | string | |
| exportId* | string | |
| workspaceId | string | UUID string. |
| idempotencyKey* | string | |
| confirmVisualQa* | boolean |
{
"type": "object",
"required": [
"clipId",
"exportId",
"confirmVisualQa",
"idempotencyKey"
],
"properties": {
"clipId": {
"type": "string",
"minLength": 1
},
"exportId": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 8
},
"confirmVisualQa": {
"type": "boolean",
"const": true
}
},
"additionalProperties": false
}Render one managed clip at an existing-account-supported quality. Returns persisted export state; inspect until the accepted delivery file is ready. Can spend existing account credits.
| Argument | Type | Description |
|---|---|---|
| clipId* | string | null | |
| format | string | |
| resolution | string | |
| workspaceId | string | UUID string. |
| idempotencyKey* | string | null | |
| coverFrameSeconds | number |
{
"type": "object",
"required": [
"clipId",
"idempotencyKey"
],
"properties": {
"clipId": {
"type": [
"string",
"null"
],
"default": null
},
"format": {
"enum": [
"mp4",
"mov"
],
"type": "string",
"default": "mp4"
},
"resolution": {
"enum": [
"720p",
"1080p"
],
"type": "string",
"default": "1080p"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"idempotencyKey": {
"type": [
"string",
"null"
],
"default": null
},
"coverFrameSeconds": {
"type": "number",
"minimum": 0
}
},
"additionalProperties": false
}Get status, generated clips, render counts, and download links for a BlitzReels clip batch.
| Argument | Type | Description |
|---|---|---|
| batchId* | string | Clip batch ID. UUID string. |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
{
"type": "object",
"required": [
"batchId"
],
"properties": {
"batchId": {
"type": "string",
"format": "uuid",
"description": "Clip batch ID. UUID string."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
}
},
"additionalProperties": false
}Read one managed clip's selected source range, project, workflow state and delivery information.
| Argument | Type | Description |
|---|---|---|
| clipId* | string | null | |
| workspaceId | string | UUID string. |
{
"type": "object",
"required": [
"clipId"
],
"properties": {
"clipId": {
"type": [
"string",
"null"
],
"default": null
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
}
},
"additionalProperties": false
}List bounded managed clips from the selected source or project with their current workflow state.
| Argument | Type | Description |
|---|---|---|
| limit | number | |
| offset | number | |
| status | string | |
| assetId | string | UUID string. |
| projectId | string | UUID string. |
| workspaceId | string | UUID string. |
{
"type": "object",
"required": [],
"properties": {
"limit": {
"type": "number",
"default": 20,
"maximum": 50,
"minimum": 1
},
"offset": {
"type": "number",
"default": 0,
"minimum": 0
},
"status": {
"type": "string"
},
"assetId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
}
},
"additionalProperties": false
}List available clip batch presets and their clipping/caption defaults.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Recover a terminal batch's missing clip count through the persisted recovery workflow. Preserves accepted clips and returns the recovery batch ID. Can spend existing account credits; retry with the identical idempotency key.
| Argument | Type | Description |
|---|---|---|
| batchId* | string | UUID string. |
| workspaceId* | any | |
| idempotencyKey* | string | |
| targetClipCount* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"batchId",
"targetClipCount"
],
"properties": {
"batchId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"targetClipCount": {
"anyOf": [
{
"type": "integer",
"maximum": 30,
"minimum": 1
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Request a layout repair for one managed clip, such as preserving a screen demo or moving captions away from faces. Changes that clip's project; preserves the other clips.
| Argument | Type | Description |
|---|---|---|
| clipId* | string | null | |
| repairMode | string | |
| workspaceId | string | UUID string. |
| idempotencyKey* | string | null |
{
"type": "object",
"required": [
"clipId",
"idempotencyKey"
],
"properties": {
"clipId": {
"type": [
"string",
"null"
],
"default": null
},
"repairMode": {
"enum": [
"auto",
"prefer_split",
"prefer_focus",
"prefer_tutorial",
"prefer_demo",
"move_captions_off_faces"
],
"type": "string",
"default": "auto"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"idempotencyKey": {
"type": [
"string",
"null"
],
"default": null
}
},
"additionalProperties": false
}Replace the source moment for one managed clip using a verified suggestion or explicit time range. Can spend existing account credits. Preserves the other clips; read current state before retrying.
| Argument | Type | Description |
|---|---|---|
| clipId* | string | null | |
| lookId | string | |
| endSeconds | number | |
| layoutMode | string | |
| workspaceId | string | UUID string. |
| startSeconds | number | |
| suggestionId | string | UUID string. |
| selectionMode* | string | null | |
| idempotencyKey* | string | null | |
| captionsEnabled | boolean |
Read one existing batch's progress, ready clips and renewed signed links without opening or remounting a review widget. Safe for bounded polling and widget refresh; does not recreate or repair clips.
| Argument | Type | Description |
|---|---|---|
| batchId* | string | UUID string. |
| workspaceId | string | UUID string. |
{
"type": "object",
"required": [
"batchId"
],
"properties": {
"batchId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
}
},
"additionalProperties": false
}Read bounded existing provider-reported engagement in the selected workspace, sorted by views. Filters by format, account and publication window. Returns lifetime counters with capture/check times, availability, and saved Project/export lineage when known. Does not import new data, start monitoring or infer attributable leads, sales or revenue.
| Argument | Type | Description |
|---|---|---|
| limit* | integer | |
| range* | string | |
| format* | string | |
| offset* | integer | |
| search* | string | |
| platform* | string | |
| workspaceId* | any | |
| connectionIds* | any |
Create a stable HTTPS tracking link or revise its label/enabled state. Destination and content association are immutable. Revisions require expectedRevision; null creates.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| label* | string | |
| postId* | any | |
| enabled* | boolean | |
| seriesId* | any | |
| projectId* | any | |
| destination* | string | |
| workspaceId* | any | |
| idempotencyKey* | string | |
| expectedRevision* | any |
Read observed link clicks and self-reported outcomes in a bounded window up to 90 days. Counts are not verified conversions. Provider engagement remains separate.
| Argument | Type | Description |
|---|---|---|
| to* | string | |
| from* | string | |
| limit* | integer | |
| offset* | integer | |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"from",
"to",
"limit",
"offset",
"workspaceId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"limit": {
"type": "integer",
"default": 30,
"maximum": 100,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 10000,
"minimum": 0
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Record or revise leads, sales, revenue or another measured outcome with source, time and explicit attribution. Revision history is retained; voided records remain visible. No conversion is inferred from clicks.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| kind* | string | |
| unit* | string | |
| value* | number | |
| postId* | any | |
| source* | string | |
| voided* | boolean | |
| seriesId* | any | |
| projectId* | any | |
| occurredAt* | string |
Preview or delete up to 100 timeline items and optionally remove linked captions.
| Argument | Type | Description |
|---|---|---|
| dryRun | boolean | |
| projectId* | string | UUID string. |
| confirmDelete | boolean | |
| idempotencyKey | string | |
| timelineItemIds* | array | |
| expectedRevision | integer | Expected sequence revision, or null. |
| removeAssociatedCaptions | boolean |
{
"type": "object",
"required": [
"projectId",
"timelineItemIds"
],
"properties": {
"dryRun": {
"type": "boolean",
"default": true
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8
},
"timelineItemIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"expectedRevision": {
"type": "integer",
"minimum": 0,
"description": "Expected sequence revision, or null."
},
"removeAssociatedCaptions": {
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}Replace one shot's media asset while preserving the other timeline items. Revision checked; dryRun previews by default. Requires a current editor snapshot and an asset in the same workspace.
| Argument | Type | Description |
|---|---|---|
| dryRun* | boolean | |
| itemId* | string | |
| assetId* | string | UUID string. |
| projectId* | string | UUID string. |
| workspaceId* | any | |
| idempotencyKey* | string | |
| expectedRevision* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"itemId",
"assetId",
"workspaceId",
"idempotencyKey",
"projectId",
"expectedRevision",
"dryRun"
],
"properties": {
"dryRun": {
"type": "boolean",
"default": true
},
"itemId": {
"type": "string"
},
"assetId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Insert a workspace image, generated shot or audio asset at an explicit project time. Revision checked; dryRun previews by default.
| Argument | Type | Description |
|---|---|---|
| dryRun* | boolean | |
| assetId* | string | UUID string. |
| projectId* | string | UUID string. |
| layerIndex* | any | |
| workspaceId* | any | |
| startSeconds* | number | |
| idempotencyKey* | string | |
| durationSeconds* | any | |
| expectedRevision* | integer |
Adjust one item's volume and audio fades. Revision checked; dryRun previews by default. Preserves the rest of the project.
| Argument | Type | Description |
|---|---|---|
| dryRun* | boolean | |
| itemId* | string | |
| volume* | number | |
| projectId* | string | UUID string. |
| workspaceId* | any | |
| fadeInSeconds* | number | |
| fadeOutSeconds* | number | |
| idempotencyKey* | string | |
| expectedRevision* | integer |
Edit composition elements by stable element ID from the editor snapshot: text content, style and animation. Content/style edits preserve placement timing. Optional edit.structure runs ordered insert/move/remove operations before changes. Group by inserting a group and moving children into it. Supply new unique IDs; beforeId null appends. Move coordinates preserveLocal keeps local style and frame offsets, not world position/time. Remove deletes the subtree. Preview reports affected and removed element IDs. Optional edit.duration sets source frames with explicit placements policy: preserve keeps visible windows and syncs unused tails; resizeAll preserves starts/trims and resizes all active placements. Source windows must fit; invalid shortening is rejected. Shared content changes affect all its placements. Omitted fields stay unchanged; null clears a style override; animation values replace the whole property's animation. Attached presets require explicit detachment. Revision checked; dryRun previews by default.
| Argument | Type | Description |
|---|---|---|
| edit* | object | |
| dryRun* | boolean | |
| itemId* | string | |
| projectId* | string | UUID string. |
| workspaceId* | any | |
Adjust the crop of one existing source view after a layout has been applied. Revision checked; dryRun previews by default. Preserves the other shots.
| Argument | Type | Description |
|---|---|---|
| crop* | object | |
| dryRun* | boolean | |
| itemId* | string | |
| projectId* | string | UUID string. |
| workspaceId* | any | |
| idempotencyKey* | string | |
| expectedRevision* | integer |
{
"type": "object",
"$defs": {
"__schema0": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"__schema1": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"__schema2": {
"type": "number",
"maximum": 1,
"minimum": 0.0001
},
"__schema3": {
"type": "number",
"maximum": 1,
"minimum": 0.0001
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"itemId",
"crop",
"workspaceId",
"idempotencyKey",
"projectId",
"expectedRevision",
"dryRun"
],
"properties": {
"crop": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"$ref": "#/$defs/__schema0"
},
"y": {
"$ref": "#/$defs/__schema1"
},
"width": {
"$ref": "#/$defs/__schema2"
},
"height": {
"$ref": "#/$defs/__schema3"
}
},
"additionalProperties": false
},
"dryRun": {
"type": "boolean",
"default": true
},
"itemId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Restore one saved editor action at the expected current revision. Requires the action ID from edit history and an idempotency key. Existing project data is changed.
| Argument | Type | Description |
|---|---|---|
| actionId* | string | |
| projectId* | string | UUID string. |
| workspaceId* | any | |
| idempotencyKey* | string | |
| expectedRevision* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"actionId",
"expectedRevision",
"workspaceId",
"idempotencyKey"
],
"properties": {
"actionId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Read up to 50 saved edit actions, their labels and undo state. Does not restore or change the project.
| Argument | Type | Description |
|---|---|---|
| limit* | integer | |
| projectId* | string | UUID string. |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"projectId",
"limit"
],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Move selected timeline items to explicit times and layers. Revision checked; dryRun previews by default.
| Argument | Type | Description |
|---|---|---|
| items* | array | |
| dryRun* | boolean | |
| projectId* | string | UUID string. |
| workspaceId* | any | |
| idempotencyKey* | string | |
| expectedRevision* | integer |
{
"type": "object",
"$defs": {
"__schema0": {
"type": "object",
"required": [
"id",
"startSeconds",
"layerIndex"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"layerIndex": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"startSeconds": {
"type": "number",
"minimum": 0
}
},
"additionalProperties": false
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"items",
"workspaceId",
"idempotencyKey",
"projectId",
"expectedRevision",
"dryRun"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
},
"maxItems": 500,
"minItems": 1
},
"dryRun": {
"type": "boolean",
"default": true
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Remove selected timeline items and, if requested, their linked captions. Revision checked; dryRun previews by default. The saved action can be undone.
| Argument | Type | Description |
|---|---|---|
| dryRun* | boolean | |
| itemIds* | array | |
| projectId* | string | UUID string. |
| workspaceId* | any | |
| idempotencyKey* | string | |
| expectedRevision* | integer | |
| removeAssociatedCaptions* | boolean |
{
"type": "object",
"$defs": {
"__schema0": {
"type": "string",
"minLength": 1
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"itemIds",
"removeAssociatedCaptions",
"workspaceId",
"idempotencyKey",
"projectId",
"expectedRevision",
"dryRun"
],
"properties": {
"dryRun": {
"type": "boolean",
"default": true
},
"itemIds": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
},
"maxItems": 500,
"minItems": 1
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"removeAssociatedCaptions": {
"type": "boolean"
}
},
"additionalProperties": false
}Read the current revision, stable timeline IDs, captions, style and bounded media context before a precise revision. Signed media links are refreshed by reading again.
| Argument | Type | Description |
|---|---|---|
| limit* | integer | |
| offset* | integer | |
| projectId* | string | UUID string. |
| workspaceId* | any | |
| expectedRevision* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"projectId",
"offset",
"limit",
"expectedRevision"
],
"properties": {
"limit": {
"type": "integer",
"default": 100,
"maximum": 200,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"expectedRevision": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Create or revise one title or text overlay with explicit timing. Revision checked; dryRun previews by default. This edits project text, not spoken audio or captions.
| Argument | Type | Description |
|---|---|---|
| spec* | any | |
| text* | string | |
| dryRun* | boolean | |
| itemId* | any | |
| textKind* | string | |
| projectId* | string | UUID string. |
| workspaceId* | any | |
| startSeconds* | number | |
| idempotencyKey* | string | |
Read a WebVTT caption track from the completed export's immutable canonical speech snapshot, preserving the actual export trims. Returns unavailable for older exports or unverified speech; never fabricates captions from titles or current edited timelines.
| Argument | Type | Description |
|---|---|---|
| exportId* | string | UUID string. |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"exportId"
],
"properties": {
"exportId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}List exports with render status and progress. Completed exports include a signed download URL. Pass exportId to return one export.
| Argument | Type | Description |
|---|---|---|
| limit | number | Maximum exports to return when exportId is absent (1-50). |
| offset | number | Export offset when exportId is absent. |
| exportId | string | Return only this export, including its signed download URL when the render is complete. UUID string. |
| projectId | string | Filter exports by project ID. UUID string. |
| workspaceId | string | Optional workspace ID when projectId is not provided. Defaults to the user's default workspace. UUID string. |
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum exports to return when exportId is absent (1-50)."
},
"offset": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Export offset when exportId is absent."
},
"exportId": {
"type": "string",
"format": "uuid",
"description": "Return only this export, including its signed download URL when the render is complete. UUID string."
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "Filter exports by project ID. UUID string."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID when projectId is not provided. Defaults to the user's default workspace. UUID string."
}
},
"additionalProperties": false
}Export a BlitzReels video or native carousel and return export and job IDs for status checks.
| Argument | Type | Description |
|---|---|---|
| format | string | Video container or native carousel image ZIP format |
| projectId* | string | BlitzReels project ID. UUID string. |
| resolution | string | Export resolution |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
| expectedRevision | integer | Reject export if the Project changed since this revision was read. |
| coverFrameSeconds | number | Optional cover thumbnail timestamp |
{
"type": "object",
"required": [
"projectId"
],
"properties": {
"format": {
"enum": [
"mp4",
"mov",
"fcpxml",
"zip",
"png",
"jpeg",
"carousel_zip"
],
"type": "string",
"default": "mp4",
"description": "Video container or native carousel image ZIP format"
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "BlitzReels project ID. UUID string."
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
],
"type": "string",
"default": "1080p",
"description": "Export resolution"
},
"idempotencyKey": {
"type": "string",
"description": "Retry key. Reuse only with identical inputs."
},
"expectedRevision": {
"type": "integer",
"minimum": 0,
"description": "Reject export if the Project changed since this revision was read."
},
"coverFrameSeconds": {
"type": "number",
"minimum": 0,
"description": "Optional cover thumbnail timestamp"
}
},
"additionalProperties": false
}Turn a script into a full faceless video project: scene plan, generated visuals, optional voiceover, captions, music, and sound. Spends AI credits and returns a job to poll with generation_jobs_get.
| Argument | Type | Description |
|---|---|---|
| script* | string | The narration or story to turn into a video. |
| voiceId | string | Optional voice override from the BlitzReels voice catalog. The Story Kit narrator voice is used when omitted. |
| seriesId | string | Optional Series UUID. Inherits its Story Kit and branding defaults for this new video. |
| storyKitId | string | Reusable Story Kit UUID for characters, references, locations, style, and narrator voice. |
| videoModel | string | Image-to-video model used to animate scenes. |
| projectName | string | Name for the created BlitzReels project. |
| visualStyle | string | Optional art direction override. A Story Kit style is used when omitted. |
| workspaceId | string |
Queue an AI image generation into the BlitzReels media library. Spends AI credits and returns a job to poll with generation_jobs_get.
| Argument | Type | Description |
|---|---|---|
| size | any | Exact output size as WIDTHxHEIGHT, for example 1920x2304. Only models whose parameters.size.supported is true in generation_options_list; it replaces aspectRatio, and credits scale with pixel count. |
| model | string | Image model. Call generation_options_list for costs. |
| prompt* | string | What the image should show (8-5000 characters). |
| folderId | string | Optional media library folder ID. |
| resolution | any | Native image resolution. Call generation_options_list for model support and resolution pricing. Unsupported settings are rejected. |
| aspectRatio | string | Output aspect ratio. |
| characterId | string | Workspace character to keep consistent (characters_list). Its reference images or trained weights and description are added; they count toward the model reference limit. |
| workspaceId |
Request cancellation of the identified queued or running generation. Work already performed can consume credits; cancellation does not establish a refund.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | Job ID returned by any generation_*_create tool. |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
{
"type": "object",
"required": [
"jobId"
],
"properties": {
"jobId": {
"type": "string",
"format": "uuid",
"description": "Job ID returned by any generation_*_create tool."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
}
},
"additionalProperties": false
}Read generation status, failure category, ledger-confirmed credit outcome, prompt history and compatible model alternatives. Alternatives report duration splits, estimated credits and unverified acceptance. reviewUrl opens prompt review and support escalation. Completed jobs include a media ID and download URL.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | Job ID returned by any generation_*_create tool. |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
{
"type": "object",
"required": [
"jobId"
],
"properties": {
"jobId": {
"type": "string",
"format": "uuid",
"description": "Job ID returned by any generation_*_create tool."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
}
},
"additionalProperties": false
}Queue a background music track into the BlitzReels media library. Spends AI credits and returns a job to poll with generation_jobs_get.
| Argument | Type | Description |
|---|---|---|
| mood | string | Track mood. |
| prompt | string | Optional description of the track. |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
| durationSeconds | number | Track length between 10 and 120 seconds. |
{
"type": "object",
"properties": {
"mood": {
"enum": [
"curiosity",
"intrigue",
"urgency",
"tension",
"concern",
"surprise",
"hope",
"satisfaction",
"inspiration",
"revelation",
"neutral"
],
"type": "string",
"default": "neutral",
"description": "Track mood."
},
"prompt": {
"type": "string",
"default": "",
"maxLength": 500,
"description": "Optional description of the track."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8,
"description": "Retry key. Reuse only with identical inputs."
},
"durationSeconds": {
"type": "number",
"default": 30,
"maximum": 120,
"minimum": 10,
"description": "Track length between 10 and 120 seconds."
}
},
"additionalProperties": false
}List the models, defaults, limits, and credit costs available for one generation kind before queueing it. Video duration is an enum per model (durations_seconds), not a min-max range.
| Argument | Type | Description |
|---|---|---|
| kind* | string | Generation kind to describe. |
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"enum": [
"image",
"video",
"voiceover",
"music",
"sound",
"faceless"
],
"type": "string",
"description": "Generation kind to describe."
}
},
"additionalProperties": false
}Read a generation brief from rawPrompt. Source-video edits return execution for generation_video_create with required assets and transformation controls. New scenes return an authoring grammar and planJsonSchema for generation_plan_validate. The video creation provenance.originalRequest field retains rawPrompt when supplied. This read does not generate media or spend credits.
| Argument | Type | Description |
|---|---|---|
| genre | string | Genre pack id (e.g. pixar-culture-skit). The brief lists available ids in availableGenres; the pack's beats and visual contract override the generic grammar. |
| rawPrompt | string | Original request. Clone or character-replacement requests select a video transformation brief instead of a new-story plan. |
| aspectRatio | string | |
| visualStyle | string | Visual style preset id; its locked style contract is included in the brief. |
| videoModelId | string | Target video model id (see generation_options_list, kind: video). Defaults to the strongest single-take model. |
| targetDurationSeconds | number | Desired final video duration in seconds. |
{
"type": "object",
"properties": {
"genre": {
"type": "string",
"description": "Genre pack id (e.g. pixar-culture-skit). The brief lists available ids in availableGenres; the pack's beats and visual contract override the generic grammar."
},
"rawPrompt": {
"type": "string",
"maxLength": 5000,
"description": "Original request. Clone or character-replacement requests select a video transformation brief instead of a new-story plan."
},
"aspectRatio": {
"enum": [
"9:16",
"16:9",
"1:1"
],
"type": "string",
"default": "9:16"
},
"visualStyle": {
"type": "string",
"description": "Visual style preset id; its locked style contract is included in the brief."
},
"videoModelId": {
"type": "string",
"description": "Target video model id (see generation_options_list, kind: video). Defaults to the strongest single-take model."
},
"targetDurationSeconds": {
"type": "number",
"default": 15,
"maximum": 300,
"minimum": 2,
"description": "Desired final video duration in seconds."
}
},
"additionalProperties": false
}Validate a self-authored generation plan against the schema and the target model's real capabilities before execution. Returns directive errors to fix and revalidate; only a valid plan is executable.
| Argument | Type | Description |
|---|---|---|
| plan* | object | The generation plan object authored from generation_plan_brief's planJsonSchema. |
{
"type": "object",
"required": [
"plan"
],
"properties": {
"plan": {
"type": "object",
"description": "The generation plan object authored from generation_plan_brief's planJsonSchema.",
"additionalProperties": true
}
},
"additionalProperties": false
}Queue a sound effect into the BlitzReels media library. Spends AI credits and returns a job to poll with generation_jobs_get.
| Argument | Type | Description |
|---|---|---|
| loop | boolean | Produce a seamlessly loopable effect. |
| prompt* | string | The sound to create (3-500 characters). |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
| durationSeconds | number | Effect length between 0.5 and 30 seconds. |
| promptInfluence | number | How literally to follow the prompt, between 0 and 1. Higher is more literal. |
{
"type": "object",
"required": [
"prompt"
],
"properties": {
"loop": {
"type": "boolean",
"default": false,
"description": "Produce a seamlessly loopable effect."
},
"prompt": {
"type": "string",
"maxLength": 500,
"minLength": 3,
"description": "The sound to create (3-500 characters)."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8,
"description": "Retry key. Reuse only with identical inputs."
},
"durationSeconds": {
"type": "number",
"default": 2,
"maximum": 30,
"minimum": 0.5,
"description": "Effect length between 0.5 and 30 seconds."
},
"promptInfluence": {
"type": "number",
"default": 0.5,
"maximum": 1,
"minimum": 0,
"description": "How literally to follow the prompt, between 0 and 1. Higher is more literal."
}
},
"additionalProperties": false
}Queue video generation, image animation, source-video editing or character replacement into the media library. Editing accepts referenceVideoAssetIds and transformation controls, including original-audio preservation. Spends AI credits and returns a job readable with generation_jobs_get.
| Argument | Type | Description |
|---|---|---|
| seed | integer | Optional seed for reproducible output. |
| model | string | Video model. generation_options_list publishes generation type, source limits, character controls, resolution and pricing for each model. |
| prompt* | string | What should happen in the shot (3-5000 characters). |
| folderId | string | Optional media library folder ID. |
| provider | string | Explicit provider must support the model and input mode. auto uses a configured compatible provider. |
| provenance | any | Original user request before prompt authoring, and previous failed job ID when retrying. Retained for review; never infer missing wording. |
| resolution | any | Output resolution. Call generation_options_list for model-specific supported values and defaults. Unsupported settings are rejected. |
Queue a text-to-speech voiceover into the BlitzReels media library. Spends AI credits and returns a job to poll with generation_jobs_get.
| Argument | Type | Description |
|---|---|---|
| text* | string | Script to read aloud (3-8000 characters). |
| speed | number | Speaking rate between 0.5 and 1.6. |
| voiceId | string | Catalog voice ID (generation_options_list with kind voiceover) or a workspace voice ID (voices_list), such as a cloned voice. |
| voiceStyle | string | Delivery emotion. |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
{
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 8000,
"minLength": 3,
"description": "Script to read aloud (3-8000 characters)."
},
"speed": {
"type": "number",
"default": 1,
"maximum": 1.6,
"minimum": 0.5,
"description": "Speaking rate between 0.5 and 1.6."
},
"voiceId": {
"type": "string",
"default": "pNInz6obpgDQGcFmaJgB",
"maxLength": 200,
"minLength": 1,
"description": "Catalog voice ID (generation_options_list with kind voiceover) or a workspace voice ID (voices_list), such as a cloned voice."
},
"voiceStyle": {
"enum": [
"curiosity",
"intrigue",
"urgency",
"tension",
"concern",
"surprise",
"hope",
"satisfaction",
"inspiration",
"revelation",
"neutral"
],
"type": "string",
"default": "neutral",
"description": "Delivery emotion."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8,
"description": "Retry key. Reuse only with identical inputs."
}
},
"additionalProperties": false
}Cancel a queued or running analysis, recover an unconfirmed dispatch by its existing identity, or deliver a retained result. Resume never repeats an uncertain model call and rejects changed owner direction.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | |
| action* | string | |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"jobId",
"action",
"workspaceId"
],
"properties": {
"jobId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"enum": [
"resume",
"cancel"
],
"type": "string"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Read frozen evidence, exact creative lineage, progress and saved lessons for a workspace learning job. Current owner direction overrides saved suggestions.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"jobId",
"workspaceId"
],
"properties": {
"jobId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Read bounded Series feedback, metrics, clicks and self-reported outcomes with current owner direction and a cost quote. No model call. Missing or incomparable evidence remains explicit.
| Argument | Type | Description |
|---|---|---|
| to* | string | |
| from* | string | |
| goal* | string | |
| language* | string | |
| seriesId* | string | |
| workspaceId* | any | |
| maxVariations* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"seriesId",
"goal",
"from",
"to",
"maxVariations",
"language",
"workspaceId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"goal": {
"enum": [
"reach",
"engagement",
"traffic",
"leads",
"sales",
"revenue"
],
"type": "string"
},
"language": {
"enum": [
"en",
"fr"
],
"type": "string"
},
"seriesId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"maxVariations": {
"type": "integer",
"default": 3,
"maximum": 5,
"minimum": 1
}
},
"additionalProperties": false
}Start one bounded model call from a reviewed learning quote and approved credits/USD cap. Saves cited lessons and up to five experimental briefs in the shared brain. Idempotent; never publishes or promises performance.
| Argument | Type | Description |
|---|---|---|
| to* | string | |
| from* | string | |
| goal* | string | |
| maxUsd* | number | |
| quoteId* | string | |
| language* | string | |
| seriesId* | string | |
| maxCredits* | number | |
| workspaceId* | any | |
| maxVariations* | integer |
Get metadata and processing state for one media-library asset without returning transcript segments.
| Argument | Type | Description |
|---|---|---|
| assetId* | string | Media asset UUID. UUID string. |
{
"type": "object",
"required": [
"assetId"
],
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"description": "Media asset UUID. UUID string."
}
},
"additionalProperties": false
}Return one bounded JPEG as MCP image content for visual inspection. Images use the stored visual; videos use the existing thumbnail.
| Argument | Type | Description |
|---|---|---|
| assetId* | string | Media asset UUID. UUID string. |
| maxDimension | integer | Maximum preview width or height in pixels (256-1536). |
{
"type": "object",
"required": [
"assetId"
],
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"description": "Media asset UUID. UUID string."
},
"maxDimension": {
"type": "integer",
"default": 1024,
"maximum": 1536,
"minimum": 256,
"description": "Maximum preview width or height in pixels (256-1536)."
}
},
"additionalProperties": false
}Rename one media asset, edit its description, move it to a folder, or change B-roll eligibility. Provide at least one of name, description, folderId, or allowUsingAsBroll.
| Argument | Type | Description |
|---|---|---|
| name | string | New media asset name. |
| assetId* | string | Media asset UUID. UUID string. |
| folderId | string | Target folder UUID, or null to move the asset to root. |
| description | string | New description, or null to clear it. |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
| allowUsingAsBroll | boolean | Whether the asset may be selected as B-roll. |
{
"type": "object",
"required": [
"assetId"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "New media asset name."
},
"assetId": {
"type": "string",
"format": "uuid",
"description": "Media asset UUID. UUID string."
},
"folderId": {
"type": "string",
"format": "uuid",
"description": "Target folder UUID, or null to move the asset to root."
},
"description": {
"type": "string",
"maxLength": 5000,
"description": "New description, or null to clear it."
},
"idempotencyKey": {
"type": "string",
"description": "Retry key. Reuse only with identical inputs."
},
"allowUsingAsBroll": {
"type": "boolean",
"description": "Whether the asset may be selected as B-roll."
}
},
"additionalProperties": false
}Create one media-library folder in a workspace and return a retry-safe mutation receipt.
| Argument | Type | Description |
|---|---|---|
| name* | string | Folder name. |
| iconType | string | Folder icon type. |
| description | string | Optional folder description. |
| workspaceId | string | Workspace UUID, or null for the default workspace. UUID string. |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
| parentFolderId | string | Parent folder UUID, or null for the root. |
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Folder name."
},
"iconType": {
"enum": [
"folder",
"code",
"video",
"audio",
"image",
"document",
"star",
"spark"
],
"type": "string",
"default": "folder",
"description": "Folder icon type."
},
"description": {
"type": "string",
"maxLength": 1000,
"description": "Optional folder description."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Workspace UUID, or null for the default workspace. UUID string."
},
"idempotencyKey": {
"type": "string",
"description": "Retry key. Reuse only with identical inputs."
},
"parentFolderId": {
"type": "string",
"format": "uuid",
"description": "Parent folder UUID, or null for the root."
}
},
"additionalProperties": false
}List one bounded level of media-library folders and direct asset counts.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum folders to return (1-50). |
| offset | integer | Folder offset. |
| workspaceId | string | Workspace UUID, or null for the default workspace. UUID string. |
| parentFolderId | string | Parent folder UUID, or null for root folders. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum folders to return (1-50)."
},
"offset": {
"type": "integer",
"default": 0,
"minimum": 0,
"description": "Folder offset."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Workspace UUID, or null for the default workspace. UUID string."
},
"parentFolderId": {
"type": "string",
"format": "uuid",
"description": "Parent folder UUID, or null for root folders."
}
},
"additionalProperties": false
}Inspect a user-provided public social-video or Google Drive URL and return available import metadata without creating media.
| Argument | Type | Description |
|---|---|---|
| url* | string | Public video URL. Supports social video links and Google Drive file links. |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Public video URL. Supports social video links and Google Drive file links."
}
},
"additionalProperties": false
}Scan a user-controlled public page and return an importable video URL found on it without creating media.
| Argument | Type | Description |
|---|---|---|
| url* | string | Video page URL or direct media URL to inspect for an importable video. |
| confirmAuthorizedToScan | boolean | Set true only after the user confirms they control the page or are authorized to scan it. |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Video page URL or direct media URL to inspect for an importable video."
},
"confirmAuthorizedToScan": {
"type": "boolean",
"default": false,
"description": "Set true only after the user confirms they control the page or are authorized to scan it."
}
},
"additionalProperties": false
}Import video, audio, images, fonts, SVG or JSON from a direct URL into the private workspace library. Returns a durable asset ID and verified contentHashSha256. Fonts, SVG and JSON are limited to 25 MiB.
| Argument | Type | Description |
|---|---|---|
| url* | string | URL of the media file to download and upload |
| name | string | Optional name for the file |
| projectId | string | Optional project ID to associate the upload with. UUID string. |
| workspaceId | string | Optional workspace ID when projectId is not provided. Defaults to the user's default workspace. UUID string. |
| autoTranscribe | boolean | Request transcription for video uploads. |
| autoSuggestShorts | boolean | |
| contentHashSha256 | string | Optional expected SHA-256; mismatching bytes are rejected before deduplication. 64-character hex string. |
| autoProcessEnabled | boolean | Enable media analysis after upload. |
| autoDescribeAfterTranscribe | boolean |
List media files in user's library (videos, audio, images)
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of assets to return (1-50) |
| offset | integer | Media asset offset. |
| assetType | string | Filter by asset type |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of assets to return (1-50)"
},
"offset": {
"type": "integer",
"default": 0,
"minimum": 0,
"description": "Media asset offset."
},
"assetType": {
"enum": [
"video",
"audio",
"image",
"all"
],
"type": "string",
"default": "all",
"description": "Filter by asset type"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
}
},
"additionalProperties": false
}Read retained voice inputs, measured duration, audio SHA-256 and word timing. Defaults to 200 words, maximum 500; offset selects the next page. take is null for audio without a retained narration take.
| Argument | Type | Description |
|---|---|---|
| limit* | integer | |
| offset* | integer | |
| assetId* | string | UUID string. |
| workspaceId | string | UUID string. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"assetId",
"limit",
"offset"
],
"properties": {
"limit": {
"type": "integer",
"default": 200,
"maximum": 500,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
}
},
"additionalProperties": false
}Get transcript summary metadata or a bounded window of transcription segments for a video asset.
| Argument | Type | Description |
|---|---|---|
| mode | string | Summary returns metadata only. Text returns joined text for a bounded segment window. Full returns the bounded segment objects without duplicating their text. |
| limit | integer | Maximum transcript segments to return (1-200). |
| offset | integer | Transcript segment offset. |
| assetId* | string | The media asset ID to get transcript for. UUID string. |
{
"type": "object",
"required": [
"assetId"
],
"properties": {
"mode": {
"enum": [
"summary",
"text",
"full"
],
"type": "string",
"default": "summary",
"description": "Summary returns metadata only. Text returns joined text for a bounded segment window. Full returns the bounded segment objects without duplicating their text."
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 200,
"minimum": 1,
"description": "Maximum transcript segments to return (1-200)."
},
"offset": {
"type": "integer",
"default": 0,
"minimum": 0,
"description": "Transcript segment offset."
},
"assetId": {
"type": "string",
"format": "uuid",
"description": "The media asset ID to get transcript for. UUID string."
}
},
"additionalProperties": false
}Import a video, audio, or image file from ChatGPT into the BlitzReels media library. Use this for a file the user attached or picked, and for an image ChatGPT generated in this conversation that the user wants to keep, animate, or edit in BlitzReels.
| Argument | Type | Description |
|---|---|---|
| file* | object | A file from ChatGPT: attached by the user, picked from their file library, or produced earlier in this conversation. ChatGPT provides this value. |
| name | string | Optional name to use in BlitzReels. |
| projectId | string | Optional BlitzReels project ID to associate with the uploaded file. UUID string. |
| workspaceId | string | Optional workspace ID when projectId is not provided. Defaults to the user's default workspace. UUID string. |
{
"type": "object",
"required": [
"file"
],
"properties": {
"file": {
"type": "object",
"required": [
"download_url",
"file_id"
],
"properties": {
"file_id": {
"type": "string"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"download_url": {
"type": "string",
"format": "uri"
}
},
"description": "A file from ChatGPT: attached by the user, picked from their file library, or produced earlier in this conversation. ChatGPT provides this value."
},
"name": {
"type": "string",
"description": "Optional name to use in BlitzReels."
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "Optional BlitzReels project ID to associate with the uploaded file. UUID string."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID when projectId is not provided. Defaults to the user's default workspace. UUID string."
}
},
"additionalProperties": false
}Verify uploaded bytes and save a reusable workspace asset after presigned PUT. Returns contentHashSha256, fileSizeBytes and mimeType.
| Argument | Type | Description |
|---|---|---|
| fileName* | string | Name of the uploaded file |
| projectId | string | Optional project ID to associate the upload with. UUID string. |
| storageKey* | string | Storage key for the uploaded file |
| contentType* | string | MIME type of the file |
| workspaceId | string | Optional workspace ID when projectId is not provided. Defaults to the user's default workspace. UUID string. |
| fileSizeBytes* | number | Size of the uploaded file in bytes |
| autoTranscribe | boolean | Request transcription for video uploads. |
| autoSuggestShorts | boolean | |
| contentHashSha256 | string | Optional expected SHA-256; mismatching bytes are rejected before deduplication. 64-character hex string. |
Get a presigned URL for direct file upload (for large files)
| Argument | Type | Description |
|---|---|---|
| fileName* | string | Name of the file to upload |
| projectId | string | Optional project ID to associate the upload with. UUID string. |
| contentType* | string | MIME type (e.g., video/mp4, audio/mp3, image/jpeg, font/woff2, image/svg+xml, application/json) |
| workspaceId | string | Optional workspace ID when projectId is not provided. Defaults to the user's default workspace. UUID string. |
{
"type": "object",
"required": [
"fileName",
"contentType"
],
"properties": {
"fileName": {
"type": "string",
"description": "Name of the file to upload"
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "Optional project ID to associate the upload with. UUID string."
},
"contentType": {
"type": "string",
"description": "MIME type (e.g., video/mp4, audio/mp3, image/jpeg, font/woff2, image/svg+xml, application/json)"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID when projectId is not provided. Defaults to the user's default workspace. UUID string."
}
},
"additionalProperties": false
}Queue a ByteDance upscale of one stored video asset to 1080p or 4k. Call media_upscale_estimate first. Spends AI credits and returns a new pending media asset to poll with media_assets_get.
| Argument | Type | Description |
|---|---|---|
| assetId* | string | Source video asset UUID. UUID string. |
| projectId | string | Optional project UUID to attach the credit spend. UUID string. |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
| targetResolution* | string | Output long-edge target. |
{
"type": "object",
"required": [
"assetId",
"targetResolution"
],
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"description": "Source video asset UUID. UUID string."
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "Optional project UUID to attach the credit spend. UUID string."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
},
"idempotencyKey": {
"type": "string",
"description": "Retry key. Reuse only with identical inputs."
},
"targetResolution": {
"enum": [
"1080p",
"4k"
],
"type": "string",
"description": "Output long-edge target."
}
},
"additionalProperties": false
}Estimate ByteDance upscale eligibility and credits for one stored video. Does not spend credits or queue a job. Call this before media_upscale.
| Argument | Type | Description |
|---|---|---|
| assetId* | string | Source video asset UUID. UUID string. |
| projectId | string | Optional project UUID for the estimate context. UUID string. |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| targetResolution* | string | Output long-edge target. |
{
"type": "object",
"required": [
"assetId",
"targetResolution"
],
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"description": "Source video asset UUID. UUID string."
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "Optional project UUID for the estimate context. UUID string."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
},
"targetResolution": {
"enum": [
"1080p",
"4k"
],
"type": "string",
"description": "Output long-edge target."
}
},
"additionalProperties": false
}Set one timeline media item's volume to zero.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| idempotencyKey* | string | Retry key. Reuse only with identical inputs. |
| timelineItemId* | string | |
| expectedRevision | integer | Expected sequence revision, or null. |
{
"type": "object",
"required": [
"projectId",
"timelineItemId",
"idempotencyKey"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8,
"description": "Retry key. Reuse only with identical inputs."
},
"timelineItemId": {
"type": "string",
"format": "uuid"
},
"expectedRevision": {
"type": "integer",
"minimum": 0,
"description": "Expected sequence revision, or null."
}
},
"additionalProperties": false
}Create a new private BlitzReels video project.
| Argument | Type | Description |
|---|---|---|
| name* | string | Project name (1-100 characters) |
| seriesId | string | Optional Series UUID for this new project. |
| frameRate | string | Video frame rate |
| aspectRatio | string | Video aspect ratio |
| description | string | Project description (optional, max 500 characters) |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Project name (1-100 characters)"
},
"seriesId": {
"type": "string",
"description": "Optional Series UUID for this new project."
},
"frameRate": {
"enum": [
"24",
"25",
"30",
"50",
"60"
],
"type": "string",
"default": "30",
"description": "Video frame rate"
},
"aspectRatio": {
"enum": [
"16:9",
"9:16",
"1:1"
],
"type": "string",
"default": "9:16",
"description": "Video aspect ratio"
},
"description": {
"type": "string",
"description": "Project description (optional, max 500 characters)"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
},
"idempotencyKey": {
"type": "string",
"description": "Retry key. Reuse only with identical inputs."
}
},
"additionalProperties": false
}Get details for one BlitzReels project, including timeline summary, clips, captions, and current recovery state with an app path and next read tool.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | The project ID to get details for. UUID string. |
{
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"description": "The project ID to get details for. UUID string."
}
},
"additionalProperties": false
}Read bounded project context for editing, including timeline items, media assets, transcripts, captions, and stable IDs.
| Argument | Type | Description |
|---|---|---|
| mode | string | Bounded project context view to return. |
| search | string | Optional media search when mode is assets or full. |
| projectId* | string | Project UUID. UUID string. |
| assetLimit | integer | Maximum media assets to return (1-50). |
| assetOffset | integer | Media asset offset. |
| timelineLimit | integer | Maximum timeline items to return (1-1000). |
| timelineOffset | integer | Timeline item offset. |
| transcriptLimit | integer | Maximum transcript segments to return (1-500). |
| captionWordLimit | integer | Maximum caption words to return (1-2000). |
List the user's BlitzReels projects with status, duration, and basic metadata.
| Argument | Type | Description |
|---|---|---|
| limit | number | Maximum number of projects to return (1-50) |
| offset | number | Project offset. |
| search | string | Search projects by name |
| status | string | Filter by project status |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"default": 10,
"maximum": 50,
"minimum": 1,
"description": "Maximum number of projects to return (1-50)"
},
"offset": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Project offset."
},
"search": {
"type": "string",
"description": "Search projects by name"
},
"status": {
"enum": [
"active",
"archived",
"all"
],
"type": "string",
"default": "active",
"description": "Filter by project status"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
}
},
"additionalProperties": false
}Read the supported accounts available through the existing workspace and provider access rules. Does not connect new accounts, publish, schedule or bypass provider review.
| Argument | Type | Description |
|---|---|---|
| limit* | integer | |
| offset* | integer | |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"limit",
"offset"
],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}List Instagram accounts connected through the BlitzReels UI for the authenticated workspace, including their connection status.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Schedule a completed project export to Instagram. Optional includeAffiliateCta appends Try BlitzReels for free plus the Affonso tracking URL. Requires an active Instagram account connected in the BlitzReels UI.
| Argument | Type | Description |
|---|---|---|
| caption | string | Caption text (max 2200). |
| exportId | string | Completed export UUID. Defaults to latest completed. UUID string. |
| timezone | string | IANA timezone. Defaults to UTC. |
| projectId* | string | Project UUID. UUID string. |
| trialReel | boolean | Publish as Trial Reel (video only). |
| shareToFeed | boolean | Also share Reel to profile feed. |
| connectionId | string | Instagram connection UUID when multiple exist. |
| scheduledFor* | string | ISO-8601 datetime for the scheduled publish. |
| affiliateCtaText |
Read the current targets for one publishing receipt with scheduled/published state and verified remote URLs. Does not retry or publish a failed target.
| Argument | Type | Description |
|---|---|---|
| postId* | string | |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"postId"
],
"properties": {
"postId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Schedule a selected existing video asset to explicit active YouTube, Instagram, Facebook, TikTok, LinkedIn or Threads accounts connected in the BlitzReels UI, using reviewed copy, privacy/consent choices, synthetic-media disclosure, time and timezone. Requires confirmPublish=true. Existing workspace permissions and provider access rules apply. A scheduled receipt is not proof of publication.
| Argument | Type | Description |
|---|---|---|
| caption | any | |
| targets* | array | |
| timezone | any | |
| workspaceId* | any | |
| project_name | any | |
| scheduled_for* | string | |
| confirmPublish* | boolean | |
| idempotencyKey* | string | |
| media_asset_id |
Produce a batch from a ready synchronized camera and screen recording, with optional clip count, maximum duration and caption look. Preserves readable screen context through the existing layout pipeline. Can spend existing credits; follows clips_get with the returned batch_id.
| Argument | Type | Description |
|---|---|---|
| clipCount* | any | |
| workspaceId* | any | |
| captionThemeId* | any | |
| idempotencyKey* | string | |
| recordingSetId* | string | |
| maxDurationSeconds* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"recordingSetId",
"clipCount",
"maxDurationSeconds",
"captionThemeId"
],
"properties": {
"clipCount": {
"anyOf": [
{
"type": "integer",
"maximum": 30,
"minimum": 1
},
{
"type": "null"
}
],
"default": null
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"captionThemeId": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"recordingSetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"maxDurationSeconds": {
"anyOf": [
{
"type": "integer",
"const": 30
},
{
"type": "integer",
"const": 60
},
{
"type": "integer",
"const": 90
},
{
"type": "integer",
"const": 180
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Create an empty camera and screen recording set in the explicit workspace. Requires existing recording-set access; does not import files or start processing.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| workspaceId* | any | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}Finalize the collected camera and screen tracks and queue analysis. Can spend existing transcription credits. Inspect returned alignment and warnings before clipping.
| Argument | Type | Description |
|---|---|---|
| workspaceId* | any | |
| idempotencyKey* | string | |
| recordingSetId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"recordingSetId"
],
"properties": {
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"recordingSetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Read one camera and screen recording set, its primary speaker, content windows, alignment and warnings. Separate audio-only tracks are not supported.
| Argument | Type | Description |
|---|---|---|
| workspaceId* | any | |
| recordingSetId* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"recordingSetId"
],
"properties": {
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"recordingSetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}Read bounded camera and screen recording sets in the selected workspace with status, duration and alignment warnings.
| Argument | Type | Description |
|---|---|---|
| limit* | integer | |
| offset* | integer | |
| status* | any | |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"status",
"limit",
"offset"
],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"status": {
"anyOf": [
{
"enum": [
"collecting_assets",
"analyzing",
"finalizing",
"ready",
"failed"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Attach one existing authorized video asset as a camera or screen track. Specify the main speaker when known; alignment happens during finalization.
| Argument | Type | Description |
|---|---|---|
| role* | string | |
| asset_id* | string | |
| is_primary* | boolean | |
| workspaceId* | any | |
| idempotencyKey* | string | |
| recordingSetId* | string | |
| participant_name* | any | |
| participant_label* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"recordingSetId",
"asset_id",
"role",
"participant_label",
"participant_name",
"is_primary"
],
"properties": {
"role": {
"enum": [
"camera",
"screen"
],
"type": "string"
},
"asset_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"is_primary": {
"type": "boolean",
"default": false
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"recordingSetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"participant_name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
],
"default": null
},
"participant_label": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Create or replace a Growth+ Series identity and defaults. defaultCreationMode selects podcast branding or faceless Story Kit defaults; membership stays mixed. Updates require expectedRevision. Existing content keeps its settings.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| seriesId* | any | |
| storyKitId* | any | |
| description* | any | |
| logoAssetId* | any | |
| workspaceId* | any | |
| coverAssetId* | any | |
| captionThemeId* | any | |
| idempotencyKey* | string |
Assign, move or detach one source or project using expectedSeriesId. Moving a source does not move existing clips or change branding.
| Argument | Type | Description |
|---|---|---|
| kind* | string | |
| seriesId* | any | |
| contentId* | string | |
| workspaceId* | any | |
| idempotencyKey* | string | |
| expectedSeriesId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"kind",
"contentId",
"seriesId",
"expectedSeriesId",
"workspaceId",
"idempotencyKey"
],
"properties": {
"kind": {
"enum": [
"project",
"source"
],
"type": "string"
},
"seriesId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"contentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedSeriesId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}List sources or projects in a Series. Null seriesId lists standalone content. sourceId filters projects by clip origin.
| Argument | Type | Description |
|---|---|---|
| kind* | string | |
| limit* | integer | |
| offset* | integer | |
| search* | string | |
| seriesId* | any | |
| sourceId* | any | |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"limit",
"offset",
"seriesId",
"kind",
"sourceId",
"search",
"workspaceId"
],
"properties": {
"kind": {
"enum": [
"project",
"source"
],
"type": "string"
},
"limit": {
"type": "integer",
"default": 30,
"maximum": 100,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"search": {
"type": "string",
"default": "",
"maxLength": 120
},
"seriesId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"sourceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Delete the Series container at an expected revision and detach its content. Sources, projects and exports are preserved.
| Argument | Type | Description |
|---|---|---|
| seriesId* | string | |
| workspaceId* | any | |
| idempotencyKey* | string | |
| expectedRevision* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"seriesId",
"expectedRevision",
"workspaceId",
"idempotencyKey"
],
"properties": {
"seriesId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
}Read a Series identity, creative defaults and revision.
| Argument | Type | Description |
|---|---|---|
| seriesId* | string | |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"seriesId"
],
"properties": {
"seriesId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}List optional Series with bounded counts and cover previews.
| Argument | Type | Description |
|---|---|---|
| limit* | integer | |
| offset* | integer | |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"limit",
"offset",
"workspaceId"
],
"properties": {
"limit": {
"type": "integer",
"default": 30,
"maximum": 100,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Create or update a Story Kit with optimistic concurrency and an idempotent mutation receipt.
| Argument | Type | Description |
|---|---|---|
| name* | string | Stable Story Kit name. |
| facts | array | |
| locations | array | |
| storyKitId | string | |
| description | string | |
| visualStyle* | string | Canonical visual-style contract. |
| workspaceId | string | Optional workspace UUID. Defaults to the user's default workspace. UUID string. |
| characterIds | array | |
| idempotencyKey* | string | |
| expectedRevision | number |
Inspect one Story Kit and its revision before generating or updating a story.
| Argument | Type | Description |
|---|---|---|
| storyKitId* | string | |
| workspaceId | string | Optional workspace UUID. Defaults to the user's default workspace. UUID string. |
{
"type": "object",
"required": [
"storyKitId"
],
"properties": {
"storyKitId": {
"type": "string"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace UUID. Defaults to the user's default workspace. UUID string."
}
},
"additionalProperties": false
}List bounded reusable Story Kits that bind characters, locations, style, facts, and narrator voice.
| Argument | Type | Description |
|---|---|---|
| limit | number | |
| offset | number | |
| workspaceId | string | Optional workspace UUID. Defaults to the user's default workspace. UUID string. |
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"default": 20,
"maximum": 50,
"minimum": 1
},
"offset": {
"type": "number",
"default": 0,
"minimum": 0
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace UUID. Defaults to the user's default workspace. UUID string."
}
},
"additionalProperties": false
}Place an audio asset onto a BlitzReels project timeline at a timestamp for voiceover, music, or sound.
| Argument | Type | Description |
|---|---|---|
| loop | boolean | Loop audio to fill requested duration |
| volume | number | Audio volume multiplier, 1 is normal |
| assetId* | string | Audio media asset ID. UUID string. |
| projectId* | string | BlitzReels project ID. UUID string. |
| startSeconds | number | Timeline start time in seconds |
| fadeInSeconds | number | Fade-in length in seconds |
| fadeOutSeconds | number | Fade-out length in seconds |
| durationSeconds | number | Optional duration. Required if the audio asset duration is not known yet. |
{
"type": "object",
"required": [
"projectId",
"assetId"
],
"properties": {
"loop": {
"type": "boolean",
"default": false,
"description": "Loop audio to fill requested duration"
},
"volume": {
"type": "number",
"default": 1,
"description": "Audio volume multiplier, 1 is normal"
},
"assetId": {
"type": "string",
"format": "uuid",
"description": "Audio media asset ID. UUID string."
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "BlitzReels project ID. UUID string."
},
"startSeconds": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Timeline start time in seconds"
},
"fadeInSeconds": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Fade-in length in seconds"
},
"fadeOutSeconds": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Fade-out length in seconds"
},
"durationSeconds": {
"type": "number",
"minimum": 0,
"description": "Optional duration. Required if the audio asset duration is not known yet."
}
},
"additionalProperties": false
}Place an image or video asset onto a BlitzReels project timeline at a timestamp, including B-roll and static images.
| Argument | Type | Description |
|---|---|---|
| assetId* | string | Image or video media asset ID. UUID string. |
| projectId* | string | BlitzReels project ID. UUID string. |
| layerIndex | number | Exact timeline layer to use. Lower layer numbers render on top. Omit for intent-based placement. |
| startSeconds | number | Timeline start time in seconds |
| allowDuplicate | boolean | Allow inserting the same asset more than once |
| positionPreset | string | Visual placement preset |
| animationPreset | string | Optional visual animation preset |
| durationSeconds | number | Duration in seconds. Required for still images when a specific length is needed. |
| placementIntent | string | Layer intent used when layerIndex is omitted. Use overlay for visible B-roll/logo/sticker over video, background for behind video, exact when layerIndex is supplied. |
Split one timeline item at the expected project revision. Changes existing timeline state and returns a retry-safe receipt.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| snapToFrame* | boolean | |
| idempotencyKey* | string | |
| splitAtSeconds* | number | |
| timelineItemId* | string | |
| expectedRevision* | integer | null | Expected sequence revision, or null. |
{
"type": "object",
"required": [
"projectId",
"expectedRevision",
"idempotencyKey",
"timelineItemId",
"splitAtSeconds",
"snapToFrame"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"snapToFrame": {
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8
},
"splitAtSeconds": {
"type": "number",
"minimum": 0
},
"timelineItemId": {
"type": "string",
"format": "uuid"
},
"expectedRevision": {
"type": [
"integer",
"null"
],
"minimum": 0,
"description": "Expected sequence revision, or null."
}
},
"additionalProperties": false
}Preview splitting one timeline item without changing the project.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| snapToFrame* | boolean | |
| splitAtSeconds* | number | |
| timelineItemId* | string | |
| expectedRevision* | integer | null | Expected sequence revision, or null. |
{
"type": "object",
"required": [
"projectId",
"expectedRevision",
"timelineItemId",
"splitAtSeconds",
"snapToFrame"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"snapToFrame": {
"type": "boolean"
},
"splitAtSeconds": {
"type": "number",
"minimum": 0
},
"timelineItemId": {
"type": "string",
"format": "uuid"
},
"expectedRevision": {
"type": [
"integer",
"null"
],
"minimum": 0,
"description": "Expected sequence revision, or null."
}
},
"additionalProperties": false
}Trim or extend one timeline item at the expected project revision. Changes existing timeline state and returns a retry-safe receipt.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| snapToFrame* | boolean | |
| idempotencyKey* | string | |
| timelineItemId* | string | |
| expectedRevision* | integer | null | Expected sequence revision, or null. |
| trimEndDeltaSeconds* | number | |
| trimStartDeltaSeconds* | number |
{
"type": "object",
"required": [
"projectId",
"expectedRevision",
"idempotencyKey",
"timelineItemId",
"trimStartDeltaSeconds",
"trimEndDeltaSeconds",
"snapToFrame"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"snapToFrame": {
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8
},
"timelineItemId": {
"type": "string",
"format": "uuid"
},
"expectedRevision": {
"type": [
"integer",
"null"
],
"minimum": 0,
"description": "Expected sequence revision, or null."
},
"trimEndDeltaSeconds": {
"type": "number"
},
"trimStartDeltaSeconds": {
"type": "number"
}
},
"additionalProperties": false
}Preview trimming or extending one timeline item without changing the project.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| snapToFrame* | boolean | |
| timelineItemId* | string | |
| expectedRevision* | integer | null | Expected sequence revision, or null. |
| trimEndDeltaSeconds* | number | |
| trimStartDeltaSeconds* | number |
{
"type": "object",
"required": [
"projectId",
"expectedRevision",
"timelineItemId",
"trimStartDeltaSeconds",
"trimEndDeltaSeconds",
"snapToFrame"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"snapToFrame": {
"type": "boolean"
},
"timelineItemId": {
"type": "string",
"format": "uuid"
},
"expectedRevision": {
"type": [
"integer",
"null"
],
"minimum": 0,
"description": "Expected sequence revision, or null."
},
"trimEndDeltaSeconds": {
"type": "number"
},
"trimStartDeltaSeconds": {
"type": "number"
}
},
"additionalProperties": false
}Update one timeline item's start, duration, trim, layer, ignored state, or blurred background. Provide at least one field to update besides timelineItemId.
| Argument | Type | Description |
|---|---|---|
| ignored | boolean | |
| projectId* | string | UUID string. |
| layerIndex | integer | |
| startSeconds | number | |
| idempotencyKey* | string | Retry key. Reuse only with identical inputs. |
| timelineItemId* | string | |
| trimEndSeconds | number | |
| durationSeconds | number | |
| expectedRevision | integer | Expected sequence revision, or null. |
| trimStartSeconds |
After the user approves the generated previews and animation cost, confirmApproved=true starts scene animation, narration and editable timeline assembly. Can replace the project's generated timeline and spend existing credits. Follow the revision and then export the finished project.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| revisionId* | string | |
| workspaceId* | any | |
| idempotencyKey* | string | |
| confirmApproved* | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"projectId",
"revisionId",
"confirmApproved"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"revisionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"confirmApproved": {
"type": "boolean",
"const": true
}
},
"additionalProperties": false
}Save the user's 1-5 rating and optional quality category/comment against one completed playable video export. Replaces that user's previous feedback for this export; does not change accepted clips or defaults. Requires the feedback storage migration to be installed.
| Argument | Type | Description |
|---|---|---|
| rating* | integer | |
| comment* | string | |
| category* | any | |
| exportId* | string | UUID string. |
| workspaceId* | any | |
| idempotencyKey* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"exportId",
"rating",
"category",
"comment"
],
"properties": {
"rating": {
"type": "integer",
"maximum": 5,
"minimum": 1
},
"comment": {
"type": "string",
"maxLength": 2000
},
"category": {
"anyOf": [
{
"enum": [
"moments",
"captions",
"pacing",
"framing",
"editing",
"export",
"other"
],
"type": "string"
},
{
"type": "null"
}
]
},
"exportId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}After showing the storyboard and its credit estimate, confirmApproved=true starts production of reference images and scene keyframes. Spends existing credits. This stage produces reviewable previews, not animated videos.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| revisionId* | string | |
| workspaceId* | any | |
| idempotencyKey* | string | |
| confirmApproved* | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"projectId",
"revisionId",
"confirmApproved"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"revisionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"confirmApproved": {
"type": "boolean",
"const": true
}
},
"additionalProperties": false
}Replace the identified preview after user approval of the new credit cost. A scene_keyframe changes one keyframe; a character_anchor refreshes its dependent keyframes; a style_anchor refreshes every keyframe. Preserves unaffected previews. Does not regenerate an already finished video shot.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| asset_type* | string | style_anchor regenerates the shared style reference and every keyframe; character_anchor requires character_id and refreshes dependent keyframes; scene_keyframe requires scene_index. |
| revisionId* | string | |
| scene_index | integer | |
| workspaceId* | any | |
| character_id | string | |
| idempotencyKey* | string | |
| confirmRegeneration* | boolean |
Create a vertical video storyboard for the user-approved script in an existing project. Spends planning credits; returns scene narration, factual review notes, references and the production credit estimate. Does not generate images or animate video. Existing account access applies.
| Argument | Type | Description |
|---|---|---|
| script* | string | |
| voice_id | string | |
| projectId* | string | UUID string. |
| series_id | any | |
| video_model | string | |
| workspaceId* | any | |
| story_kit_id | string | |
| visual_style | string | |
| character_ids | array | |
| idempotencyKey |
Read one authorized storyboard revision, its scene and reference previews, estimate, approvals and bounded polling guidance. Refreshes signed previews. Complete means the editable timeline is assembled; use exports_start and exports_list for a downloadable MP4.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| revisionId* | string | |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"projectId",
"revisionId"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"revisionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Create a new immutable draft from a known revision with selected scene, character or model changes. Preserves other scene definitions; requires review and production approval again. Does not generate media or overwrite an approved revision.
| Argument | Type | Description |
|---|---|---|
| projectId* | string | UUID string. |
| revisionId* | string | |
| video_model | string | |
| workspaceId* | any | |
| scene_updates | array | |
| idempotencyKey* | string | |
| image_model_id | string | |
| character_updates | array | |
| style_anchor_prompt | string | Self-contained prompt for the single reference frame that locks rendering medium, palette, lighting, and grain for every scene. No characters, no text, no interfaces. |
Create or update up to 20 visual blocks in one call after edit timing is settled. Presets: broll-headline, steps, quote, end-screen, key-number, before-after, screenshot-focus, chapter. IDs are scoped to the project; repeating an ID updates it. Asset IDs must belong to the workspace. Atomic, undoable; dryRun validates without writing. Returns IDs and revision. No generation pass.
| Argument | Type | Description |
|---|---|---|
| items* | array | Supply only the fields for the selected preset. |
| dryRun* | boolean | |
| projectId* | string | UUID string. |
| idempotencyKey* | string | |
| expectedRevision* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"items",
"expectedRevision",
"dryRun",
"idempotencyKey"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"at",
"duration",
"preset",
"text"
],
"properties": {
"at": {
"type": "number",
"maximum": 86400,
"minimum": 0
},
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,80}$"
},
"cta": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Required for end-screen."
},
"text": {
"type": "string",
"maxLength": 220,
"minLength": 1,
"description": "Heading, or quote. Max 120 characters except quote: 220."
},
"focus": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"y": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"width": {
"type": "number",
"maximum": 1,
"exclusiveMinimum": 0
},
"height": {
"type": "number",
"maximum": 1,
"exclusiveMinimum": 0
}
},
"description": "Required for screenshot-focus. Normalized rectangle inside the source image.",
"additionalProperties": false
},
"steps": {
"type": "array",
"items": {
"type": "string",
"maxLength": 48,
"minLength": 1
},
"maxItems": 5,
"minItems": 2,
"description": "Required for steps."
},
"value": {
"type": "number",
"maximum": 999999,
"minimum": -999999,
"description": "Required for key-number."
},
"number": {
"type": "string",
"maxLength": 4,
"minLength": 1,
"description": "Required for chapter."
},
"preset": {
"enum": [
"broll-headline",
"steps",
"quote",
"end-screen",
"key-number",
"before-after",
"screenshot-focus",
"chapter"
],
"type": "string"
},
"suffix": {
"type": "string",
"maxLength": 8,
"description": "Required for key-number; empty string allowed."
},
"assetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Required for broll-headline and screenshot-focus."
},
"duration": {
"type": "number",
"maximum": 30,
"minimum": 1
},
"attribution": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Required for quote."
},
"logoAssetId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"description": "Required for end-screen; null for no logo."
},
"afterAssetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Required for before-after."
},
"beforeAssetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Required for before-after."
}
},
"additionalProperties": false
},
"maxItems": 20,
"minItems": 1,
"description": "Supply only the fields for the selected preset."
},
"dryRun": {
"type": "boolean"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}Start extracting a brand profile from the exact website the user supplied and authorized to scan. Saves a draft profile for review; does not apply discovered fields to existing videos. Can spend existing account credits.
| Argument | Type | Description |
|---|---|---|
| websiteUrl* | string | |
| workspaceId* | any | |
| idempotencyKey* | string | |
| confirmAuthorizedToScan* | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"websiteUrl",
"confirmAuthorizedToScan"
],
"properties": {
"websiteUrl": {
"type": "string",
"format": "uri",
"maxLength": 2048
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"confirmAuthorizedToScan": {
"type": "boolean",
"const": true
}
},
"additionalProperties": false
}Read one authorized website extraction run and its draft business profile. Show the extracted fields to the user for review before saving them as defaults.
| Argument | Type | Description |
|---|---|---|
| runId* | string | UUID string. |
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"runId"
],
"properties": {
"runId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Read the selected workspace's business audience, offer, reviewed brand defaults, protected vocabulary, editorial purpose, language, avoided terms, pronunciation notes and existing account entitlements. Returns current export quality and watermark constraints without pricing or upgrade links.
| Argument | Type | Description |
|---|---|---|
| workspaceId* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId"
],
"properties": {
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}Save the user-reviewed business name, audience, offer, conversion goal, tone, protected vocabulary and editorial preferences for the selected workspace. Requires workspace settings permission and confirmReviewed=true; changes future assistant guidance, preserving existing projects. Pronunciation notes guide script drafting; they do not retime or replace source speech.
| Argument | Type | Description |
|---|---|---|
| tone* | any | |
| offer* | any | |
| audience* | any | |
| brandName* | any | |
| workspaceId* | any | |
| conversionGoal* | any | |
| idempotencyKey* | string | |
| protectedWords* | array | |
List bounded workspaces the connected user belongs to, with their role and default workspace. Selecting a workspace for the task does not change account defaults.
| Argument | Type | Description |
|---|---|---|
| limit* | integer | |
| offset* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"limit",
"offset"
],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}| expectedRevision |
| integer |
| Expected sequence revision, or null. |
{
"type": "object",
"required": [
"projectId",
"startSeconds",
"idempotencyKey"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"easing": {
"enum": [
"linear",
"easeIn",
"easeOut",
"easeInOut"
],
"type": "string",
"default": "easeInOut"
},
"preset": {
"enum": [
"flash",
"film-flash",
"whip-left",
"whip-right",
"zoom-punch",
"glitch"
],
"type": "string",
"default": "flash"
},
"intensity": {
"type": "number",
"default": 0.5,
"maximum": 2,
"minimum": 0.2
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"includeSfx": {
"type": "boolean",
"default": false
},
"layerIndex": {
"type": "integer",
"minimum": 0
},
"startSeconds": {
"type": "number",
"minimum": 0
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8,
"description": "Retry key. Reuse only with identical inputs."
},
"timelineItemId": {
"type": "string",
"format": "uuid"
},
"durationSeconds": {
"type": "number",
"default": 0.6,
"maximum": 10,
"minimum": 0,
"exclusiveMinimum": 0
},
"expectedRevision": {
"type": "integer",
"minimum": 0,
"description": "Expected sequence revision, or null."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"platform",
"name",
"slides",
"idempotencyKey"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"style": {
"type": "object",
"properties": {
"chip": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 32,
"minLength": 1
},
"radius": {
"type": "integer",
"maximum": 48,
"minimum": 0
},
"font_size": {
"type": "integer",
"maximum": 120,
"minimum": 12
},
"padding_x": {
"type": "integer",
"maximum": 80,
"minimum": 0
},
"padding_y": {
"type": "integer",
"maximum": 80,
"minimum": 0
},
"background": {
"type": "string",
"maxLength": 32,
"minLength": 1
},
"font_family": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"font_weight": {
"anyOf": [
{
"type": "integer",
"maximum": 900,
"minimum": 100
},
{
"type": "string"
}
]
},
"max_lines_per_chip": {
"type": "integer",
"maximum": 4,
"minimum": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"locale": {
"type": "string",
"maxLength": 12,
"minLength": 2
},
"slides": {
"type": "array",
"items": {
"type": "object",
"required": [
"lines",
"visual"
],
"properties": {
"role": {
"enum": [
"hook",
"body",
"proof",
"cta"
],
"type": "string"
},
"lines": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"default": [],
"maxItems": 6
},
"slots": {
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"additionalProperties": {
"type": "string",
"maxLength": 4000
}
},
"layout": {
"enum": [
"chip_stack_ui",
"chip_stack_face_safe",
"chip_stack_top",
"title_body_card"
],
"type": "string"
},
"visual": {
"type": "object",
"required": [
"kind"
],
"properties": {
"crop": {
"type": "object",
"required": [
"left",
"top",
"width",
"height"
],
"properties": {
"top": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"left": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"width": {
"type": "number",
"maximum": 1,
"exclusiveMinimum": 0
},
"height": {
"type": "number",
"maximum": 1,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"html": {
"type": "string",
"maxLength": 80000,
"minLength": 20
},
"kind": {
"enum": [
"creative_source",
"media_asset",
"generate",
"solid",
"gradient",
"html",
"template"
],
"type": "string"
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"colors": {
"type": "array",
"items": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"maxItems": 2,
"minItems": 1
},
"prompt": {
"type": "string",
"maxLength": 1000,
"minLength": 3
},
"model_id": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"template_id": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"media_asset_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"creative_artifact_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"source_media_asset_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
},
"layout_overrides": {
"type": "object",
"properties": {
"top_px": {
"type": "integer",
"maximum": 1920,
"minimum": 0
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 35,
"minItems": 1
},
"platform": {
"enum": [
"tiktok_photo",
"instagram_4x5",
"linkedin"
],
"type": "string"
},
"series_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"clear_existing": {
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
}
},
"additionalProperties": false
}| creativeArtifactId |
| string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"idempotencyKey",
"projectId",
"expectedRevision",
"slideIndex"
],
"properties": {
"crop": {
"anyOf": [
{
"type": "object",
"required": [
"left",
"top",
"width",
"height"
],
"properties": {
"top": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"left": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"width": {
"type": "number",
"maximum": 1,
"exclusiveMinimum": 0
},
"height": {
"type": "number",
"maximum": 1,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"lines": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 6
},
"slots": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"slideIndex": {
"type": "integer",
"maximum": 34,
"minimum": 0
},
"templateId": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"mediaAssetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"creativeArtifactId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
}| canonicalDescription |
| string |
| confirmLikenessConsent | boolean | For a human character, set true only after the user confirms consent to use the depicted person's likeness. |
| primaryReferenceAssetId | string |
| confirmRightsToReferences | boolean | Set true only after the user confirms they own the reference media or have permission to use it. |
{
"type": "object",
"required": [
"name",
"idempotencyKey"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"human",
"fictional",
"other"
],
"type": "string",
"default": "human"
},
"species": {
"type": "string"
},
"storyFacts": {
"type": "array",
"items": {
"type": "string"
}
},
"characterId": {
"type": "string"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace UUID. Defaults to the user's default workspace. UUID string."
},
"defaultVoiceId": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
},
"defaultVoiceStyle": {
"type": "string"
},
"referenceAssetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"canonicalDescription": {
"type": "string"
},
"confirmLikenessConsent": {
"type": "boolean",
"default": false,
"description": "For a human character, set true only after the user confirms consent to use the depicted person's likeness."
},
"primaryReferenceAssetId": {
"type": "string"
},
"confirmRightsToReferences": {
"type": "boolean",
"default": false,
"description": "Set true only after the user confirms they own the reference media or have permission to use it."
}
},
"additionalProperties": false
}| captionThemeId |
| string |
| Saved theme UUID or built-in caption look. Omitted inherits Series defaults; null uses workspace captions. |
| durationBounds | any | Requested clip duration bounds. Selection preserves complete moments; minimum cannot exceed maximum. |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
| autoTrimSilence | boolean | Trim silence around selected moments. |
| createSharePage | boolean | Create a public showcase page where completed clips appear. |
| selectedAudioLanguage | string | Audio language track for a social-video URL, using the language reported by media_import_inspect. Null uses source default. Existing assets and direct files preserve source audio. |
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Video URL to import before clipping. Supports social video links, Google Drive file links, and direct video file URLs."
},
"assetId": {
"type": "string",
"format": "uuid",
"description": "Existing BlitzReels video asset ID. Provide assetId or url, not both. UUID string."
},
"seriesId": {
"type": "string",
"description": "Optional Series UUID. Omitted inherits the source Series; null creates standalone clips."
},
"clipCount": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Maximum clips requested. Available source moments and account limits can yield fewer."
},
"selection": {
"anyOf": [
{
"type": "object",
"required": [
"includeIds",
"excludeIds"
],
"properties": {
"excludeIds": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 50,
"uniqueItems": true
},
"includeIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
},
"maxItems": 50,
"minItems": 1,
"uniqueItems": true
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null,
"description": "Existing asset only: reviewed candidate IDs to include in order or exclude. Resolve IDs with clips_candidates_list first. Null delegates selection."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
},
"clipPresetId": {
"enum": [
"default",
"high-retention",
"demo-focus"
],
"type": "string",
"default": "default",
"description": "Clip style preset. Use high-retention for High Retention clips or demo-focus for product and screen demos."
},
"captionThemeId": {
"type": "string",
"description": "Saved theme UUID or built-in caption look. Omitted inherits Series defaults; null uses workspace captions."
},
"durationBounds": {
"anyOf": [
{
"type": "object",
"required": [
"minSeconds",
"maxSeconds"
],
"properties": {
"maxSeconds": {
"type": [
"number",
"null"
],
"maximum": 180,
"minimum": 1
},
"minSeconds": {
"type": [
"number",
"null"
],
"maximum": 180,
"minimum": 1
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null,
"description": "Requested clip duration bounds. Selection preserves complete moments; minimum cannot exceed maximum."
},
"idempotencyKey": {
"type": "string",
"description": "Retry key. Reuse only with identical inputs."
},
"autoTrimSilence": {
"type": "boolean",
"default": true,
"description": "Trim silence around selected moments."
},
"createSharePage": {
"type": "boolean",
"default": false,
"description": "Create a public showcase page where completed clips appear."
},
"selectedAudioLanguage": {
"type": "string",
"maxLength": 40,
"minLength": 2,
"description": "Audio language track for a social-video URL, using the language reported by media_import_inspect. Null uses source default. Existing assets and direct files preserve source audio."
}
},
"additionalProperties": false
}| contentTypeHint | string |
| maxDurationSeconds | number |
| minDurationSeconds | number |
{
"type": "object",
"required": [
"clipId",
"selectionMode",
"idempotencyKey"
],
"properties": {
"clipId": {
"type": [
"string",
"null"
],
"default": null
},
"lookId": {
"type": "string"
},
"endSeconds": {
"type": "number"
},
"layoutMode": {
"enum": [
"auto",
"people_first",
"screen_first",
"preserve_full_source",
"prefer_split",
"prefer_focus",
"prefer_tutorial",
"prefer_demo"
],
"type": "string"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"startSeconds": {
"type": "number",
"minimum": 0
},
"suggestionId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"selectionMode": {
"enum": [
"auto_best",
"suggestion",
"time_range"
],
"type": [
"string",
"null"
],
"default": null
},
"idempotencyKey": {
"type": [
"string",
"null"
],
"default": null
},
"captionsEnabled": {
"type": "boolean"
},
"contentTypeHint": {
"enum": [
"auto",
"podcast",
"tutorial",
"demo",
"generic"
],
"type": "string"
},
"maxDurationSeconds": {
"type": "number"
},
"minDurationSeconds": {
"type": "number"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"platform",
"format",
"connectionIds",
"range",
"limit",
"offset",
"search"
],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1
},
"range": {
"enum": [
"7d",
"30d",
"90d",
"all"
],
"type": "string",
"default": "30d"
},
"format": {
"enum": [
"all",
"video",
"image",
"carousel"
],
"type": "string",
"default": "all"
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"search": {
"type": "string",
"default": "",
"maxLength": 200
},
"platform": {
"enum": [
"all",
"youtube",
"instagram",
"facebook",
"tiktok"
],
"type": "string",
"default": "all"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"connectionIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"maxItems": 50
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"seriesId",
"projectId",
"postId",
"id",
"expectedRevision",
"label",
"destination",
"enabled",
"workspaceId",
"idempotencyKey"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"label": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"postId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"seriesId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"projectId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"destination": {
"type": "string",
"format": "uri",
"maxLength": 2048
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}| attribution* | string |
| workspaceId* | any |
| idempotencyKey* | string |
| expectedRevision* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"seriesId",
"projectId",
"postId",
"id",
"expectedRevision",
"kind",
"value",
"unit",
"occurredAt",
"source",
"attribution",
"voided",
"workspaceId",
"idempotencyKey"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"enum": [
"leads",
"sales",
"revenue",
"other"
],
"type": "string"
},
"unit": {
"type": "string",
"maxLength": 32,
"minLength": 1
},
"value": {
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"multipleOf": 0.000001
},
"postId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"source": {
"type": "string",
"maxLength": 1000,
"minLength": 1
},
"voided": {
"type": "boolean"
},
"seriesId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"projectId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"occurredAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"attribution": {
"enum": [
"unknown",
"self_reported"
],
"type": "string"
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"assetId",
"startSeconds",
"durationSeconds",
"layerIndex",
"workspaceId",
"idempotencyKey",
"projectId",
"expectedRevision",
"dryRun"
],
"properties": {
"dryRun": {
"type": "boolean",
"default": true
},
"assetId": {
"type": "string",
"format": "uuid",
"minLength": 1,
"description": "UUID string."
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"layerIndex": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
{
"type": "null"
}
]
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"startSeconds": {
"type": "number",
"minimum": 0
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"durationSeconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"itemId",
"volume",
"fadeInSeconds",
"fadeOutSeconds",
"workspaceId",
"idempotencyKey",
"projectId",
"expectedRevision",
"dryRun"
],
"properties": {
"dryRun": {
"type": "boolean",
"default": true
},
"itemId": {
"type": "string"
},
"volume": {
"type": "number",
"maximum": 2,
"minimum": 0
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"fadeInSeconds": {
"type": "number",
"minimum": 0
},
"fadeOutSeconds": {
"type": "number",
"minimum": 0
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}| idempotencyKey* |
| string |
| expectedRevision* | integer |
{
"type": "object",
"$defs": {
"__schema0": {
"enum": [
"preserve",
"detach"
],
"type": "string"
},
"__schema1": {
"type": "object",
"required": [
"frames",
"placements"
],
"properties": {
"frames": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"placements": {
"enum": [
"preserve",
"resizeAll"
],
"type": "string"
}
},
"additionalProperties": false
},
"__schema2": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema3"
},
"maxItems": 500,
"minItems": 1
},
"__schema3": {
"oneOf": [
{
"type": "object",
"required": [
"kind",
"element",
"into",
"beforeId"
],
"properties": {
"into": {
"$ref": "#/$defs/__schema84"
},
"kind": {
"type": "string",
"const": "insert"
},
"element": {
"$ref": "#/$defs/__schema4"
},
"beforeId": {
"$ref": "#/$defs/__schema85"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"elementId",
"into",
"beforeId",
"coordinates"
],
"properties": {
"into": {
"$ref": "#/$defs/__schema84"
},
"kind": {
"type": "string",
"const": "move"
},
"beforeId": {
"$ref": "#/$defs/__schema85"
},
"elementId": {
"type": "string",
"minLength": 1
},
"coordinates": {
"type": "string",
"const": "preserveLocal"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"elementId"
],
"properties": {
"kind": {
"type": "string",
"const": "remove"
},
"elementId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
]
},
"__schema4": {
"oneOf": [
{
"type": "object",
"required": [
"id",
"type",
"content"
],
"properties": {
"id": {
"$ref": "#/$defs/__schema5"
},
"from": {
"$ref": "#/$defs/__schema7"
},
"name": {
"$ref": "#/$defs/__schema6"
},
"type": {
"type": "string",
"const": "text"
},
"style": {
"$ref": "#/$defs/__schema10"
},
"layout": {
"$ref": "#/$defs/__schema83"
},
"content": {
"type": "string"
},
"highlight": {
"type": "object",
"required": [
"words",
"color"
],
"properties": {
"color": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"stagger": {
"type": "number"
}
},
"additionalProperties": false
},
"typewriter": {
"type": "object",
"properties": {
"delay": {
"type": "number",
"minimum": 0
},
"cursor": {
"type": "boolean"
},
"charsPerFrame": {
"type": "number",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"premountFor": {
"$ref": "#/$defs/__schema9"
},
"durationInFrames": {
"$ref": "#/$defs/__schema8"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"shape"
],
"properties": {
"id": {
"$ref": "#/$defs/__schema5"
},
"fill": {
"type": "string"
},
"from": {
"$ref": "#/$defs/__schema7"
},
"name": {
"$ref": "#/$defs/__schema6"
},
"path": {
"type": "string"
},
"type": {
"type": "string",
"const": "shape"
},
"shape": {
"enum": [
"rectangle",
"circle",
"ellipse",
"line",
"arrow",
"polygon",
"star"
],
"type": "string"
},
"style": {
"$ref": "#/$defs/__schema10"
},
"layout": {
"$ref": "#/$defs/__schema83"
},
"points": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 3
},
"stroke": {
"type": "string"
},
"endPoint": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"pathData": {
"type": "string"
},
"fillColor": {
"type": "string"
},
"startPoint": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"innerRadius": {
"type": "number"
},
"premountFor": {
"$ref": "#/$defs/__schema9"
},
"strokeColor": {
"type": "string"
},
"strokeWidth": {
"$ref": "#/$defs/__schema12"
},
"durationInFrames": {
"$ref": "#/$defs/__schema8"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"src"
],
"properties": {
"id": {
"$ref": "#/$defs/__schema5"
},
"fit": {
"enum": [
"cover",
"contain",
"fill",
"none"
],
"type": "string"
},
"src": {
"type": "string"
},
"from": {
"$ref": "#/$defs/__schema7"
},
"name": {
"$ref": "#/$defs/__schema6"
},
"type": {
"type": "string",
"const": "image"
},
"style": {
"$ref": "#/$defs/__schema10"
},
"layout": {
"$ref": "#/$defs/__schema83"
},
"kenBurns": {
"type": "object",
"required": [
"startScale",
"endScale"
],
"properties": {
"endX": {
"type": "number"
},
"endY": {
"type": "number"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"endScale": {
"type": "number"
},
"startScale": {
"type": "number"
}
},
"additionalProperties": false
},
"objectFit": {
"enum": [
"cover",
"contain",
"fill",
"none"
],
"type": "string"
},
"premountFor": {
"$ref": "#/$defs/__schema9"
},
"durationInFrames": {
"$ref": "#/$defs/__schema8"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"src"
],
"properties": {
"id": {
"$ref": "#/$defs/__schema5"
},
"fit": {
"enum": [
"cover",
"contain",
"fill"
],
"type": "string"
},
"src": {
"type": "string"
},
"from": {
"$ref": "#/$defs/__schema7"
},
"loop": {
"type": "boolean"
},
"name": {
"$ref": "#/$defs/__schema6"
},
"type": {
"type": "string",
"const": "video"
},
"endAt": {
"type": "number",
"minimum": 0
},
"muted": {
"type": "boolean"
},
"style": {
"$ref": "#/$defs/__schema10"
},
"layout": {
"$ref": "#/$defs/__schema83"
},
"volume": {
"$ref": "#/$defs/__schema12"
},
"startFrom": {
"type": "number",
"minimum": 0
},
"premountFor": {
"$ref": "#/$defs/__schema9"
},
"playbackRate": {
"type": "number",
"exclusiveMinimum": 0
},
"durationInFrames": {
"$ref": "#/$defs/__schema8"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"src"
],
"properties": {
"id": {
"$ref": "#/$defs/__schema5"
},
"src": {
"type": "string"
},
"from": {
"$ref": "#/$defs/__schema7"
},
"loop": {
"type": "boolean"
},
"name": {
"$ref": "#/$defs/__schema6"
},
"type": {
"type": "string",
"const": "audio"
},
"endAt": {
"type": "number",
"minimum": 0
},
"style": {
"$ref": "#/$defs/__schema10"
},
"layout": {
"$ref": "#/$defs/__schema83"
},
"volume": {
"$ref": "#/$defs/__schema12"
},
"startFrom": {
"type": "number",
"minimum": 0
},
"premountFor": {
"$ref": "#/$defs/__schema9"
},
"playbackRate": {
"type": "number",
"exclusiveMinimum": 0
},
"durationInFrames": {
"$ref": "#/$defs/__schema8"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"chartType",
"data"
],
"properties": {
"id": {
"$ref": "#/$defs/__schema5"
},
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value"
],
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
},
"from": {
"$ref": "#/$defs/__schema7"
},
"name": {
"$ref": "#/$defs/__schema6"
},
"type": {
"type": "string",
"const": "chart"
},
"style": {
"$ref": "#/$defs/__schema10"
},
"layout": {
"$ref": "#/$defs/__schema83"
},
"stagger": {
"type": "number"
},
"chartType": {
"enum": [
"bar",
"pie",
"line",
"area",
"donut"
],
"type": "string"
},
"showLabels": {
"type": "boolean"
},
"showValues": {
"type": "boolean"
},
"animateFrom": {
"enum": [
"bottom",
"left",
"center"
],
"type": "string"
},
"premountFor": {
"$ref": "#/$defs/__schema9"
},
"staggerDelay": {
"type": "number"
},
"durationInFrames": {
"$ref": "#/$defs/__schema8"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"code",
"language"
],
"properties": {
"id": {
"$ref": "#/$defs/__schema5"
},
"code": {
"type": "string"
},
"from": {
"$ref": "#/$defs/__schema7"
},
"name": {
"$ref": "#/$defs/__schema6"
},
"type": {
"type": "string",
"const": "code"
},
"style": {
"$ref": "#/$defs/__schema10"
},
"theme": {
"enum": [
"dark",
"light",
"monokai",
"github",
"dracula"
],
"type": "string"
},
"layout": {
"$ref": "#/$defs/__schema83"
},
"reveal": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"typewriter",
"line-by-line",
"instant"
],
"type": "string"
},
"speed": {
"type": "number",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"language": {
"type": "string"
},
"lineByLine": {
"type": "object",
"required": [
"stagger"
],
"properties": {
"stagger": {
"type": "number"
}
},
"additionalProperties": false
},
"typewriter": {
"type": "boolean"
},
"premountFor": {
"$ref": "#/$defs/__schema9"
},
"highlightLines": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"showLineNumbers": {
"type": "boolean"
},
"durationInFrames": {
"$ref": "#/$defs/__schema8"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"svg"
],
"properties": {
"id": {
"$ref": "#/$defs/__schema5"
},
"svg": {
"type": "string"
},
"from": {
"$ref": "#/$defs/__schema7"
},
"name": {
"$ref": "#/$defs/__schema6"
},
"type": {
"type": "string",
"const": "svg"
},
"style": {
"$ref": "#/$defs/__schema10"
},
"layout": {
"$ref": "#/$defs/__schema83"
},
"content": {
"type": "string"
},
"viewBox": {
"type": "string"
},
"animatePath": {
"type": "object",
"required": [
"type"
],
"properties": {
"fill": {
"type": "string"
},
"type": {
"enum": [
"draw",
"morph"
],
"type": "string"
},
"stroke": {
"type": "string"
},
"progress": {
"$ref": "#/$defs/__schema12"
},
"targetPath": {
"type": "string"
},
"strokeWidth": {
"type": "number"
}
},
"additionalProperties": false
},
"premountFor": {
"$ref": "#/$defs/__schema9"
},
"strokeDasharray": {
"type": "string"
},
"durationInFrames": {
"$ref": "#/$defs/__schema8"
},
"strokeDashoffset": {
"$ref": "#/$defs/__schema12"
},
"preserveAspectRatio": {
"enum": [
"none",
"xMinYMin",
"xMidYMin",
"xMaxYMin",
"xMinYMid",
"xMidYMid",
"xMaxYMid",
"xMinYMax",
"xMidYMax"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"children"
],
"properties": {
"id": {
"$ref": "#/$defs/__schema5"
},
"from": {
"$ref": "#/$defs/__schema7"
},
"name": {
"$ref": "#/$defs/__schema6"
},
"type": {
"type": "string",
"const": "group"
},
"style": {
"$ref": "#/$defs/__schema10"
},
"layout": {
"$ref": "#/$defs/__schema83"
},
"series": {
"type": "boolean"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema4"
}
},
"premountFor": {
"$ref": "#/$defs/__schema9"
},
"durationInFrames": {
"$ref": "#/$defs/__schema8"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"type",
"animationData"
],
"properties": {
"id": {
"$ref": "#/$defs/__schema5"
},
"from": {
"$ref": "#/$defs/__schema7"
},
"loop": {
"type": "boolean"
},
"name": {
"$ref": "#/$defs/__schema6"
},
"type": {
"type": "string",
"const": "lottie"
},
"style": {
"$ref": "#/$defs/__schema10"
},
"layout": {
"$ref": "#/$defs/__schema83"
},
"renderer": {
"enum": [
"svg",
"canvas",
"html"
],
"type": "string"
},
"direction": {
"enum": [
"forward",
"backward"
],
"type": "string"
},
"assetsPath": {
"type": "string"
},
"premountFor": {
"$ref": "#/$defs/__schema9"
},
"playbackRate": {
"type": "number",
"exclusiveMinimum": 0
},
"animationData": {
"anyOf": [
{
"type": "object",
"required": [
"fr",
"w",
"h",
"op"
],
"properties": {
"h": {
"type": "number",
"exclusiveMinimum": 0
},
"w": {
"type": "number",
"exclusiveMinimum": 0
},
"fr": {
"type": "number",
"exclusiveMinimum": 0
},
"ip": {
"type": "number"
},
"op": {
"type": "number"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"layers": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
},
"additionalProperties": {}
},
{
"type": "string"
}
]
},
"sourceAssetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"durationInFrames": {
"$ref": "#/$defs/__schema8"
},
"preserveAspectRatio": {
"enum": [
"none",
"xMinYMin",
"xMidYMin",
"xMaxYMin",
"xMinYMid",
"xMidYMid",
"xMaxYMid",
"xMinYMax",
"xMidYMax"
],
"type": "string"
}
},
"additionalProperties": false
}
]
},
"__schema5": {
"type": "string",
"minLength": 1
},
"__schema6": {
"type": "string"
},
"__schema7": {
"type": "number",
"minimum": 0
},
"__schema8": {
"type": "number",
"exclusiveMinimum": 0
},
"__schema9": {
"type": "number",
"minimum": 0
},
"__schema10": {
"type": "object",
"properties": {
"x": {
"$ref": "#/$defs/__schema11"
},
"y": {
"$ref": "#/$defs/__schema17"
},
"gap": {
"$ref": "#/$defs/__schema48"
},
"top": {
"$ref": "#/$defs/__schema55"
},
"blur": {
"$ref": "#/$defs/__schema73"
},
"left": {
"$ref": "#/$defs/__schema56"
},
"color": {
"$ref": "#/$defs/__schema36"
},
"right": {
"$ref": "#/$defs/__schema57"
},
"scale": {
"$ref": "#/$defs/__schema19"
},
"skewX": {
"$ref": "#/$defs/__schema26"
},
"skewY": {
"$ref": "#/$defs/__schema27"
},
"width": {
"$ref": "#/$defs/__schema29"
},
"bottom": {
"$ref": "#/$defs/__schema58"
},
"height": {
"$ref": "#/$defs/__schema30"
},
"margin": {
"$ref": "#/$defs/__schema47"
},
"rotate": {
"$ref": "#/$defs/__schema22"
},
"scaleX": {
"$ref": "#/$defs/__schema20"
},
"scaleY": {
"$ref": "#/$defs/__schema21"
},
"zIndex": {
"$ref": "#/$defs/__schema59"
},
"display": {
"$ref": "#/$defs/__schema49"
},
"opacity": {
"$ref": "#/$defs/__schema28"
},
"padding": {
"$ref": "#/$defs/__schema46"
},
"rotateX": {
"$ref": "#/$defs/__schema23"
},
"rotateY": {
"$ref": "#/$defs/__schema24"
},
"rotateZ": {
"$ref": "#/$defs/__schema25"
},
"clipPath": {
"$ref": "#/$defs/__schema79"
},
"contrast": {
"$ref": "#/$defs/__schema75"
},
"flexWrap": {
"$ref": "#/$defs/__schema53"
},
"fontSize": {
"$ref": "#/$defs/__schema60"
},
"maxWidth": {
"$ref": "#/$defs/__schema32"
},
"minWidth": {
"$ref": "#/$defs/__schema31"
},
"overflow": {
"$ref": "#/$defs/__schema80"
},
"position": {
"$ref": "#/$defs/__schema54"
},
"saturate": {
"$ref": "#/$defs/__schema76"
},
"textWrap": {
"$ref": "#/$defs/__schema69"
},
"boxShadow": {
"$ref": "#/$defs/__schema41"
},
"boxSizing": {
"$ref": "#/$defs/__schema70"
},
"grayscale": {
"$ref": "#/$defs/__schema77"
},
"hueRotate": {
"$ref": "#/$defs/__schema78"
},
"maxHeight": {
"$ref": "#/$defs/__schema34"
},
"minHeight": {
"$ref": "#/$defs/__schema33"
},
"textAlign": {
"$ref": "#/$defs/__schema63"
},
"transform": {
"$ref": "#/$defs/__schema18"
},
"alignItems": {
"$ref": "#/$defs/__schema52"
},
"brightness": {
"$ref": "#/$defs/__schema74"
},
"fontFamily": {
"$ref": "#/$defs/__schema62"
},
"fontWeight": {
"$ref": "#/$defs/__schema61"
},
"lineHeight": {
"$ref": "#/$defs/__schema64"
},
"textShadow": {
"$ref": "#/$defs/__schema42"
},
"whiteSpace": {
"$ref": "#/$defs/__schema67"
},
"borderColor": {
"$ref": "#/$defs/__schema37"
},
"borderStyle": {
"$ref": "#/$defs/__schema40"
},
"borderWidth": {
"$ref": "#/$defs/__schema38"
},
"borderRadius": {
"$ref": "#/$defs/__schema39"
},
"textOverflow": {
"$ref": "#/$defs/__schema68"
},
"flexDirection": {
"$ref": "#/$defs/__schema50"
},
"letterSpacing": {
"$ref": "#/$defs/__schema65"
},
"textTransform": {
"$ref": "#/$defs/__schema66"
},
"justifyContent": {
"$ref": "#/$defs/__schema51"
},
"WebkitBoxOrient": {
"$ref": "#/$defs/__schema71"
},
"WebkitLineClamp": {
"$ref": "#/$defs/__schema72"
},
"backgroundColor": {
"$ref": "#/$defs/__schema35"
},
"bubbleJoinStyle": {
"$ref": "#/$defs/__schema82"
},
"boxDecorationBreak": {
"$ref": "#/$defs/__schema81"
},
"WebkitTextFillColor": {
"$ref": "#/$defs/__schema45"
},
"WebkitTextStrokeColor": {
"$ref": "#/$defs/__schema44"
},
"WebkitTextStrokeWidth": {
"$ref": "#/$defs/__schema43"
}
},
"additionalProperties": false
},
"__schema11": {
"$ref": "#/$defs/__schema12"
},
"__schema12": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "object",
"required": [
"timing"
],
"properties": {
"timing": {
"oneOf": [
{
"type": "object",
"required": [
"type",
"inputRange",
"outputRange"
],
"properties": {
"type": {
"type": "string",
"const": "interpolate"
},
"easing": {
"$ref": "#/$defs/__schema15"
},
"inputRange": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema13"
},
"minItems": 2
},
"outputRange": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema14"
},
"minItems": 2
},
"extrapolateLeft": {
"enum": [
"clamp",
"extend",
"identity"
],
"type": "string"
},
"extrapolateRight": {
"enum": [
"clamp",
"extend",
"identity"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "spring"
},
"delay": {
"type": "number"
},
"config": {
"anyOf": [
{
"type": "object",
"properties": {
"mass": {
"type": "number"
},
"damping": {
"type": "number"
},
"stiffness": {
"type": "number"
},
"overshootClamping": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"enum": [
"smooth",
"snappy",
"bouncy",
"heavy",
"gentle"
],
"type": "string"
}
]
},
"durationInFrames": {
"type": "number",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"keyframes"
],
"properties": {
"keyframes": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema16"
},
"minItems": 1
}
},
"additionalProperties": false
}
]
},
"__schema13": {
"type": "number"
},
"__schema14": {
"type": "number"
},
"__schema15": {
"oneOf": [
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "linear"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"curve"
],
"properties": {
"type": {
"enum": [
"in",
"out",
"inOut"
],
"type": "string"
},
"curve": {
"enum": [
"quad",
"sin",
"exp",
"circle",
"cubic",
"elastic",
"bounce"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"points"
],
"properties": {
"type": {
"type": "string",
"const": "bezier"
},
"points": {
"type": "array",
"items": false,
"maxItems": 4,
"minItems": 4,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
}
},
"additionalProperties": false
}
]
},
"__schema16": {
"type": "object",
"required": [
"frame",
"value"
],
"properties": {
"frame": {
"type": "number",
"minimum": 0
},
"value": {
"type": "number"
},
"easing": {
"$ref": "#/$defs/__schema15"
}
},
"additionalProperties": false
},
"__schema17": {
"$ref": "#/$defs/__schema12"
},
"__schema18": {
"type": "string"
},
"__schema19": {
"$ref": "#/$defs/__schema12"
},
"__schema20": {
"$ref": "#/$defs/__schema12"
},
"__schema21": {
"$ref": "#/$defs/__schema12"
},
"__schema22": {
"$ref": "#/$defs/__schema12"
},
"__schema23": {
"$ref": "#/$defs/__schema12"
},
"__schema24": {
"$ref": "#/$defs/__schema12"
},
"__schema25": {
"$ref": "#/$defs/__schema12"
},
"__schema26": {
"$ref": "#/$defs/__schema12"
},
"__schema27": {
"$ref": "#/$defs/__schema12"
},
"__schema28": {
"$ref": "#/$defs/__schema12"
},
"__schema29": {
"$ref": "#/$defs/__schema12"
},
"__schema30": {
"$ref": "#/$defs/__schema12"
},
"__schema31": {
"$ref": "#/$defs/__schema12"
},
"__schema32": {
"$ref": "#/$defs/__schema12"
},
"__schema33": {
"$ref": "#/$defs/__schema12"
},
"__schema34": {
"$ref": "#/$defs/__schema12"
},
"__schema35": {
"type": "string"
},
"__schema36": {
"type": "string"
},
"__schema37": {
"type": "string"
},
"__schema38": {
"$ref": "#/$defs/__schema12"
},
"__schema39": {
"$ref": "#/$defs/__schema12"
},
"__schema40": {
"enum": [
"solid",
"dashed",
"dotted",
"none"
],
"type": "string"
},
"__schema41": {
"type": "string"
},
"__schema42": {
"type": "string"
},
"__schema43": {
"$ref": "#/$defs/__schema12"
},
"__schema44": {
"type": "string"
},
"__schema45": {
"type": "string"
},
"__schema46": {
"type": [
"number",
"string"
]
},
"__schema47": {
"type": [
"number",
"string"
]
},
"__schema48": {
"type": [
"number",
"string"
]
},
"__schema49": {
"enum": [
"flex",
"block",
"inline",
"inline-flex",
"grid",
"none",
"-webkit-box"
],
"type": "string"
},
"__schema50": {
"enum": [
"row",
"column",
"row-reverse",
"column-reverse"
],
"type": "string"
},
"__schema51": {
"enum": [
"flex-start",
"flex-end",
"center",
"space-between",
"space-around",
"space-evenly"
],
"type": "string"
},
"__schema52": {
"enum": [
"flex-start",
"flex-end",
"center",
"stretch",
"baseline"
],
"type": "string"
},
"__schema53": {
"enum": [
"wrap",
"nowrap",
"wrap-reverse"
],
"type": "string"
},
"__schema54": {
"enum": [
"relative",
"absolute",
"fixed"
],
"type": "string"
},
"__schema55": {
"$ref": "#/$defs/__schema12"
},
"__schema56": {
"$ref": "#/$defs/__schema12"
},
"__schema57": {
"$ref": "#/$defs/__schema12"
},
"__schema58": {
"$ref": "#/$defs/__schema12"
},
"__schema59": {
"type": "number"
},
"__schema60": {
"$ref": "#/$defs/__schema12"
},
"__schema61": {
"type": [
"number",
"string"
]
},
"__schema62": {
"type": "string"
},
"__schema63": {
"enum": [
"left",
"center",
"right",
"justify"
],
"type": "string"
},
"__schema64": {
"type": [
"number",
"string"
]
},
"__schema65": {
"$ref": "#/$defs/__schema12"
},
"__schema66": {
"enum": [
"none",
"uppercase",
"lowercase",
"capitalize"
],
"type": "string"
},
"__schema67": {
"enum": [
"normal",
"nowrap",
"pre",
"pre-wrap",
"pre-line"
],
"type": "string"
},
"__schema68": {
"enum": [
"clip",
"ellipsis"
],
"type": "string"
},
"__schema69": {
"enum": [
"wrap",
"nowrap",
"balance",
"pretty"
],
"type": "string"
},
"__schema70": {
"enum": [
"border-box",
"content-box"
],
"type": "string"
},
"__schema71": {
"enum": [
"horizontal",
"vertical"
],
"type": "string"
},
"__schema72": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"__schema73": {
"$ref": "#/$defs/__schema12"
},
"__schema74": {
"$ref": "#/$defs/__schema12"
},
"__schema75": {
"$ref": "#/$defs/__schema12"
},
"__schema76": {
"$ref": "#/$defs/__schema12"
},
"__schema77": {
"$ref": "#/$defs/__schema12"
},
"__schema78": {
"$ref": "#/$defs/__schema12"
},
"__schema79": {
"type": "string"
},
"__schema80": {
"enum": [
"visible",
"hidden",
"scroll",
"auto"
],
"type": "string"
},
"__schema81": {
"enum": [
"slice",
"clone"
],
"type": "string"
},
"__schema82": {
"enum": [
"connected",
"reverse-radius"
],
"type": "string"
},
"__schema83": {
"enum": [
"none",
"absolute-fill"
],
"type": "string"
},
"__schema84": {
"oneOf": [
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "composition"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"sceneId"
],
"properties": {
"type": {
"type": "string",
"const": "scene"
},
"sceneId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"elementId"
],
"properties": {
"type": {
"type": "string",
"const": "group"
},
"elementId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
]
},
"__schema85": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"__schema86": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema87"
},
"maxItems": 500
},
"__schema87": {
"type": "object",
"required": [
"elementId"
],
"properties": {
"style": {
"$ref": "#/$defs/__schema90"
},
"content": {
"$ref": "#/$defs/__schema89"
},
"elementId": {
"$ref": "#/$defs/__schema88"
}
},
"additionalProperties": false
},
"__schema88": {
"type": "string",
"minLength": 1
},
"__schema89": {
"type": "string"
},
"__schema90": {
"type": "object",
"properties": {
"x": {
"$ref": "#/$defs/__schema91"
},
"y": {
"$ref": "#/$defs/__schema92"
},
"gap": {
"$ref": "#/$defs/__schema123"
},
"top": {
"$ref": "#/$defs/__schema130"
},
"blur": {
"$ref": "#/$defs/__schema148"
},
"left": {
"$ref": "#/$defs/__schema131"
},
"color": {
"$ref": "#/$defs/__schema111"
},
"right": {
"$ref": "#/$defs/__schema132"
},
"scale": {
"$ref": "#/$defs/__schema94"
},
"skewX": {
"$ref": "#/$defs/__schema101"
},
"skewY": {
"$ref": "#/$defs/__schema102"
},
"width": {
"$ref": "#/$defs/__schema104"
},
"bottom": {
"$ref": "#/$defs/__schema133"
},
"height": {
"$ref": "#/$defs/__schema105"
},
"margin": {
"$ref": "#/$defs/__schema122"
},
"rotate": {
"$ref": "#/$defs/__schema97"
},
"scaleX": {
"$ref": "#/$defs/__schema95"
},
"scaleY": {
"$ref": "#/$defs/__schema96"
},
"zIndex": {
"$ref": "#/$defs/__schema134"
},
"display": {
"$ref": "#/$defs/__schema124"
},
"opacity": {
"$ref": "#/$defs/__schema103"
},
"padding": {
"$ref": "#/$defs/__schema121"
},
"rotateX": {
"$ref": "#/$defs/__schema98"
},
"rotateY": {
"$ref": "#/$defs/__schema99"
},
"rotateZ": {
"$ref": "#/$defs/__schema100"
},
"clipPath": {
"$ref": "#/$defs/__schema154"
},
"contrast": {
"$ref": "#/$defs/__schema150"
},
"flexWrap": {
"$ref": "#/$defs/__schema128"
},
"fontSize": {
"$ref": "#/$defs/__schema135"
},
"maxWidth": {
"$ref": "#/$defs/__schema107"
},
"minWidth": {
"$ref": "#/$defs/__schema106"
},
"overflow": {
"$ref": "#/$defs/__schema155"
},
"position": {
"$ref": "#/$defs/__schema129"
},
"saturate": {
"$ref": "#/$defs/__schema151"
},
"textWrap": {
"$ref": "#/$defs/__schema144"
},
"boxShadow": {
"$ref": "#/$defs/__schema116"
},
"boxSizing": {
"$ref": "#/$defs/__schema145"
},
"grayscale": {
"$ref": "#/$defs/__schema152"
},
"hueRotate": {
"$ref": "#/$defs/__schema153"
},
"maxHeight": {
"$ref": "#/$defs/__schema109"
},
"minHeight": {
"$ref": "#/$defs/__schema108"
},
"textAlign": {
"$ref": "#/$defs/__schema138"
},
"transform": {
"$ref": "#/$defs/__schema93"
},
"alignItems": {
"$ref": "#/$defs/__schema127"
},
"brightness": {
"$ref": "#/$defs/__schema149"
},
"fontFamily": {
"$ref": "#/$defs/__schema137"
},
"fontWeight": {
"$ref": "#/$defs/__schema136"
},
"lineHeight": {
"$ref": "#/$defs/__schema139"
},
"textShadow": {
"$ref": "#/$defs/__schema117"
},
"whiteSpace": {
"$ref": "#/$defs/__schema142"
},
"borderColor": {
"$ref": "#/$defs/__schema112"
},
"borderStyle": {
"$ref": "#/$defs/__schema115"
},
"borderWidth": {
"$ref": "#/$defs/__schema113"
},
"borderRadius": {
"$ref": "#/$defs/__schema114"
},
"textOverflow": {
"$ref": "#/$defs/__schema143"
},
"flexDirection": {
"$ref": "#/$defs/__schema125"
},
"letterSpacing": {
"$ref": "#/$defs/__schema140"
},
"textTransform": {
"$ref": "#/$defs/__schema141"
},
"justifyContent": {
"$ref": "#/$defs/__schema126"
},
"WebkitBoxOrient": {
"$ref": "#/$defs/__schema146"
},
"WebkitLineClamp": {
"$ref": "#/$defs/__schema147"
},
"backgroundColor": {
"$ref": "#/$defs/__schema110"
},
"bubbleJoinStyle": {
"$ref": "#/$defs/__schema157"
},
"boxDecorationBreak": {
"$ref": "#/$defs/__schema156"
},
"WebkitTextFillColor": {
"$ref": "#/$defs/__schema120"
},
"WebkitTextStrokeColor": {
"$ref": "#/$defs/__schema119"
},
"WebkitTextStrokeWidth": {
"$ref": "#/$defs/__schema118"
}
},
"additionalProperties": false
},
"__schema91": {
"anyOf": [
{
"$ref": "#/$defs/__schema11",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema92": {
"anyOf": [
{
"$ref": "#/$defs/__schema17",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema93": {
"anyOf": [
{
"$ref": "#/$defs/__schema18",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema94": {
"anyOf": [
{
"$ref": "#/$defs/__schema19",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema95": {
"anyOf": [
{
"$ref": "#/$defs/__schema20",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema96": {
"anyOf": [
{
"$ref": "#/$defs/__schema21",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema97": {
"anyOf": [
{
"$ref": "#/$defs/__schema22",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema98": {
"anyOf": [
{
"$ref": "#/$defs/__schema23",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema99": {
"anyOf": [
{
"$ref": "#/$defs/__schema24",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema100": {
"anyOf": [
{
"$ref": "#/$defs/__schema25",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema101": {
"anyOf": [
{
"$ref": "#/$defs/__schema26",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema102": {
"anyOf": [
{
"$ref": "#/$defs/__schema27",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema103": {
"anyOf": [
{
"$ref": "#/$defs/__schema28",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema104": {
"anyOf": [
{
"$ref": "#/$defs/__schema29",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema105": {
"anyOf": [
{
"$ref": "#/$defs/__schema30",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema106": {
"anyOf": [
{
"$ref": "#/$defs/__schema31",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema107": {
"anyOf": [
{
"$ref": "#/$defs/__schema32",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema108": {
"anyOf": [
{
"$ref": "#/$defs/__schema33",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema109": {
"anyOf": [
{
"$ref": "#/$defs/__schema34",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema110": {
"anyOf": [
{
"$ref": "#/$defs/__schema35",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema111": {
"anyOf": [
{
"$ref": "#/$defs/__schema36",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema112": {
"anyOf": [
{
"$ref": "#/$defs/__schema37",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema113": {
"anyOf": [
{
"$ref": "#/$defs/__schema38",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema114": {
"anyOf": [
{
"$ref": "#/$defs/__schema39",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema115": {
"anyOf": [
{
"$ref": "#/$defs/__schema40",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema116": {
"anyOf": [
{
"$ref": "#/$defs/__schema41",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema117": {
"anyOf": [
{
"$ref": "#/$defs/__schema42",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema118": {
"anyOf": [
{
"$ref": "#/$defs/__schema43",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema119": {
"anyOf": [
{
"$ref": "#/$defs/__schema44",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema120": {
"anyOf": [
{
"$ref": "#/$defs/__schema45",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema121": {
"anyOf": [
{
"$ref": "#/$defs/__schema46",
"type": [
"number",
"string"
]
},
{
"type": "null"
}
]
},
"__schema122": {
"anyOf": [
{
"$ref": "#/$defs/__schema47",
"type": [
"number",
"string"
]
},
{
"type": "null"
}
]
},
"__schema123": {
"anyOf": [
{
"$ref": "#/$defs/__schema48",
"type": [
"number",
"string"
]
},
{
"type": "null"
}
]
},
"__schema124": {
"anyOf": [
{
"$ref": "#/$defs/__schema49",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema125": {
"anyOf": [
{
"$ref": "#/$defs/__schema50",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema126": {
"anyOf": [
{
"$ref": "#/$defs/__schema51",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema127": {
"anyOf": [
{
"$ref": "#/$defs/__schema52",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema128": {
"anyOf": [
{
"$ref": "#/$defs/__schema53",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema129": {
"anyOf": [
{
"$ref": "#/$defs/__schema54",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema130": {
"anyOf": [
{
"$ref": "#/$defs/__schema55",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema131": {
"anyOf": [
{
"$ref": "#/$defs/__schema56",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema132": {
"anyOf": [
{
"$ref": "#/$defs/__schema57",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema133": {
"anyOf": [
{
"$ref": "#/$defs/__schema58",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema134": {
"anyOf": [
{
"$ref": "#/$defs/__schema59",
"type": "number"
},
{
"type": "null"
}
]
},
"__schema135": {
"anyOf": [
{
"$ref": "#/$defs/__schema60",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema136": {
"anyOf": [
{
"$ref": "#/$defs/__schema61",
"type": [
"number",
"string"
]
},
{
"type": "null"
}
]
},
"__schema137": {
"anyOf": [
{
"$ref": "#/$defs/__schema62",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema138": {
"anyOf": [
{
"$ref": "#/$defs/__schema63",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema139": {
"anyOf": [
{
"$ref": "#/$defs/__schema64",
"type": [
"number",
"string"
]
},
{
"type": "null"
}
]
},
"__schema140": {
"anyOf": [
{
"$ref": "#/$defs/__schema65",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema141": {
"anyOf": [
{
"$ref": "#/$defs/__schema66",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema142": {
"anyOf": [
{
"$ref": "#/$defs/__schema67",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema143": {
"anyOf": [
{
"$ref": "#/$defs/__schema68",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema144": {
"anyOf": [
{
"$ref": "#/$defs/__schema69",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema145": {
"anyOf": [
{
"$ref": "#/$defs/__schema70",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema146": {
"anyOf": [
{
"$ref": "#/$defs/__schema71",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema147": {
"anyOf": [
{
"$ref": "#/$defs/__schema72",
"type": "integer"
},
{
"type": "null"
}
]
},
"__schema148": {
"anyOf": [
{
"$ref": "#/$defs/__schema73",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema149": {
"anyOf": [
{
"$ref": "#/$defs/__schema74",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema150": {
"anyOf": [
{
"$ref": "#/$defs/__schema75",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema151": {
"anyOf": [
{
"$ref": "#/$defs/__schema76",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema152": {
"anyOf": [
{
"$ref": "#/$defs/__schema77",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema153": {
"anyOf": [
{
"$ref": "#/$defs/__schema78",
"type": [
"number",
"string",
"object"
]
},
{
"type": "null"
}
]
},
"__schema154": {
"anyOf": [
{
"$ref": "#/$defs/__schema79",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema155": {
"anyOf": [
{
"$ref": "#/$defs/__schema80",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema156": {
"anyOf": [
{
"$ref": "#/$defs/__schema81",
"type": "string"
},
{
"type": "null"
}
]
},
"__schema157": {
"anyOf": [
{
"$ref": "#/$defs/__schema82",
"type": "string"
},
{
"type": "null"
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"itemId",
"edit",
"workspaceId",
"idempotencyKey",
"projectId",
"expectedRevision",
"dryRun"
],
"properties": {
"edit": {
"type": "object",
"required": [
"ownership",
"changes"
],
"properties": {
"changes": {
"$ref": "#/$defs/__schema86"
},
"duration": {
"$ref": "#/$defs/__schema1"
},
"ownership": {
"$ref": "#/$defs/__schema0"
},
"structure": {
"$ref": "#/$defs/__schema2"
}
},
"additionalProperties": false
},
"dryRun": {
"type": "boolean",
"default": true
},
"itemId": {
"type": "string",
"minLength": 1
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}| durationSeconds* |
| number |
| expectedRevision* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"itemId",
"text",
"textKind",
"spec",
"startSeconds",
"durationSeconds",
"workspaceId",
"idempotencyKey",
"projectId",
"expectedRevision",
"dryRun"
],
"properties": {
"spec": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"text": {
"type": "string",
"minLength": 1
},
"dryRun": {
"type": "boolean",
"default": true
},
"itemId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"textKind": {
"enum": [
"overlay",
"title_card"
],
"type": "string"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"startSeconds": {
"type": "number",
"minimum": 0
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"durationSeconds": {
"type": "number",
"minimum": 0,
"exclusiveMinimum": 0
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}| Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| imageModelId | string | Model used to generate scene images. |
| captionStyleId | string | Optional caption theme ID from captions_themes_list. |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
| plannerModelId | string | Model used to plan the video scenes. |
| includeCaptions | boolean | Burn captions into the timeline. |
| generateVoiceover | boolean | Narrate the script with a generated voice. |
| generateSoundEffects | boolean | Add generated sound effects. |
| targetDurationSeconds | number | Target runtime between 10 and 120 seconds. |
| styleReferenceAssetIds | array | Optional stills that lock rendering medium, palette, lighting and texture. Not used as scene frames. |
| generateBackgroundMusic | boolean | Add a generated background track. |
{
"type": "object",
"required": [
"script"
],
"properties": {
"script": {
"type": "string",
"maxLength": 30000,
"minLength": 1,
"description": "The narration or story to turn into a video."
},
"voiceId": {
"type": "string",
"maxLength": 200,
"description": "Optional voice override from the BlitzReels voice catalog. The Story Kit narrator voice is used when omitted."
},
"seriesId": {
"type": "string",
"description": "Optional Series UUID. Inherits its Story Kit and branding defaults for this new video."
},
"storyKitId": {
"type": "string",
"description": "Reusable Story Kit UUID for characters, references, locations, style, and narrator voice."
},
"videoModel": {
"enum": [
"sync-lipsync-2",
"flux-3-max",
"heygen-video",
"omnihuman-v2",
"seedance-2.5-edit",
"kling-o3-standard-edit",
"kling-o3-pro-edit",
"kling-v3-standard-motion-control",
"kling-v3-pro-motion-control",
"wan-2.2-animate-replace",
"kling-2.1",
"kling-2.6-pro",
"kling-o1",
"kling-3.0",
"kling-o3-standard",
"kling-o3-pro",
"kling-o3-4k",
"kling-v3-pro",
"minimax-01",
"minimax-hailuo-02",
"minimax-hailuo-2.3-pro",
"minimax-h3-max",
"luma-ray-2",
"luma-ray-3.2",
"veo3",
"veo3.1",
"veo3.1-fast",
"gemini-omni-flash-ref2v",
"gemini-omni-flash-edit",
"gemini-omni-flash",
"wan-2.7",
"wan-2.7-ref2v",
"wan-3.0",
"wan-3.0-prime",
"happy-horse",
"happy-horse-ref2v",
"pixverse-v6",
"grok-imagine-lite",
"seedance-2.0-pro",
"seedance-2.5",
"seedance-2.0-pro-fast",
"seedance-2.0-ref2v",
"seedance-2.0-ref2v-fast",
"seedance-1.5-pro",
"seedance-1.0-pro",
"seedance-1.0-pro-fast",
"seedance-1.0-lite",
"seedance-1.0-lite-ref2v",
"ltx-2-19b",
"ltx-2-19b-distilled",
"ltx-2.3",
"ltx-2.3-fast"
],
"type": "string",
"default": "seedance-2.0-ref2v",
"description": "Image-to-video model used to animate scenes."
},
"projectName": {
"type": "string",
"default": "Faceless Video",
"maxLength": 200,
"minLength": 1,
"description": "Name for the created BlitzReels project."
},
"visualStyle": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Optional art direction override. A Story Kit style is used when omitted."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
},
"imageModelId": {
"type": "string",
"default": "fal-ai/nano-banana-pro",
"maxLength": 200,
"minLength": 3,
"description": "Model used to generate scene images."
},
"captionStyleId": {
"type": "string",
"maxLength": 200,
"description": "Optional caption theme ID from captions_themes_list."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8,
"description": "Retry key. Reuse only with identical inputs."
},
"plannerModelId": {
"type": "string",
"default": "google/gemini-3.8-flash",
"maxLength": 200,
"minLength": 3,
"description": "Model used to plan the video scenes."
},
"includeCaptions": {
"type": "boolean",
"default": true,
"description": "Burn captions into the timeline."
},
"generateVoiceover": {
"type": "boolean",
"default": true,
"description": "Narrate the script with a generated voice."
},
"generateSoundEffects": {
"type": "boolean",
"default": false,
"description": "Add generated sound effects."
},
"targetDurationSeconds": {
"type": "number",
"default": 45,
"maximum": 120,
"minimum": 10,
"description": "Target runtime between 10 and 120 seconds."
},
"styleReferenceAssetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"default": [],
"maxItems": 10,
"description": "Optional stills that lock rendering medium, palette, lighting and texture. Not used as scene frames."
},
"generateBackgroundMusic": {
"type": "boolean",
"default": false,
"description": "Add a generated background track."
}
},
"additionalProperties": false
}| string |
| Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| enhancePrompt | boolean | Enhance using BlitzReels model grammar and actual input context. |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
| referenceAssetIds | array | Ordered image references. Model-specific limits are listed in generation_options_list; unsupported references fail. |
{
"type": "object",
"required": [
"prompt"
],
"properties": {
"size": {
"anyOf": [
{
"type": "string",
"pattern": "^[1-9][0-9]{1,4}x[1-9][0-9]{1,4}$"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact output size as WIDTHxHEIGHT, for example 1920x2304. Only models whose parameters.size.supported is true in generation_options_list; it replaces aspectRatio, and credits scale with pixel count."
},
"model": {
"enum": [
"fal-ai/gpt-image-1",
"fal-ai/gpt-image-1.5",
"fal-ai/gpt-image-2",
"fal-ai/gpt-image-2.5-flare",
"fal-ai/gpt-image-2.5-sunburst",
"xai/grok-imagine-image-2.0",
"bfl/flux-3-image",
"bfl/flux-3-image-klein",
"fal-ai/bytedance/seedream/v5/lite/text-to-image",
"bytedance/seedream/v5/pro/text-to-image",
"fal-ai/krea-2/turbo",
"fal-ai/krea/v2/medium/turbo/text-to-image",
"fal-ai/krea/v2/medium/text-to-image",
"fal-ai/krea/v3/text-to-image",
"fal-ai/meta/muse-image/text-to-image",
"fal-ai/nano-banana-2",
"google/nano-banana-2.1",
"google/nano-banana-2-lite",
"fal-ai/nano-banana-pro"
],
"type": "string",
"default": "fal-ai/nano-banana-2",
"description": "Image model. Call generation_options_list for costs."
},
"prompt": {
"type": "string",
"maxLength": 5000,
"minLength": 8,
"description": "What the image should show (8-5000 characters)."
},
"folderId": {
"type": "string",
"format": "uuid",
"description": "Optional media library folder ID."
},
"resolution": {
"anyOf": [
{
"enum": [
"0.5k",
"1k",
"2k",
"4k"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Native image resolution. Call generation_options_list for model support and resolution pricing. Unsupported settings are rejected."
},
"aspectRatio": {
"enum": [
"1:1",
"16:9",
"9:16",
"4:3",
"3:4",
"3:2",
"2:3",
"5:4",
"4:5",
"21:9"
],
"type": "string",
"default": "1:1",
"description": "Output aspect ratio."
},
"characterId": {
"type": "string",
"format": "uuid",
"description": "Workspace character to keep consistent (characters_list). Its reference images or trained weights and description are added; they count toward the model reference limit."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
},
"enhancePrompt": {
"type": "boolean",
"default": false,
"description": "Enhance using BlitzReels model grammar and actual input context."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8,
"description": "Retry key. Reuse only with identical inputs."
},
"referenceAssetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"default": [],
"maxItems": 14,
"description": "Ordered image references. Model-specific limits are listed in generation_options_list; unsupported references fail."
}
},
"additionalProperties": false
}| aspectRatio | string | Output aspect ratio. |
| characterId | string | Workspace character to keep consistent (characters_list). Its reference images come first (@Image1 is the primary), capped to the model limit. Only models whose parameters.character_id.supported is true in generation_options_list. |
| workspaceId | string | Optional workspace ID. Defaults to the user's default workspace. UUID string. |
| enhancePrompt | boolean | Enhance using BlitzReels model grammar and actual input context. |
| generateAudio | boolean | null uses model audio behavior. Explicit true/false must be supported by the selected model. |
| sourceAssetId | string | First-frame still. Required only when that model's parameters.source_asset_id.required is true. Optional on reference-capable I2V including Seedance 2.5. Text-to-video rejects it. Cannot combine with reference arrays and end_frame_asset_id. |
| idempotencyKey | string | Retry key. Reuse only with identical inputs. |
| negativePrompt | string | What to avoid in the shot. |
| transformation | any |
| durationSeconds | integer | Video transformations inherit the processed source duration and aspect ratio; duration_seconds is not a trim request. Choose a value from the selected model's durations_seconds. duration_seconds_min and duration_seconds_max are the bounds of that list, not a continuous range. |
| endFrameAssetId | string | Last-frame still. Interpolates from the source first frame to this image across the full duration. Requires a source first frame; cannot combine with reference arrays. |
| referenceAssetIds | array | Ordered reference images: Seedance 2.5 up to 30; Seedance 2.0 ref2v up to 9; other reference models up to 4. Source counts toward the limit. |
| referenceAssetUris | array | BytePlus ModelArk real-human assets as asset://ID, for people who verified themselves in the BytePlus console. Requires provider byteplus-modelark and a model whose parameters.reference_asset_uris.supported is true in generation_options_list. They follow referenceAssetIds in @ImageN numbering and count toward the reference limit. |
| referenceVideoRange | any | Cut this range from the reference video before a character swap or video edit; billed for the range length. |
| referenceAudioAssetIds | array | Reference audio: Seedance 2.5 up to 10; Seedance 2.0 ref2v and fast up to 3. Other models reject them. |
| referenceVideoAssetIds | array | Video transformations require one processed source video. Other reference modes have model-specific counts published by generation_options_list. |
{
"type": "object",
"required": [
"prompt"
],
"properties": {
"seed": {
"type": "integer",
"description": "Optional seed for reproducible output."
},
"model": {
"enum": [
"sync-lipsync-2",
"flux-3-max",
"flux-3-max-t2v",
"heygen-video",
"heygen-video-t2v",
"omnihuman-v2",
"seedance-2.5-edit",
"kling-o3-standard-edit",
"kling-o3-pro-edit",
"kling-v3-standard-motion-control",
"kling-v3-pro-motion-control",
"wan-2.2-animate-replace",
"kling-2.1",
"kling-2.6-pro",
"kling-o1",
"kling-3.0",
"kling-o3-standard",
"kling-o3-pro",
"kling-o3-4k",
"kling-v3-pro",
"minimax-01",
"minimax-hailuo-02",
"minimax-hailuo-2.3-pro",
"minimax-h3-max",
"luma-ray-2",
"luma-ray-3.2",
"minimax-hailuo-2.3-pro-t2v",
"minimax-h3-max-t2v",
"luma-ray-3.2-t2v",
"veo3",
"veo3.1",
"veo3.1-fast",
"gemini-omni-flash-ref2v",
"gemini-omni-flash-edit",
"gemini-omni-flash",
"veo3-fast",
"gemini-omni-flash-t2v",
"wan-2.1",
"wan-2.7",
"wan-2.7-ref2v",
"wan-2.7-t2v",
"wan-3.0",
"wan-3.0-prime",
"wan-3.0-t2v",
"wan-3.0-prime-t2v",
"happy-horse",
"happy-horse-ref2v",
"happy-horse-t2v",
"pixverse-v6",
"pixverse-v6-t2v",
"krea-wan-14b-t2v",
"grok-imagine-lite",
"grok-imagine-lite-t2v",
"seedance-2.0-pro",
"seedance-2.5",
"seedance-2.0-pro-fast",
"seedance-2.0-ref2v",
"seedance-2.0-ref2v-fast",
"seedance-2.0-pro-t2v",
"seedance-2.5-t2v",
"seedance-2.0-pro-fast-t2v",
"seedance-1.5-pro",
"seedance-1.5-pro-t2v",
"seedance-1.0-pro",
"seedance-1.0-pro-t2v",
"seedance-1.0-pro-fast",
"seedance-1.0-pro-fast-t2v",
"seedance-1.0-lite",
"seedance-1.0-lite-t2v",
"seedance-1.0-lite-ref2v",
"kling-o3-standard-t2v",
"kling-o3-pro-t2v",
"kling-v3-standard-t2v",
"kling-v3-pro-t2v",
"ltx-2-19b",
"ltx-2-19b-distilled",
"ltx-2.3",
"ltx-2.3-fast",
"ltx-2-19b-t2v",
"ltx-2-19b-distilled-t2v",
"ltx-2.3-t2v",
"ltx-2.3-fast-t2v"
],
"type": "string",
"default": "wan-2.1",
"description": "Video model. generation_options_list publishes generation type, source limits, character controls, resolution and pricing for each model."
},
"prompt": {
"type": "string",
"maxLength": 5000,
"minLength": 3,
"description": "What should happen in the shot (3-5000 characters)."
},
"folderId": {
"type": "string",
"format": "uuid",
"description": "Optional media library folder ID."
},
"provider": {
"enum": [
"auto",
"byteplus-modelark",
"fal"
],
"type": "string",
"default": "auto",
"description": "Explicit provider must support the model and input mode. auto uses a configured compatible provider."
},
"provenance": {
"anyOf": [
{
"type": "object",
"required": [
"originalRequest",
"previousJobId"
],
"properties": {
"previousJobId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"originalRequest": {
"anyOf": [
{
"type": "string",
"maxLength": 40000,
"minLength": 1
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Original user request before prompt authoring, and previous failed job ID when retrying. Retained for review; never infer missing wording."
},
"resolution": {
"anyOf": [
{
"enum": [
"360p",
"480p",
"720p",
"768p",
"1080p",
"4k"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Output resolution. Call generation_options_list for model-specific supported values and defaults. Unsupported settings are rejected."
},
"aspectRatio": {
"enum": [
"9:16",
"16:9",
"1:1"
],
"type": "string",
"default": "9:16",
"description": "Output aspect ratio."
},
"characterId": {
"type": "string",
"format": "uuid",
"description": "Workspace character to keep consistent (characters_list). Its reference images come first (@Image1 is the primary), capped to the model limit. Only models whose parameters.character_id.supported is true in generation_options_list."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID. Defaults to the user's default workspace. UUID string."
},
"enhancePrompt": {
"type": "boolean",
"default": false,
"description": "Enhance using BlitzReels model grammar and actual input context."
},
"generateAudio": {
"type": "boolean",
"description": "null uses model audio behavior. Explicit true/false must be supported by the selected model."
},
"sourceAssetId": {
"type": "string",
"format": "uuid",
"description": "First-frame still. Required only when that model's parameters.source_asset_id.required is true. Optional on reference-capable I2V including Seedance 2.5. Text-to-video rejects it. Cannot combine with reference arrays and end_frame_asset_id."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8,
"description": "Retry key. Reuse only with identical inputs."
},
"negativePrompt": {
"type": "string",
"maxLength": 2500,
"description": "What to avoid in the shot."
},
"transformation": {
"anyOf": [
{
"type": "object",
"required": [
"characters",
"sourcePersonCount",
"keepOriginalAudio",
"characterOrientation"
],
"properties": {
"characters": {
"type": "array",
"items": {
"type": "object",
"required": [
"sourceRole",
"frontalAssetId",
"referenceAssetIds"
],
"properties": {
"sourceRole": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"frontalAssetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"referenceAssetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"default": [],
"maxItems": 3
}
},
"additionalProperties": false
},
"default": [],
"maxItems": 4
},
"keepOriginalAudio": {
"type": "boolean",
"default": true
},
"sourcePersonCount": {
"anyOf": [
{
"type": "integer",
"maximum": 1000,
"minimum": 1
},
{
"type": "null"
}
],
"default": null
},
"characterOrientation": {
"enum": [
"video",
"image"
],
"type": "string",
"default": "video"
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"default": null
},
"durationSeconds": {
"type": "integer",
"default": 5,
"maximum": 30,
"minimum": 2,
"description": "Video transformations inherit the processed source duration and aspect ratio; duration_seconds is not a trim request. Choose a value from the selected model's durations_seconds. duration_seconds_min and duration_seconds_max are the bounds of that list, not a continuous range."
},
"endFrameAssetId": {
"type": "string",
"format": "uuid",
"description": "Last-frame still. Interpolates from the source first frame to this image across the full duration. Requires a source first frame; cannot combine with reference arrays."
},
"referenceAssetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"default": [],
"maxItems": 30,
"description": "Ordered reference images: Seedance 2.5 up to 30; Seedance 2.0 ref2v up to 9; other reference models up to 4. Source counts toward the limit."
},
"referenceAssetUris": {
"type": "array",
"items": {
"type": "string",
"pattern": "^asset://[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
},
"default": [],
"maxItems": 30,
"description": "BytePlus ModelArk real-human assets as asset://ID, for people who verified themselves in the BytePlus console. Requires provider byteplus-modelark and a model whose parameters.reference_asset_uris.supported is true in generation_options_list. They follow referenceAssetIds in @ImageN numbering and count toward the reference limit."
},
"referenceVideoRange": {
"anyOf": [
{
"type": "object",
"required": [
"startSeconds",
"endSeconds"
],
"properties": {
"endSeconds": {
"type": "number",
"exclusiveMinimum": 0
},
"startSeconds": {
"type": "number",
"minimum": 0
}
}
},
{
"type": "null"
}
],
"default": null,
"description": "Cut this range from the reference video before a character swap or video edit; billed for the range length."
},
"referenceAudioAssetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"default": [],
"maxItems": 10,
"description": "Reference audio: Seedance 2.5 up to 10; Seedance 2.0 ref2v and fast up to 3. Other models reject them."
},
"referenceVideoAssetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"default": [],
"maxItems": 10,
"description": "Video transformations require one processed source video. Other reference modes have model-specific counts published by generation_options_list."
}
},
"additionalProperties": false
}| idempotencyKey* | string |
| expectedEvidence* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"seriesId",
"goal",
"from",
"to",
"maxVariations",
"language",
"quoteId",
"expectedEvidence",
"maxUsd",
"maxCredits",
"idempotencyKey",
"workspaceId"
],
"properties": {
"to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"goal": {
"enum": [
"reach",
"engagement",
"traffic",
"leads",
"sales",
"revenue"
],
"type": "string"
},
"maxUsd": {
"type": "number",
"maximum": 10,
"exclusiveMinimum": 0
},
"quoteId": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"language": {
"enum": [
"en",
"fr"
],
"type": "string"
},
"seriesId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"maxCredits": {
"type": "number",
"maximum": 1000,
"minimum": 0
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"maxVariations": {
"type": "integer",
"default": 3,
"maximum": 5,
"minimum": 1
},
"idempotencyKey": {
"type": "string",
"pattern": "^[a-zA-Z0-9._:-]+$",
"maxLength": 150,
"minLength": 8
},
"expectedEvidence": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "URL of the media file to download and upload"
},
"name": {
"type": "string",
"description": "Optional name for the file"
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "Optional project ID to associate the upload with. UUID string."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID when projectId is not provided. Defaults to the user's default workspace. UUID string."
},
"autoTranscribe": {
"type": "boolean",
"default": true,
"description": "Request transcription for video uploads."
},
"autoSuggestShorts": {
"type": "boolean",
"default": true
},
"contentHashSha256": {
"type": "string",
"pattern": "^[a-fA-F0-9]{64}$",
"description": "Optional expected SHA-256; mismatching bytes are rejected before deduplication. 64-character hex string."
},
"autoProcessEnabled": {
"type": "boolean",
"default": true,
"description": "Enable media analysis after upload."
},
"autoDescribeAfterTranscribe": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}| autoProcessEnabled | boolean | Enable media analysis after upload. |
| autoDescribeAfterTranscribe | boolean |
{
"type": "object",
"required": [
"storageKey",
"fileName",
"contentType",
"fileSizeBytes"
],
"properties": {
"fileName": {
"type": "string",
"description": "Name of the uploaded file"
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "Optional project ID to associate the upload with. UUID string."
},
"storageKey": {
"type": "string",
"description": "Storage key for the uploaded file"
},
"contentType": {
"type": "string",
"description": "MIME type of the file"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace ID when projectId is not provided. Defaults to the user's default workspace. UUID string."
},
"fileSizeBytes": {
"type": "number",
"minimum": 1,
"description": "Size of the uploaded file in bytes"
},
"autoTranscribe": {
"type": "boolean",
"default": true,
"description": "Request transcription for video uploads."
},
"autoSuggestShorts": {
"type": "boolean",
"default": true
},
"contentHashSha256": {
"type": "string",
"pattern": "^[a-fA-F0-9]{64}$",
"description": "Optional expected SHA-256; mismatching bytes are rejected before deduplication. 64-character hex string."
},
"autoProcessEnabled": {
"type": "boolean",
"default": true,
"description": "Enable media analysis after upload."
},
"autoDescribeAfterTranscribe": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}| transcriptOffset | integer | Transcript segment offset. |
| captionWordOffset | integer | Caption word offset. |
{
"type": "object",
"required": [
"projectId"
],
"properties": {
"mode": {
"enum": [
"summary",
"assets",
"timeline",
"transcript",
"full"
],
"type": "string",
"default": "timeline",
"description": "Bounded project context view to return."
},
"search": {
"type": "string",
"description": "Optional media search when mode is assets or full."
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "Project UUID. UUID string."
},
"assetLimit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Maximum media assets to return (1-50)."
},
"assetOffset": {
"type": "integer",
"minimum": 0,
"description": "Media asset offset."
},
"timelineLimit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Maximum timeline items to return (1-1000)."
},
"timelineOffset": {
"type": "integer",
"minimum": 0,
"description": "Timeline item offset."
},
"transcriptLimit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Maximum transcript segments to return (1-500)."
},
"captionWordLimit": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Maximum caption words to return (1-2000)."
},
"transcriptOffset": {
"type": "integer",
"minimum": 0,
"description": "Transcript segment offset."
},
"captionWordOffset": {
"type": "integer",
"minimum": 0,
"description": "Caption word offset."
}
},
"additionalProperties": false
}| string |
| Optional CTA text override (max 80). |
| includeAffiliateCta | boolean | Append Try BlitzReels for free plus Affonso tracking URL. |
| affiliateTrackingUrl | string | Optional BlitzReels URL with via/ref/aff override. |
| trialGraduationStrategy | any |
{
"type": "object",
"required": [
"projectId",
"scheduledFor"
],
"properties": {
"caption": {
"type": "string",
"description": "Caption text (max 2200)."
},
"exportId": {
"type": "string",
"format": "uuid",
"description": "Completed export UUID. Defaults to latest completed. UUID string."
},
"timezone": {
"type": "string",
"default": "UTC",
"description": "IANA timezone. Defaults to UTC."
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "Project UUID. UUID string."
},
"trialReel": {
"type": "boolean",
"description": "Publish as Trial Reel (video only)."
},
"shareToFeed": {
"type": "boolean",
"description": "Also share Reel to profile feed."
},
"connectionId": {
"type": "string",
"description": "Instagram connection UUID when multiple exist."
},
"scheduledFor": {
"type": "string",
"description": "ISO-8601 datetime for the scheduled publish."
},
"affiliateCtaText": {
"type": "string",
"description": "Optional CTA text override (max 80)."
},
"includeAffiliateCta": {
"type": "boolean",
"default": false,
"description": "Append Try BlitzReels for free plus Affonso tracking URL."
},
"affiliateTrackingUrl": {
"type": "string",
"description": "Optional BlitzReels URL with via/ref/aff override."
},
"trialGraduationStrategy": {
"anyOf": [
{
"enum": [
"MANUAL",
"SS_PERFORMANCE"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false
}| string |
| affiliate_cta_text | any |
| include_affiliate_cta | boolean |
| affiliate_tracking_url | any |
| contains_synthetic_media* | boolean |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"media_asset_id",
"contains_synthetic_media",
"scheduled_for",
"targets",
"workspaceId",
"idempotencyKey",
"confirmPublish"
],
"properties": {
"caption": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"type": "null"
}
]
},
"targets": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"platform"
],
"properties": {
"platform": {
"type": "string",
"const": "linkedin"
},
"connection_id": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"platform"
],
"properties": {
"platform": {
"type": "string",
"const": "threads"
},
"connection_id": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"platform"
],
"properties": {
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"const": "youtube"
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"type": "null"
}
]
},
"connection_id": {
"type": [
"string",
"null"
]
},
"made_for_kids": {
"type": [
"boolean",
"null"
]
},
"privacy_status": {
"anyOf": [
{
"enum": [
"private",
"unlisted",
"public"
],
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"platform"
],
"properties": {
"platform": {
"type": "string",
"const": "instagram"
},
"trial_reel": {
"type": [
"boolean",
"null"
]
},
"connection_id": {
"type": [
"string",
"null"
]
},
"share_to_feed": {
"type": [
"boolean",
"null"
]
},
"trial_graduation_strategy": {
"anyOf": [
{
"enum": [
"MANUAL",
"SS_PERFORMANCE"
],
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"platform"
],
"properties": {
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"const": "facebook"
},
"connection_id": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"platform"
],
"properties": {
"platform": {
"type": "string",
"const": "tiktok"
},
"allow_duet": {
"type": [
"boolean",
"null"
]
},
"allow_stitch": {
"type": [
"boolean",
"null"
]
},
"publish_mode": {
"anyOf": [
{
"enum": [
"direct_post",
"draft"
],
"type": "string"
},
{
"type": "null"
}
]
},
"allow_comment": {
"type": [
"boolean",
"null"
]
},
"brand_organic": {
"type": [
"boolean",
"null"
]
},
"connection_id": {
"type": [
"string",
"null"
]
},
"privacy_level": {
"anyOf": [
{
"enum": [
"PUBLIC_TO_EVERYONE",
"FOLLOWER_OF_CREATOR",
"MUTUAL_FOLLOW_FRIENDS",
"SELF_ONLY"
],
"type": "string"
},
{
"type": "null"
}
]
},
"branded_content": {
"type": [
"boolean",
"null"
]
},
"is_ai_generated": {
"type": [
"boolean",
"null"
]
},
"consent_accepted": {
"type": [
"boolean",
"null"
]
},
"cover_timestamp_ms": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
{
"type": "null"
}
]
},
"commercial_content_enabled": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
]
},
"maxItems": 6,
"minItems": 1
},
"timezone": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
]
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"project_name": {
"anyOf": [
{
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"type": "null"
}
]
},
"scheduled_for": {
"type": "string"
},
"confirmPublish": {
"type": "boolean",
"const": true
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"media_asset_id": {
"type": "string"
},
"affiliate_cta_text": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"include_affiliate_cta": {
"type": "boolean"
},
"affiliate_tracking_url": {
"anyOf": [
{
"type": "string",
"format": "uri",
"maxLength": 500
},
{
"type": "null"
}
]
},
"contains_synthetic_media": {
"type": "boolean"
}
},
"additionalProperties": false
}| expectedRevision* | any |
| defaultCreationMode* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"defaultCreationMode",
"description",
"coverAssetId",
"logoAssetId",
"storyKitId",
"captionThemeId",
"seriesId",
"expectedRevision",
"workspaceId",
"idempotencyKey"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"seriesId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"storyKitId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
],
"default": null
},
"logoAssetId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"coverAssetId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"captionThemeId": {
"anyOf": [
{
"type": "string",
"maxLength": 120,
"minLength": 1
},
{
"type": "null"
}
],
"default": null
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"expectedRevision": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"default": null
},
"defaultCreationMode": {
"enum": [
"podcast",
"faceless"
],
"type": "string",
"default": "podcast"
}
},
"additionalProperties": false
}| narratorCharacterId | string |
| styleReferenceAssetIds | array |
{
"type": "object",
"required": [
"name",
"visualStyle",
"idempotencyKey"
],
"properties": {
"name": {
"type": "string",
"description": "Stable Story Kit name."
},
"facts": {
"type": "array",
"items": {
"type": "string"
}
},
"locations": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"canonicalDescription",
"referenceAssetIds",
"facts"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"facts": {
"type": "array",
"items": {
"type": "string"
}
},
"referenceAssetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"canonicalDescription": {
"type": "string"
}
},
"additionalProperties": false
}
},
"storyKitId": {
"type": "string"
},
"description": {
"type": "string"
},
"visualStyle": {
"type": "string",
"description": "Canonical visual-style contract."
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Optional workspace UUID. Defaults to the user's default workspace. UUID string."
},
"characterIds": {
"type": "array",
"items": {
"type": "string"
}
},
"idempotencyKey": {
"type": "string"
},
"expectedRevision": {
"type": "number"
},
"narratorCharacterId": {
"type": "string"
},
"styleReferenceAssetIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"projectId",
"assetId"
],
"properties": {
"assetId": {
"type": "string",
"format": "uuid",
"description": "Image or video media asset ID. UUID string."
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "BlitzReels project ID. UUID string."
},
"layerIndex": {
"type": "number",
"minimum": 0,
"description": "Exact timeline layer to use. Lower layer numbers render on top. Omit for intent-based placement."
},
"startSeconds": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Timeline start time in seconds"
},
"allowDuplicate": {
"type": "boolean",
"default": true,
"description": "Allow inserting the same asset more than once"
},
"positionPreset": {
"enum": [
"center",
"fullscreen",
"pip-top-left",
"pip-top-right",
"pip-bottom-left",
"pip-bottom-right"
],
"type": "string",
"default": "fullscreen",
"description": "Visual placement preset"
},
"animationPreset": {
"enum": [
"none",
"fadeIn",
"fadeOut",
"zoomIn",
"zoomOut",
"slideLeft",
"slideRight",
"slideUp",
"slideDown",
"popIn",
"bounce",
"spin"
],
"type": "string",
"default": "none",
"description": "Optional visual animation preset"
},
"durationSeconds": {
"type": "number",
"minimum": 0,
"description": "Duration in seconds. Required for still images when a specific length is needed."
},
"placementIntent": {
"enum": [
"overlay",
"background",
"exact"
],
"type": "string",
"default": "overlay",
"description": "Layer intent used when layerIndex is omitted. Use overlay for visible B-roll/logo/sticker over video, background for behind video, exact when layerIndex is supplied."
}
},
"additionalProperties": false
}| number |
| blurredBackground | boolean |
{
"type": "object",
"required": [
"projectId",
"timelineItemId",
"idempotencyKey"
],
"properties": {
"ignored": {
"type": "boolean"
},
"projectId": {
"type": "string",
"format": "uuid",
"description": "UUID string."
},
"layerIndex": {
"type": "integer",
"minimum": 0
},
"startSeconds": {
"type": "number",
"minimum": 0
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 200,
"minLength": 8,
"description": "Retry key. Reuse only with identical inputs."
},
"timelineItemId": {
"type": "string",
"format": "uuid"
},
"trimEndSeconds": {
"type": "number",
"minimum": 0
},
"durationSeconds": {
"type": "number",
"minimum": 0,
"exclusiveMinimum": 0
},
"expectedRevision": {
"type": "integer",
"minimum": 0,
"description": "Expected sequence revision, or null."
},
"trimStartSeconds": {
"type": "number",
"minimum": 0
},
"blurredBackground": {
"type": "boolean"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"revisionId",
"asset_type",
"workspaceId",
"idempotencyKey",
"confirmRegeneration"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"asset_type": {
"enum": [
"style_anchor",
"character_anchor",
"scene_keyframe"
],
"type": "string",
"description": "style_anchor regenerates the shared style reference and every keyframe; character_anchor requires character_id and refreshes dependent keyframes; scene_keyframe requires scene_index."
},
"revisionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"scene_index": {
"type": "integer",
"maximum": 11,
"minimum": 0
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"character_id": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"confirmRegeneration": {
"type": "boolean",
"const": true
}
},
"additionalProperties": false
}| string |
| image_model_id | string |
| caption_style_id | string |
| include_captions | boolean |
| planner_model_id | string |
| confirmScriptApproved* | boolean |
| generate_sound_effects | boolean |
| target_duration_seconds | number |
| generate_background_music | boolean |
| style_reference_asset_ids | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"script",
"workspaceId",
"idempotencyKey",
"confirmScriptApproved"
],
"properties": {
"script": {
"type": "string",
"maxLength": 30000,
"minLength": 1
},
"voice_id": {
"type": "string",
"maxLength": 200
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"series_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"video_model": {
"type": "string",
"maxLength": 200,
"minLength": 3
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"story_kit_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"visual_style": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"character_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"maxItems": 8
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"image_model_id": {
"type": "string",
"maxLength": 200,
"minLength": 3
},
"caption_style_id": {
"type": "string",
"maxLength": 200
},
"include_captions": {
"type": "boolean"
},
"planner_model_id": {
"type": "string",
"maxLength": 200,
"minLength": 3
},
"confirmScriptApproved": {
"type": "boolean",
"const": true
},
"generate_sound_effects": {
"type": "boolean"
},
"target_duration_seconds": {
"type": "number",
"maximum": 120,
"minimum": 10
},
"generate_background_music": {
"type": "boolean"
},
"style_reference_asset_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"maxItems": 10
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"projectId",
"revisionId",
"workspaceId",
"idempotencyKey"
],
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID string."
},
"revisionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"video_model": {
"type": "string",
"maxLength": 200,
"minLength": 3
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"scene_updates": {
"type": "array",
"items": {
"type": "object",
"required": [
"scene_index"
],
"properties": {
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"scene_index": {
"type": "integer",
"maximum": 11,
"minimum": 0
},
"image_prompt": {
"type": "string",
"maxLength": 5000,
"minLength": 1
},
"character_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 2
},
"motion_prompt": {
"type": "string",
"maxLength": 5000,
"minLength": 1
}
},
"additionalProperties": false
},
"maxItems": 12
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"image_model_id": {
"type": "string",
"maxLength": 200,
"minLength": 3
},
"character_updates": {
"type": "array",
"items": {
"type": "object",
"required": [
"character_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"character_id": {
"type": "string",
"minLength": 1
},
"anchor_prompt": {
"type": "string",
"maxLength": 3000,
"minLength": 1
},
"canonical_description": {
"type": "string",
"maxLength": 3000,
"minLength": 1
}
},
"additionalProperties": false
},
"maxItems": 8
},
"style_anchor_prompt": {
"type": "string",
"maxLength": 3000,
"minLength": 1,
"description": "Self-contained prompt for the single reference frame that locks rendering medium, palette, lighting, and grain for every scene. No characters, no text, no interfaces."
}
},
"additionalProperties": false
}| confirmReviewed* |
| boolean |
| editorialPreferences* | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"workspaceId",
"idempotencyKey",
"brandName",
"audience",
"offer",
"conversionGoal",
"tone",
"editorialPreferences",
"protectedWords",
"confirmReviewed"
],
"properties": {
"tone": {
"anyOf": [
{
"type": "string",
"maxLength": 240
},
{
"type": "null"
}
]
},
"offer": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"audience": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"brandName": {
"anyOf": [
{
"type": "string",
"maxLength": 160
},
{
"type": "null"
}
]
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"default": null
},
"conversionGoal": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"maxLength": 200,
"minLength": 8
},
"protectedWords": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 40
},
"confirmReviewed": {
"type": "boolean",
"const": true
},
"editorialPreferences": {
"anyOf": [
{
"type": "object",
"required": [
"purpose",
"preferredLanguage",
"avoidTerms",
"pronunciationNotes"
],
"properties": {
"purpose": {
"anyOf": [
{
"enum": [
"authority",
"education",
"product_demo",
"lead_generation"
],
"type": "string"
},
{
"type": "null"
}
]
},
"avoidTerms": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 40
},
"preferredLanguage": {
"anyOf": [
{
"type": "string",
"maxLength": 40,
"minLength": 2
},
{
"type": "null"
}
]
},
"pronunciationNotes": {
"type": "array",
"items": {
"type": "object",
"required": [
"term",
"pronunciation"
],
"properties": {
"term": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"pronunciation": {
"type": "string",
"maxLength": 160,
"minLength": 1
}
},
"additionalProperties": false
},
"maxItems": 40
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}