Brix36 is an MCP server published by com.brix36, hosted at api.brix36.com. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 128 tools, including studio_video_plan, studio_artists_list, studio_projects_list, studio_model_catalogue, studio_video_start.
Films and music videos. You're the star. No subscription.
4 connections through 4 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Creates or updates a film or music-video project, saves its script or storyboard, and returns a price quote without charging. Film input contains the finished script, language, cast and visualWorld. Music input contains sections, visualWorld and optional songUnderstanding. start identifies a new project; projectId identifies an existing one. A music project without a song returns state needs_song and its projectId; planning can continue on that project after its song upload. The result contains the project, saved plan and quote. Identical operationId and input retries return the same project and quote. Rendering is separate and requires the customer's approval of the quoted price.
| Parameter | Type | Description |
|---|---|---|
| film | object | Film only: the finished script, language, cast and visualWorld (same fields as studio_film_script_write). expectedRevisionId may be omitted for a new film. |
| music | object | Music only: what to save on the board once the song is on the project. |
| scope * | string | 'whole' for the whole song, 'ticked' for the sections currently ticked on the board. |
| start | object | Start a new video (same fields as studio_video_start). Omit when continuing an existing projectId. |
| boosters | object | Optional motion-graphics overlay pack for the finished video, film or advert: mode 'auto' (automatic captions, titles and end card), 'off' (no motion overlay), or 'custom' with optional styleId (for example glass-keynote, product-drop, bold-hook, data-and-map, kinetic-lyric) and optional add or remo… |
| projectId | string | Continue this existing project instead of starting a new one. |
| filmScenes | object | |
| operationId * | string | Stable operation identifier shared by this quote and its confirmation. |
| stillQuality | string | Picture quality for the pictures. Default high. |
| stillShotIds | array | Optional customer-selected stableShotIds from studio_sections_read. Absence selects every shot without a picture. Other shots may have separate later quotes and financial approvals. |
{
"name": "studio_video_plan",
"title": "Plan a music video or film and get its price (one approval)",
"description": "Creates or updates a film or music-video project, saves its script or storyboard, and returns a price quote without charging. Film input contains the finished script, language, cast and visualWorld. Music input contains sections, visualWorld and optional songUnderstanding. start identifies a new project; projectId identifies an existing one. A music project without a song returns state needs_song and its projectId; planning can continue on that project after its song upload. The result contains the project, saved plan and quote. Identical operationId and input retries return the same project and quote. Rendering is separate and requires the customer's approval of the quoted price.",
"inputSchema": {
"type": "object",
"required": [
"operationId",
"scope"
],
"properties": {
"film": {
"type": "object",
"required": [
"script",
"language"
],
"properties": {
"cast": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"maxItems": 6,
"description": "Optional: artist names to cast, in slot order. Names must be the customer's own artists."
},
"script": {
"type": "string",
"maxLength": 100000,
"minLength": 1,
"description": "The finished script, exactly as written. Its language is preserved as-is."
},
"language": {
"type": "string",
"maxLength": 35,
"minLength": 2,
"description": "The selected Film language. The host validates its actual model capability; text is not translated."
},
"visualWorld": {
"type": "object",
"description": "Board-wide visual facts. Optional characters, vehicles, locations, props and never are arrays of up to 12 non-empty strings, each at most 300 characters. Combined rendered fields are limited to 2,400 characters including labels, separators and newlines after trimming. Scene-specific costume and visual direction belong to scene text. Shape: {timeOfDay: string, light: string, setting: string, artist?: string, characters?: list of string, vehicles?: list of string, locations?: list of string, props?: list of string, never?: list of string, palette?: list of string}"
},
"expectedRevisionId": {
"type": [
"string",
"null"
],
"maxLength": 64,
"minLength": 1,
"description": "The revisionId from studio_sections_read, or null only when no storyboard exists."
}
},
"description": "Film only: the finished script, language, cast and visualWorld (same fields as studio_film_script_write). expectedRevisionId may be omitted for a new film.",
"additionalProperties": false
},
"music": {
"type": "object",
"properties": {
"sections": {
"type": "array",
"items": {
"type": "object",
"description": "Shape: {index: integer, what?: string, type?: \"performance\"|\"story\", included?: boolean}"
},
"maxItems": 24,
"minItems": 1,
"description": "Music only: the drafted sections (same as studio_storyboard_write)."
},
"visualWorld": {
"type": "object",
"description": "Music only: the board's visual world (same as studio_storyboard_prepare). Required before a finished board can be priced. Shape: {timeOfDay: string, light: string, setting: string, artist?: string, characters?: list of string, vehicles?: list of string, locations?: list of string, props?: list of string, never?: list of string, palette?: list of string}"
},
"songUnderstanding": {
"type": "object",
"description": "Music only, optional: the song understanding fields of studio_song_understanding_write, without projectId."
}
},
"description": "Music only: what to save on the board once the song is on the project.",
"additionalProperties": false
},
"scope": {
"enum": [
"whole",
"ticked"
],
"type": "string",
"description": "'whole' for the whole song, 'ticked' for the sections currently ticked on the board."
},
"start": {
"type": "object",
"required": [
"kind",
"artistName"
],
"properties": {
"kind": {
"enum": [
"music",
"film"
],
"type": "string",
"description": "The requested video kind: music is a music video for a song; film is a short film with scenes, dialogue and optional music."
},
"title": {
"type": "string",
"maxLength": 160,
"description": "What to call the video. Defaults to the song title. A film without a songTitle needs this."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact artist ID from studio_artists_list, disambiguating artists with the same name. ID and artistName must match."
},
"boosters": {
"type": "object",
"description": "Optional motion-graphics overlay pack for the finished video, film or advert: mode 'auto' (automatic captions, titles and end card), 'off' (no motion overlay), or 'custom' with optional styleId (for example glass-keynote, product-drop, bold-hook, data-and-map, kinetic-lyric) and optional add or remove overlay kinds. Shape: {mode?: \"auto\"|\"off\"|\"custom\", styleId?: string, add?: list of \"caption\"|\"zoom\"|\"transition\"|\"flash\"|\"title\"|\"callout\"|\"productCard\"|\"priceCard\"|\"lowerThird\"|\"endCard\"|\"background\"|\"visualiser\"|\"lyric\", remove?: list of \"caption\"|\"zoom\"|\"transition\"|\"flash\"|\"title\"|\"callout\"|\"productCard\"|\"priceCard\"|\"lowerThird\"|\"endCard\"|\"background\"|\"visualiser\"|\"lyric\"}"
},
"songTitle": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"description": "The song this video is for. Required for a music video; optional for a film, which needs no song. Shown to the customer and used for the catalogue entry."
},
"artistName": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "The existing artist or invented character starring in it. Required: an existing name from studio_artists_list (case and spacing do not matter), or the customer's chosen new fictional name with createArtist: true."
},
"durationMs": {
"type": "integer",
"maximum": 3600000,
"minimum": 1000,
"description": "The song length in milliseconds, if the customer's AI knows it."
},
"createArtist": {
"type": "boolean",
"description": "True creates a new fictional_character under an unmatched artistName. Fictional characters need no photo or likeness consent. Real-person creation uses the existing app consent flow. Existing names are reused either way; identical retries retain the original flag."
}
},
"description": "Start a new video (same fields as studio_video_start). Omit when continuing an existing projectId.",
"additionalProperties": false
},
"boosters": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string",
"description": "One of: \"caption\", \"zoom\", \"transition\", \"flash\", \"title\", \"callout\", \"productCard\", \"priceCard\", \"lowerThird\", \"endCard\", \"background\", \"visualiser\", \"lyric\"."
},
"maxItems": 13,
"description": "Overlay layers to include on the video.",
"uniqueItems": true
},
"mode": {
"enum": [
"auto",
"off",
"custom"
],
"type": "string",
"description": "'auto' for automatic motion graphics, 'off' for none, or 'custom' (default when styleId, add or remove are given)."
},
"remove": {
"type": "array",
"items": {
"type": "string",
"description": "One of: \"caption\", \"zoom\", \"transition\", \"flash\", \"title\", \"callout\", \"productCard\", \"priceCard\", \"lowerThird\", \"endCard\", \"background\", \"visualiser\", \"lyric\"."
},
"maxItems": 13,
"description": "Overlay layers to exclude from the chosen style.",
"uniqueItems": true
},
"styleId": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{0,63}$",
"maxLength": 64,
"minLength": 1,
"description": "Motion style identifier (for example glass-keynote, product-drop, bold-hook, data-and-map, kinetic-lyric)."
}
},
"description": "Optional motion-graphics overlay pack for the finished video, film or advert: mode 'auto' (automatic captions, titles and end card), 'off' (no motion overlay), or 'custom' with optional styleId (for example glass-keynote, product-drop, bold-hook, data-and-map, kinetic-lyric) and optional add or remove overlay kinds.",
"additionalProperties": false
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Continue this existing project instead of starting a new one."
},
"filmScenes": {
"type": "object",
"properties": {
"sceneIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 240,
"minItems": 1,
"description": "Saved stableSceneId values from studio_film_read. Named scenes are remade; other good clips are reused.",
"uniqueItems": true
},
"renderOnly": {
"type": "boolean",
"description": "True quotes only these scenes for a scene preview. Confirm, check the result, then quote the next scene. False assembles the complete Film, making only named or missing scenes."
}
},
"additionalProperties": false
},
"operationId": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 128,
"minLength": 8,
"description": "Stable operation identifier shared by this quote and its confirmation."
},
"stillQuality": {
"enum": [
"medium",
"high"
],
"type": "string",
"description": "Picture quality for the pictures. Default high."
},
"stillShotIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"maxItems": 200,
"minItems": 1,
"description": "Optional customer-selected stableShotIds from studio_sections_read. Absence selects every shot without a picture. Other shots may have separate later quotes and financial approvals.",
"uniqueItems": true
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"state",
"next"
],
"properties": {
"next": {
"type": "string"
},
"quote": {
"type": "object",
"required": [
"quoteToken",
"scope",
"sectionCount",
"tickedCount",
"models",
"balance",
"expiresAt",
"note"
],
"properties": {
"note": {
"type": "string"
},
"redos": {
"type": "object",
"required": [
"allowance",
"creditCap",
"used",
"usedCredits"
],
"properties": {
"used": {
"type": "number"
},
"allowance": {
"type": "number"
},
"creditCap": {
"type": "number"
},
"usedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"scope": {
"enum": [
"whole",
"ticked"
]
},
"video": {
"type": "object",
"required": [
"capCredits"
],
"properties": {
"capCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"models": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"recommended",
"credits"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"note": {
"type": "string"
},
"credits": {
"type": [
"number",
"null"
]
},
"recommended": {
"type": "boolean"
},
"needsFaceCheck": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"stills": {
"type": "object",
"required": [
"shotCount",
"credits"
],
"properties": {
"credits": {
"type": "number"
},
"shotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"filmSpeech": {
"anyOf": [
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"characters"
],
"properties": {
"state": {
"enum": [
"quoted"
]
},
"characters": {
"type": "array",
"items": {
"type": "object",
"required": [
"artistId",
"characterName",
"sceneIndex",
"voiceSource",
"speech",
"motion",
"lipSync"
],
"properties": {
"motion": {
"type": "object",
"required": [
"providerId",
"modelId"
],
"properties": {
"modelId": {
"type": "string"
},
"providerId": {
"type": "string"
}
},
"additionalProperties": true
},
"speech": {
"type": "object",
"required": [
"providerId",
"modelId"
],
"properties": {
"modelId": {
"type": "string"
},
"providerId": {
"type": "string"
}
},
"additionalProperties": true
},
"lipSync": {
"enum": [
"native",
"separate",
"not_requested"
]
},
"artistId": {
"type": "string"
},
"sceneIndex": {
"type": "number"
},
"voiceSource": {
"enum": [
"native_generated",
"saved_character",
"character_voice_setup"
]
},
"lipSyncRoute": {
"type": "object",
"required": [
"providerId",
"modelId"
],
"properties": {
"modelId": {
"type": "string"
},
"providerId": {
"type": "string"
}
},
"additionalProperties": true
},
"characterName": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"reason"
],
"properties": {
"state": {
"enum": [
"historical_unavailable"
]
},
"reason": {
"enum": [
"original_route_evidence_not_persisted"
]
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
"outputNote": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"consentMode": {
"enum": [
"chat"
]
},
"repeatReuse": {
"type": "object",
"required": [
"reusedSeconds",
"freshSeconds",
"reusedShotCount",
"text"
],
"properties": {
"text": {
"type": "string"
},
"freshSeconds": {
"type": "number"
},
"reusedSeconds": {
"type": "number"
},
"reusedShotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"tickedCount": {
"type": "number"
},
"priceVersion": {
"type": "string"
},
"sectionCount": {
"type": "number"
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"approvalState": {
"type": "string"
},
"costEstimateId": {
"type": "string"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"approvalExpiresAt": {
"type": "string"
},
"topUpGbpInclVatNow": {
"type": "string"
},
"creditsInformationUrl": {
"type": "string"
},
"engineRecommendations": {
"anyOf": [
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"reason"
],
"properties": {
"state": {
"enum": [
"unavailable"
]
},
"reason": {
"enum": [
"original_quote_replayed"
]
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"shots"
],
"properties": {
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"sectionIndex",
"label",
"selectedModelName",
"recommendedModelName",
"options"
],
"properties": {
"label": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"modelName",
"available",
"explanation"
],
"properties": {
"available": {
"type": "boolean"
},
"modelName": {
"type": "string"
},
"explanation": {
"type": [
"string",
"null"
]
},
"deltaVideoCredits": {
"type": "number"
},
"totalVideoCredits": {
"type": "number"
}
},
"additionalProperties": true
}
},
"sectionIndex": {
"type": "number"
},
"stableShotId": {
"type": "string"
},
"selectedModelName": {
"type": [
"string",
"null"
]
},
"recommendedModelName": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"state": {
"enum": [
"quoted"
]
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"sectionIndex",
"sectionId",
"stableShotIds",
"delivery",
"availableProfiles",
"pricing"
],
"properties": {
"pricing": {
"type": "object",
"required": [
"basis",
"credits"
],
"properties": {
"basis": {
"enum": [
"allocated_final_total"
]
},
"credits": {
"type": "number"
}
},
"additionalProperties": true
},
"delivery": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"sectionId": {
"type": [
"string",
"null"
]
},
"sectionIndex": {
"type": "number"
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"availableProfiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"finalVideoCredits": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
"state": {
"enum": [
"needs_script",
"needs_song",
"priced"
]
},
"script": {
"type": "object",
"required": [
"projectId",
"outcome",
"revision",
"revisionId",
"language",
"sceneCount",
"totalMs",
"uncastLineIds",
"next",
"note"
],
"properties": {
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"outcome": {
"enum": [
"created",
"replayed"
]
},
"totalMs": {
"type": "number"
},
"language": {
"type": "string"
},
"revision": {
"type": "number"
},
"projectId": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"sceneCount": {
"type": "number"
},
"uncastLineIds": {
"type": "array",
"items": {
"type": "string"
}
},
"uncastSpeakers": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"started": {
"type": "object",
"required": [
"projectId",
"kind",
"title",
"songTitle",
"artist",
"artistNeedsPhoto",
"outcome",
"next",
"note"
],
"properties": {
"kind": {
"enum": [
"music",
"film"
]
},
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"title": {
"type": "string"
},
"artist": {
"type": "object",
"required": [
"id",
"name",
"coverUrl"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"coverUrl": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"outcome": {
"enum": [
"created",
"replayed"
]
},
"projectId": {
"type": "string"
},
"songTitle": {
"type": "string"
},
"artistNeedsPhoto": {
"type": "boolean"
}
},
"additionalProperties": true
},
"projectId": {
"type": "string"
},
"storyboard": {
"type": "object",
"required": [
"projectId",
"written",
"sections",
"state",
"next",
"note"
],
"properties": {
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"state": {
"enum": [
"draft",
"storyboard_ready",
"making",
"ready",
"needs_attention"
]
},
"written": {
"type": "number"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"startMs",
"endMs",
"name",
"what",
"type",
"included",
"stillUrl",
"lines"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"performance",
"story"
]
},
"what": {
"type": "string"
},
"endMs": {
"type": "number"
},
"index": {
"type": "number"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs",
"role",
"sync"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"lead",
"adlib",
"guest"
]
},
"sync": {
"type": "boolean"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"guestName": {
"type": "string"
}
},
"additionalProperties": true
}
},
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"stillAssetId",
"stillUrl",
"label",
"startMs",
"endMs",
"stillState"
],
"properties": {
"endMs": {
"type": "number"
},
"label": {
"type": "string"
},
"startMs": {
"type": "number"
},
"stillUrl": {
"type": [
"string",
"null"
]
},
"stillState": {
"enum": [
"ready",
"making",
"needs_update",
"failed",
"none"
]
},
"stableShotId": {
"type": "string"
},
"stillAssetId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"startMs": {
"type": "number"
},
"included": {
"type": "boolean"
},
"stillUrl": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"projectId": {
"type": "string"
}
},
"additionalProperties": true
},
"visualWorld": {
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"revisionId",
"scenesPreserved",
"free",
"credits",
"next",
"inputSchema",
"state",
"visualWorld"
],
"properties": {
"free": {
"const": true
},
"next": {
"type": "string"
},
"state": {
"enum": [
"ready"
]
},
"credits": {
"const": 0
},
"revision": {
"type": "number"
},
"projectId": {
"type": "string"
},
"shotCount": {
"type": "number"
},
"authoredBy": {
"enum": [
"customer_ai"
]
},
"revisionId": {
"type": "string"
},
"inputSchema": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"object"
]
}
},
"additionalProperties": true
},
"visualWorld": {
"type": "object",
"required": [
"timeOfDay",
"light",
"setting"
],
"properties": {
"light": {
"type": "string"
},
"never": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "array",
"items": {
"type": "string"
}
},
"artist": {
"type": "string"
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"setting": {
"type": "string"
},
"vehicles": {
"type": "array",
"items": {
"type": "string"
}
},
"locations": {
"type": "array",
"items": {
"type": "string"
}
},
"timeOfDay": {
"type": "string"
},
"characters": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"worldSource": {
"enum": [
"saved"
]
},
"scenesPreserved": {
"const": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"projectId",
"revisionId",
"scenesPreserved",
"free",
"credits",
"next",
"inputSchema",
"state",
"visualWorld",
"authoredBy",
"context"
],
"properties": {
"free": {
"const": true
},
"next": {
"type": "string"
},
"state": {
"enum": [
"needs_visual_world"
]
},
"context": {
"type": "object",
"required": [
"shots",
"film"
],
"properties": {
"film": {
"anyOf": [
{
"type": "object",
"required": [
"scenes",
"cast_ids",
"language"
],
"properties": {
"scenes": {
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"startMs",
"endMs",
"what",
"lines"
],
"properties": {
"what": {
"type": "string"
},
"endMs": {
"type": "number"
},
"index": {
"type": "number"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": true
}
},
"startMs": {
"type": "number"
}
},
"additionalProperties": true
}
},
"cast_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"language": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"order",
"label",
"description",
"startMs",
"endMs",
"visual",
"status",
"setup",
"role",
"performance",
"motion",
"camera"
],
"properties": {
"role": {
"enum": [
"hook-anchor",
"verse",
"insert",
"payoff"
]
},
"endMs": {
"type": "number"
},
"label": {
"type": "string"
},
"order": {
"type": "number"
},
"setup": {
"type": "string"
},
"camera": {
"type": "string"
},
"motion": {
"type": "string"
},
"status": {
"enum": [
"draft",
"approved",
"changes_requested"
]
},
"visual": {
"type": "string"
},
"startMs": {
"type": "number"
},
"description": {
"type": "string"
},
"performance": {
"type": "boolean"
},
"stableShotId": {
"type": "string"
},
"identityTarget": {
"enum": [
"artist",
"none",
null
]
},
"sectionDirection": {
"type": [
"string",
"null"
]
},
"referenceAttachmentIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"credits": {
"const": 0
},
"projectId": {
"type": "string"
},
"authoredBy": {
"enum": [
"customer_ai"
]
},
"revisionId": {
"type": "string"
},
"inputSchema": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"object"
]
}
},
"additionalProperties": true
},
"visualWorld": {
"type": "null"
},
"scenesPreserved": {
"const": true
}
},
"additionalProperties": true
}
]
},
"songUnderstanding": {
"type": "object",
"required": [
"analysisId",
"assetId",
"understandingRevision",
"understanding"
],
"properties": {
"assetId": {
"type": "string"
},
"analysisId": {
"type": "string"
},
"understanding": {
"type": "object",
"required": [
"version",
"sourceAssetId",
"analysisId",
"masterDurationMs",
"language",
"transcription",
"timing",
"attribution",
"words",
"lines",
"speakers",
"segments"
],
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs",
"wordIds"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"wordIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
}
},
"additionalProperties": true
}
},
"lyrics": {
"type": "string"
},
"timing": {
"type": "object",
"required": [
"status",
"model",
"note"
],
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unavailable",
"ready",
"failed",
"instrumental"
]
}
},
"additionalProperties": true
},
"version": {
"enum": [
1
]
},
"language": {
"type": [
"string",
"null"
]
},
"segments": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"speakerId",
"startMs",
"endMs",
"text",
"wordIds",
"role",
"roleSource",
"overlappingSegmentIds"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"lead",
"feature",
"dj",
"adlib",
"unknown"
]
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"wordIds": {
"type": "array",
"items": {
"type": "string"
}
},
"speakerId": {
"type": [
"string",
"null"
]
},
"roleSource": {
"enum": [
"engine",
"user",
"unresolved"
]
},
"overlappingSegmentIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"speakers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"label",
"identity",
"evidence"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"evidence": {
"enum": [
"reference_match",
"user_confirmed",
"none"
]
},
"identity": {
"enum": [
"artist",
"unconfirmed"
]
}
},
"additionalProperties": true
}
},
"analysisId": {
"type": "string"
},
"attribution": {
"type": "object",
"required": [
"status",
"model",
"note"
],
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unavailable",
"ready",
"failed",
"instrumental"
]
}
},
"additionalProperties": true
},
"description": {
"type": "string"
},
"sourceAssetId": {
"type": "string"
},
"transcription": {
"type": "object",
"required": [
"status",
"model",
"note"
],
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unavailable",
"ready",
"failed",
"instrumental"
]
}
},
"additionalProperties": true
},
"masterDurationMs": {
"type": "number"
}
},
"additionalProperties": true
},
"understandingRevision": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Plan a music video or film and get its price (one approval)",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Lists the customer's artists alphabetically, with IDs, names, identity kind, screened photo count, face-check status and whether the real-person video model can use them. Artist IDs also identify Film cast members. Fictional characters need no photo or likeness consent; real-person artists retain the app's consent flow. Free, read-only pagination, up to 50 artists per page.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Number of results, default 20 and maximum 50. |
| query | string | Optional case-insensitive artist name fragment. Pagination binds nextCursor to the same query. |
| cursor | string | The previous page’s nextCursor; absent on the first page. |
{
"name": "studio_artists_list",
"title": "List the customer's artists, A to Z",
"description": "Lists the customer's artists alphabetically, with IDs, names, identity kind, screened photo count, face-check status and whether the real-person video model can use them. Artist IDs also identify Film cast members. Fictional characters need no photo or likeness consent; real-person artists retain the app's consent flow. Free, read-only pagination, up to 50 artists per page.",
"inputSchema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Number of results, default 20 and maximum 50."
},
"query": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Optional case-insensitive artist name fragment. Pagination binds nextCursor to the same query."
},
"cursor": {
"type": "string",
"maxLength": 400,
"minLength": 1,
"description": "The previous page’s nextCursor; absent on the first page."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"artists",
"nextCursor",
"next",
"note"
],
"properties": {
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"artists": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"kind",
"photoCount",
"faceCheck",
"seedanceReady"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"real_person",
"fictional_character"
]
},
"name": {
"type": "string"
},
"faceCheck": {
"enum": [
"done",
"needed",
"not_needed"
]
},
"photoCount": {
"type": "number"
},
"seedanceReady": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "List the customer's artists, A to Z",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Lists the customer's videos newest first, optionally filtered by artistId. Returns projectId, title, artist, status, picture, last-change time and nextCursor. Free and read-only, up to 50 projects per page.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Number of results, default 20 and maximum 50. |
| cursor | string | The previous page’s nextCursor; absent on the first page. |
| artistId | string | Optional artist ID from studio_artists_list or studio_video_start. Absence lists every accessible artist’s videos. |
| libraryBucket | string | Optional tab bucket filter: 'finished' or 'to_finish'. |
{
"name": "studio_projects_list",
"title": "List the customer's videos, newest first",
"description": "Lists the customer's videos newest first, optionally filtered by artistId. Returns projectId, title, artist, status, picture, last-change time and nextCursor. Free and read-only, up to 50 projects per page.",
"inputSchema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Number of results, default 20 and maximum 50."
},
"cursor": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The previous page’s nextCursor; absent on the first page."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Optional artist ID from studio_artists_list or studio_video_start. Absence lists every accessible artist’s videos."
},
"libraryBucket": {
"enum": [
"finished",
"to_finish"
],
"type": "string",
"description": "Optional tab bucket filter: 'finished' or 'to_finish'."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projects",
"nextCursor",
"next",
"note"
],
"properties": {
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"counts": {
"type": "object",
"required": [
"finished",
"toFinish",
"inProgress",
"carryOn",
"needsAttention"
],
"properties": {
"carryOn": {
"type": "number"
},
"finished": {
"type": "number"
},
"toFinish": {
"type": "number"
},
"inProgress": {
"type": "number"
},
"needsAttention": {
"type": "number"
}
},
"additionalProperties": true
},
"projects": {
"type": "array",
"items": {
"type": "object",
"required": [
"projectId",
"kind",
"title",
"artistId",
"artistName",
"status",
"sectionsReady",
"sectionsTotal",
"thumbnailUrl",
"updatedAt"
],
"properties": {
"kind": {
"enum": [
"music",
"film",
null
]
},
"title": {
"type": "string"
},
"status": {
"type": "string"
},
"artistId": {
"type": "string"
},
"inFlight": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"artistName": {
"type": "string"
},
"displayName": {
"type": "string"
},
"creationMode": {
"enum": [
"motion"
]
},
"libraryGroup": {
"enum": [
"finished",
"in_progress",
"carry_on",
"needs_attention"
]
},
"thumbnailUrl": {
"type": [
"string",
"null"
]
},
"libraryAction": {
"enum": [
"open",
"carry_on",
"none"
]
},
"libraryBucket": {
"enum": [
"finished",
"to_finish"
]
},
"sectionsReady": {
"type": "number"
},
"sectionsTotal": {
"type": "number"
},
"libraryInFlight": {
"type": "boolean"
},
"motionDocumentId": {
"type": "string"
},
"motionReconciling": {
"type": "boolean"
},
"libraryStatusLabel": {
"type": "string"
}
},
"additionalProperties": true
}
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "List the customer's videos, newest first",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns the current Brix36 model catalogue, including profiles, settings, media limits, availability reasons, recommended choices and qualified starting prices in credits. Starting prices are distinct from generation quotes. Pagination uses nextCursor with the same kind. No generation or charge.
| Parameter | Type | Description |
|---|---|---|
| kind | string | Optional media-kind filter; absence includes all kinds. |
| limit | integer | Maximum items to return, 1–50. Default 20. |
| cursor | string | Opaque nextCursor from the catalogue, bound to the same kind and catalogue version. Absence starts a fresh page. |
{
"name": "studio_model_catalogue",
"title": "Browse Brix36 models and options",
"description": "Returns the current Brix36 model catalogue, including profiles, settings, media limits, availability reasons, recommended choices and qualified starting prices in credits. Starting prices are distinct from generation quotes. Pagination uses nextCursor with the same kind. No generation or charge.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"kind": {
"enum": [
"video",
"image",
"audio",
"edit"
],
"type": "string",
"description": "Optional media-kind filter; absence includes all kinds."
},
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum items to return, 1–50. Default 20."
},
"cursor": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"description": "Opaque nextCursor from the catalogue, bound to the same kind and catalogue version. Absence starts a fresh page."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"catalogueVersion",
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"displayName",
"type",
"kind",
"profiles",
"availability",
"priceFrom",
"recommended",
"default"
],
"properties": {
"key": {
"type": "string"
},
"kind": {
"enum": [
"video",
"image",
"audio",
"edit"
]
},
"type": {
"enum": [
"model",
"tool",
"recipe"
]
},
"recipe": {
"type": "object",
"required": [
"id",
"version",
"name",
"description",
"kind",
"subject",
"availability",
"execution"
],
"properties": {
"id": {
"enum": [
"music-video",
"film",
"one-tap",
"adverts"
]
},
"kind": {
"enum": [
"video",
"image",
"audio",
"edit"
]
},
"name": {
"type": "string"
},
"subject": {
"enum": [
"optional",
"required",
"none"
]
},
"version": {
"type": "string"
},
"execution": {
"anyOf": [
{
"type": "object",
"required": [
"kind",
"projectKind",
"workflow"
],
"properties": {
"kind": {
"enum": [
"project"
]
},
"workflow": {
"enum": [
"music-video",
"film"
]
},
"projectKind": {
"enum": [
"music",
"film"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"kind",
"modelKey",
"profileKey",
"presetId",
"presetVersion"
],
"properties": {
"kind": {
"enum": [
"direct"
]
},
"modelKey": {
"type": "string"
},
"presetId": {
"type": "string"
},
"profileKey": {
"type": "string"
},
"presetVersion": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
"description": {
"type": "string"
},
"availability": {
"anyOf": [
{
"type": "object",
"required": [
"available"
],
"properties": {
"available": {
"const": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"available",
"reason"
],
"properties": {
"reason": {
"enum": [
"disabled",
"not_configured",
"not_qualified",
"price_unavailable",
"unsupported_mode",
"temporarily_unavailable"
]
},
"message": {
"type": "string"
},
"available": {
"const": false
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
"status": {
"enum": [
"available",
"needs-rehearsal",
"off"
]
},
"default": {
"type": "boolean"
},
"modelId": {
"type": "string"
},
"examples": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"version",
"assetPath",
"fictional",
"brixOwned"
],
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"presetId": {
"type": "string"
},
"assetPath": {
"type": "string"
},
"brixOwned": {
"const": true
},
"fictional": {
"const": true
}
},
"additionalProperties": true
}
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"modelKey",
"profileKey",
"mode",
"inputAssets",
"prompt",
"settings",
"outputMediaTypes"
],
"properties": {
"mode": {
"enum": [
"video",
"image",
"music",
"speech",
"sound_effects",
"background_remove",
"video_upscale",
"image_upscale",
"lip_sync",
"captions",
"reframe",
"motion_graphics",
"copy_variations"
]
},
"prompt": {
"type": "object",
"required": [
"required",
"maxLength"
],
"properties": {
"required": {
"type": "boolean"
},
"maxLength": {
"type": "number"
}
},
"additionalProperties": true
},
"status": {
"enum": [
"available",
"needs-rehearsal",
"off"
]
},
"modelKey": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"key",
"required",
"type"
],
"properties": {
"key": {
"type": "string"
},
"max": {
"type": "number"
},
"min": {
"type": "number"
},
"type": {
"enum": [
"integer",
"number"
]
},
"label": {
"type": "string"
},
"default": {
"type": "number"
},
"required": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"key",
"required",
"type"
],
"properties": {
"key": {
"type": "string"
},
"type": {
"enum": [
"boolean"
]
},
"label": {
"type": "string"
},
"default": {
"type": "boolean"
},
"required": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"key",
"required",
"type",
"maxLength"
],
"properties": {
"key": {
"type": "string"
},
"type": {
"enum": [
"text"
]
},
"label": {
"type": "string"
},
"default": {
"type": "string"
},
"multiple": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"inputKind": {
"enum": [
"media",
"json"
]
},
"maxLength": {
"type": "number"
},
"mediaTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"valueSchema": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"key",
"required",
"type",
"values"
],
"properties": {
"key": {
"type": "string"
},
"type": {
"enum": [
"enum"
]
},
"label": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"default": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"required": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
}
},
"priceFrom": {
"anyOf": [
{
"type": "object",
"required": [
"credits",
"gbpMinor",
"vatIncluded",
"assumptions",
"pricingVersion"
],
"properties": {
"credits": {
"type": "number"
},
"gbpMinor": {
"type": "number"
},
"assumptions": {
"type": "array",
"items": {
"type": "string"
}
},
"vatIncluded": {
"const": true
},
"pricingVersion": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"profileKey": {
"type": "string"
},
"constraints": {
"type": "object",
"required": [],
"properties": {
"audio": {
"enum": [
"native",
"off",
"source"
]
},
"endFrame": {
"enum": [
"optional",
"unsupported"
]
},
"startFrame": {
"enum": [
"required",
"unsupported"
]
},
"resolutions": {
"type": "array",
"items": {
"type": "string"
}
},
"maxReferenceAudio": {
"type": "number"
},
"maxReferenceImages": {
"type": "number"
},
"maxReferenceVideos": {
"type": "number"
},
"maxInputVideoPlusOutputMs": {
"type": "number"
},
"maxReferenceAudioDurationMs": {
"type": "number"
},
"maxReferenceVideoDurationMs": {
"type": "number"
}
},
"additionalProperties": true
},
"inputAssets": {
"type": "object",
"required": [
"min",
"max"
],
"properties": {
"max": {
"type": "number"
},
"min": {
"type": "number"
}
},
"additionalProperties": true
},
"availability": {
"anyOf": [
{
"type": "object",
"required": [
"available"
],
"properties": {
"available": {
"const": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"available",
"reason"
],
"properties": {
"reason": {
"enum": [
"disabled",
"not_configured",
"not_qualified",
"price_unavailable",
"unsupported_mode",
"temporarily_unavailable"
]
},
"message": {
"type": "string"
},
"available": {
"const": false
}
},
"additionalProperties": true
}
]
},
"outputMediaTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"priceFrom": {
"anyOf": [
{
"type": "object",
"required": [
"credits",
"gbpMinor",
"vatIncluded",
"assumptions",
"pricingVersion"
],
"properties": {
"credits": {
"type": "number"
},
"gbpMinor": {
"type": "number"
},
"assumptions": {
"type": "array",
"items": {
"type": "string"
}
},
"vatIncluded": {
"const": true
},
"pricingVersion": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"providerId": {
"type": "string"
},
"displayName": {
"type": "string"
},
"recommended": {
"type": "boolean"
},
"availability": {
"anyOf": [
{
"type": "object",
"required": [
"available"
],
"properties": {
"available": {
"const": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"available",
"reason"
],
"properties": {
"reason": {
"enum": [
"disabled",
"not_configured",
"not_qualified",
"price_unavailable",
"unsupported_mode",
"temporarily_unavailable"
]
},
"message": {
"type": "string"
},
"available": {
"const": false
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
}
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"catalogueVersion": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Browse Brix36 models and options",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Creates a Music or Film project in the customer's catalogue. Accepts an existing artist name or a new fictional name with createArtist:true. Fictional characters require no photo or likeness consent; real-person creation retains the app consent flow. Music requires songTitle; Film requires title or songTitle and no song. Identical retries return the same project. Returns project identifiers for song upload or Film script import. No generation or charge.
| Parameter | Type | Description |
|---|---|---|
| kind * | string | The requested video kind: music is a music video for a song; film is a short film with scenes, dialogue and optional music. |
| title | string | What to call the video. Defaults to the song title. A film without a songTitle needs this. |
| artistId | string | Exact artist ID from studio_artists_list, disambiguating artists with the same name. ID and artistName must match. |
| boosters | object | Optional motion-graphics overlay pack for the finished video, film or advert: mode 'auto' (automatic captions, titles and end card), 'off' (no motion overlay), or 'custom' with optional styleId (for example glass-keynote, product-drop, bold-hook, data-and-map, kinetic-lyric) and optional add or remo… |
| songTitle | string | The song this video is for. Required for a music video; optional for a film, which needs no song. Shown to the customer and used for the catalogue entry. |
| artistName * | string | The existing artist or invented character starring in it. Required: an existing name from studio_artists_list (case and spacing do not matter), or the customer's chosen new fictional name with createArtist: true. |
Returns a song upload widget and a one-time fallback uploadUrl for an existing project. File bytes go directly to Brix36. Repeated calls return the same fallback link or the existing song attachment. No charge.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | From studio_video_start. |
{
"name": "studio_song_attach",
"title": "Upload a song in the chat",
"description": "Returns a song upload widget and a one-time fallback uploadUrl for an existing project. File bytes go directly to Brix36. Repeated calls return the same fallback link or the existing song attachment. No charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "From studio_video_start."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"required": [
"view",
"purpose",
"projectId",
"uploadUrl",
"expiresAt"
]
},
{
"required": [
"code",
"message"
]
}
],
"properties": {
"code": {
"type": "string"
},
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"view": {
"const": "upload"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"message": {
"type": "string"
},
"purpose": {
"const": "song"
},
"expiresAt": {
"type": "string"
},
"projectId": {
"type": "string"
},
"uploadUrl": {
"type": "string"
},
"mediaOrigin": {
"type": "string"
},
"instructions": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
},
"annotations": {
"title": "Upload a song in the chat",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List one artist songs using the app canonical grouping, including their available project versions. Returns a bounded songs page and nextCursor. Each song projectId identifies the project holding that song version. Free; this does not upload or generate audio.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum items to return, 1–50. Default 20. |
| cursor | string | Opaque previous-page nextCursor; absent for the first page. |
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
{
"name": "studio_songs_list",
"title": "List artist songs",
"description": "List one artist songs using the app canonical grouping, including their available project versions. Returns a bounded songs page and nextCursor. Each song projectId identifies the project holding that song version. Free; this does not upload or generate audio.",
"inputSchema": {
"type": "object",
"required": [
"artistId"
],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum items to return, 1–50. Default 20."
},
"cursor": {
"type": "string",
"maxLength": 512,
"minLength": 1,
"description": "Opaque previous-page nextCursor; absent for the first page."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"songs",
"nextCursor"
],
"properties": {
"songs": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"projectId",
"stage",
"versions"
],
"properties": {
"id": {
"type": "string"
},
"stage": {
"enum": [
"brief",
"planning",
"storyboard_draft",
"storyboard_approved",
"video_queued",
"generating",
"review",
"complete"
]
},
"title": {
"type": "string"
},
"versions": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"songTitle",
"stage",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"stage": {
"enum": [
"brief",
"planning",
"storyboard_draft",
"storyboard_approved",
"video_queued",
"generating",
"review",
"complete"
]
},
"title": {
"type": "string"
},
"songTitle": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": true
}
},
"projectId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "List artist songs",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read the currently attached song and its technical analysis for a project. Returns the song attachment, latest upload job status, analysis ID, measured duration, tempo, sections and existing themes when available. Absent analysis stays pending. Free; this never starts transcription, reasoning or a storyboard.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
{
"name": "studio_song_status",
"title": "Read song upload and analysis",
"description": "Read the currently attached song and its technical analysis for a project. Returns the song attachment, latest upload job status, analysis ID, measured duration, tempo, sections and existing themes when available. Absent analysis stays pending. Free; this never starts transcription, reasoning or a storyboard.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"uploadStatus",
"song",
"analysisJob",
"analysis"
],
"properties": {
"song": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"kind",
"name"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"reference_image",
"reference_video",
"audio"
]
},
"name": {
"type": "string"
},
"size": {
"type": "number"
},
"scope": {
"enum": [
"project",
"shot"
]
},
"assetId": {
"type": "string"
},
"contentUrl": {
"type": "string"
},
"contentHash": {
"type": "string"
},
"intendedAtMs": {
"type": "number"
},
"analysisJobId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"analysis": {
"anyOf": [
{
"type": "object",
"required": [
"analysisId",
"assetId",
"depth",
"durationMs",
"tempoBpm",
"sections",
"beatsMs",
"themes",
"themeStatus",
"understandingRevision",
"understanding"
],
"properties": {
"depth": {
"enum": [
"full",
"metadata",
"unsupported"
]
},
"themes": {
"type": "array",
"items": {
"type": "string"
}
},
"assetId": {
"type": "string"
},
"beatsMs": {
"type": "array",
"items": {
"type": "number"
}
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"startMs",
"endMs",
"energy"
],
"properties": {
"endMs": {
"type": "number"
},
"energy": {
"type": "number"
},
"startMs": {
"type": "number"
}
},
"additionalProperties": true
}
},
"tempoBpm": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"analysisId": {
"type": "string"
},
"durationMs": {
"type": "number"
},
"themeStatus": {
"type": "string"
},
"understanding": {
"anyOf": [
{
"type": "object",
"required": [
"version",
"sourceAssetId",
"analysisId",
"masterDurationMs",
"language",
"transcription",
"timing",
"attribution",
"words",
"lines",
"speakers",
"segments"
],
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs",
"wordIds"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"wordIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
}
},
"additionalProperties": true
}
},
"lyrics": {
"type": "string"
},
"timing": {
"type": "object",
"required": [
"status",
"model",
"note"
],
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unavailable",
"ready",
"failed",
"instrumental"
]
}
},
"additionalProperties": true
},
"version": {
"enum": [
1
]
},
"language": {
"type": [
"string",
"null"
]
},
"segments": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"speakerId",
"startMs",
"endMs",
"text",
"wordIds",
"role",
"roleSource",
"overlappingSegmentIds"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"lead",
"feature",
"dj",
"adlib",
"unknown"
]
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"wordIds": {
"type": "array",
"items": {
"type": "string"
}
},
"speakerId": {
"type": [
"string",
"null"
]
},
"roleSource": {
"enum": [
"engine",
"user",
"unresolved"
]
},
"overlappingSegmentIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"speakers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"label",
"identity",
"evidence"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"evidence": {
"enum": [
"reference_match",
"user_confirmed",
"none"
]
},
"identity": {
"enum": [
"artist",
"unconfirmed"
]
}
},
"additionalProperties": true
}
},
"analysisId": {
"type": "string"
},
"attribution": {
"type": "object",
"required": [
"status",
"model",
"note"
],
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unavailable",
"ready",
"failed",
"instrumental"
]
}
},
"additionalProperties": true
},
"description": {
"type": "string"
},
"sourceAssetId": {
"type": "string"
},
"transcription": {
"type": "object",
"required": [
"status",
"model",
"note"
],
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unavailable",
"ready",
"failed",
"instrumental"
]
}
},
"additionalProperties": true
},
"masterDurationMs": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"understandingRevision": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"projectId": {
"type": "string"
},
"analysisJob": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"status"
],
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"uploadStatus": {
"enum": [
"attached",
"not_attached"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read song upload and analysis",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns an artist-photo upload widget and a one-time fallback uploadUrl. File bytes go directly to Brix36. Repeated calls return the same link or report an existing photo. No charge.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | The video whose artist needs the photo, from studio_video_start. |
{
"name": "studio_artist_photo",
"title": "Upload the artist photo in the chat",
"description": "Returns an artist-photo upload widget and a one-time fallback uploadUrl. File bytes go directly to Brix36. Repeated calls return the same link or report an existing photo. No charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video whose artist needs the photo, from studio_video_start."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"required": [
"view",
"purpose",
"projectId",
"artistId",
"uploadUrl",
"expiresAt"
]
},
{
"required": [
"code",
"message"
]
}
],
"properties": {
"code": {
"type": "string"
},
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"view": {
"const": "upload"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"message": {
"type": "string"
},
"purpose": {
"const": "artist_photo"
},
"artistId": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"projectId": {
"type": "string"
},
"uploadUrl": {
"type": "string"
},
"mediaOrigin": {
"type": "string"
},
"instructions": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
},
"annotations": {
"title": "Upload the artist photo in the chat",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Opens a file picker for a song, artist photo or image/video reference on the specified project. The customer selects the file; bytes go directly to Brix36. No paid work.
| Parameter | Type | Description |
|---|---|---|
| purpose * | string | The customer file role; this never selects a paid generation. |
| projectId * | string | The project receiving the file. Required for song, Artist DNA (artist is derived from the project) and reference attachment; no project is selected implicitly. |
{
"name": "studio_media_upload_widget",
"title": "Upload a file in chat",
"description": "Opens a file picker for a song, artist photo or image/video reference on the specified project. The customer selects the file; bytes go directly to Brix36. No paid work.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"purpose"
],
"properties": {
"purpose": {
"enum": [
"song",
"artist_photo",
"reference"
],
"type": "string",
"description": "The customer file role; this never selects a paid generation."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The project receiving the file. Required for song, Artist DNA (artist is derived from the project) and reference attachment; no project is selected implicitly."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"required": [
"view",
"purpose",
"projectId",
"maxBytes",
"allowedMimeTypes"
]
},
{
"required": [
"code",
"message"
]
}
],
"properties": {
"code": {
"type": "string"
},
"view": {
"const": "upload"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"message": {
"type": "string"
},
"purpose": {
"enum": [
"song",
"artist_photo",
"reference"
]
},
"maxBytes": {
"type": "integer"
},
"projectId": {
"type": "string"
},
"mediaOrigin": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
},
"allowedMimeTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"annotations": {
"title": "Upload a file in chat",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Creates an HTTPS POST upload capability bound to the user, project, role, exact file metadata and SHA-256, expiring in 15 minutes. Returns uploadUrl, uploadToken, method and expiresAt. The upload accepts raw bytes with the declared MIME Content-Type; attachment status is confirmed separately. No file bytes pass through MCP and no generation credits are spent.
| Parameter | Type | Description |
|---|---|---|
| name * | string | File name, not a local path. |
| size * | integer | |
| purpose * | string | The customer file role; this never selects a paid generation. |
| mimeType * | string | The file MIME type. |
| projectId * | string | The project receiving the file. Required for song, Artist DNA (artist is derived from the project) and reference attachment; no project is selected implicitly. |
| contentHash * | string | SHA-256 of the exact file bytes. The signed capability binds these bytes and cannot attach another file. |
{
"name": "studio_media_upload_url",
"title": "Prepare a signed file upload",
"description": "Creates an HTTPS POST upload capability bound to the user, project, role, exact file metadata and SHA-256, expiring in 15 minutes. Returns uploadUrl, uploadToken, method and expiresAt. The upload accepts raw bytes with the declared MIME Content-Type; attachment status is confirmed separately. No file bytes pass through MCP and no generation credits are spent.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"purpose",
"name",
"mimeType",
"size",
"contentHash"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "File name, not a local path."
},
"size": {
"type": "integer",
"maximum": 67108864,
"minimum": 1
},
"purpose": {
"enum": [
"song",
"artist_photo",
"reference"
],
"type": "string",
"description": "The customer file role; this never selects a paid generation."
},
"mimeType": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "The file MIME type."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The project receiving the file. Required for song, Artist DNA (artist is derived from the project) and reference attachment; no project is selected implicitly."
},
"contentHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "SHA-256 of the exact file bytes. The signed capability binds these bytes and cannot attach another file."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"uploadUrl",
"uploadToken",
"method",
"expiresAt"
],
"properties": {
"method": {
"enum": [
"POST"
]
},
"expiresAt": {
"type": "string"
},
"uploadUrl": {
"type": "string"
},
"uploadToken": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Prepare a signed file upload",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns pending or accepted attachment status and assetId for the exact owned uploadToken. Reconciles the existing upload without creating a second attachment, generating media or spending credits.
| Parameter | Type | Description |
|---|---|---|
| uploadToken * | string | The signed uploadToken returned by studio_media_upload_url. |
{
"name": "studio_media_confirm",
"title": "Confirm the uploaded file",
"description": "Returns pending or accepted attachment status and assetId for the exact owned uploadToken. Reconciles the existing upload without creating a second attachment, generating media or spending credits.",
"inputSchema": {
"type": "object",
"required": [
"uploadToken"
],
"properties": {
"uploadToken": {
"type": "string",
"maxLength": 4096,
"minLength": 1,
"description": "The signed uploadToken returned by studio_media_upload_url."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"pending"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"status",
"assetId"
],
"properties": {
"status": {
"enum": [
"accepted"
]
},
"assetId": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Confirm the uploaded file",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Import a public HTTPS song, artist photo or reference into the same private attachment pipeline as an upload. projectId is optional in the schema but required to attach media: omission returns guidance to select a project, never another user project. Refuses private/loopback destinations, unsafe redirects, DNS rebinding, invalid file types, oversized downloads and slow sources. Song/photo replacement rules remain unchanged. Identical reference bytes in the same project replay the existing asset. Returns assetId and status; no provider or language model is called.
| Parameter | Type | Description |
|---|---|---|
| url * | string | A direct public HTTPS media URL, port 443, without user credentials. |
| purpose * | string | The customer file role; this never selects a paid generation. |
| projectId | string | The project receiving the file. Required for song, Artist DNA (artist is derived from the project) and reference attachment; no project is selected implicitly. |
{
"name": "studio_media_import_url",
"title": "Import public HTTPS media",
"description": "Import a public HTTPS song, artist photo or reference into the same private attachment pipeline as an upload. projectId is optional in the schema but required to attach media: omission returns guidance to select a project, never another user project. Refuses private/loopback destinations, unsafe redirects, DNS rebinding, invalid file types, oversized downloads and slow sources. Song/photo replacement rules remain unchanged. Identical reference bytes in the same project replay the existing asset. Returns assetId and status; no provider or language model is called.",
"inputSchema": {
"type": "object",
"required": [
"purpose",
"url"
],
"properties": {
"url": {
"type": "string",
"pattern": "^https://[\\s\\S]*$",
"maxLength": 2048,
"minLength": 1,
"description": "A direct public HTTPS media URL, port 443, without user credentials."
},
"purpose": {
"enum": [
"song",
"artist_photo",
"reference"
],
"type": "string",
"description": "The customer file role; this never selects a paid generation."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The project receiving the file. Required for song, Artist DNA (artist is derived from the project) and reference attachment; no project is selected implicitly."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"assetId",
"status"
],
"properties": {
"scope": {
"enum": [
"shot",
"project"
]
},
"status": {
"enum": [
"pending",
"accepted"
]
},
"assetId": {
"type": "string"
},
"message": {
"type": "string"
},
"replayed": {
"type": "boolean"
},
"attachmentId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Import public HTTPS media",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Returns the project's 30-second storyboard sections, including indexes, times, names, inclusion, pictures, action, Performance/Story type and lyric line IDs with lip-sync settings. These indexes and IDs identify inputs to section-edit tools. Free and read-only.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string |
{
"name": "studio_sections_read",
"title": "Read the storyboard sections and their lines",
"description": "Returns the project's 30-second storyboard sections, including indexes, times, names, inclusion, pictures, action, Performance/Story type and lyric line IDs with lip-sync settings. These indexes and IDs identify inputs to section-edit tools. Free and read-only.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"sections",
"next"
],
"properties": {
"next": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"startMs",
"endMs",
"name",
"what",
"type",
"included",
"stillUrl",
"lines"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"performance",
"story"
]
},
"what": {
"type": "string"
},
"endMs": {
"type": "number"
},
"index": {
"type": "number"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs",
"role",
"sync"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"lead",
"adlib",
"guest"
]
},
"sync": {
"type": "boolean"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"guestName": {
"type": "string"
}
},
"additionalProperties": true
}
},
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"stillAssetId",
"stillUrl",
"label",
"startMs",
"endMs",
"stillState"
],
"properties": {
"endMs": {
"type": "number"
},
"label": {
"type": "string"
},
"startMs": {
"type": "number"
},
"stillUrl": {
"type": [
"string",
"null"
]
},
"stillState": {
"enum": [
"ready",
"making",
"needs_update",
"failed",
"none"
]
},
"stableShotId": {
"type": "string"
},
"stillAssetId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"startMs": {
"type": "number"
},
"included": {
"type": "boolean"
},
"stillUrl": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"projectId": {
"type": "string"
},
"revisionId": {
"type": [
"string",
"null"
]
},
"outputShape": {
"type": "string"
},
"outputIntent": {
"anyOf": [
{
"type": "object",
"required": [
"version",
"aspect",
"resolution",
"modelPreference"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"version": {
"enum": [
1
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
},
"modelPreference": {
"anyOf": [
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"enum": [
"auto"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"kind",
"modelKey"
],
"properties": {
"kind": {
"enum": [
"model"
]
},
"modelKey": {
"type": "string"
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"outputQuality": {
"enum": [
"720p",
"1080p",
"4k"
]
},
"defaultOutputIntent": {
"type": "object",
"required": [
"version",
"aspect",
"resolution",
"modelPreference"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"version": {
"enum": [
1
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
},
"modelPreference": {
"anyOf": [
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"enum": [
"auto"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"kind",
"modelKey"
],
"properties": {
"kind": {
"enum": [
"model"
]
},
"modelKey": {
"type": "string"
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read the storyboard sections and their lines",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Updates the supplied existing 30-second storyboard sections with what, type and included fields. The server owns section indexes, count, names, timing and pictures. All supplied edits succeed together or the prior board is restored with a refusal identifying the failed section. No generation or credit charge.
| Parameter | Type | Description |
|---|---|---|
| sections * | array | The drafted sections. Each names the index it changes and any of what, type, included. |
| projectId * | string |
{
"name": "studio_storyboard_write",
"title": "Write the storyboard sections the customer drafted",
"description": "Updates the supplied existing 30-second storyboard sections with what, type and included fields. The server owns section indexes, count, names, timing and pictures. All supplied edits succeed together or the prior board is restored with a refusal identifying the failed section. No generation or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"sections"
],
"properties": {
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"index"
],
"properties": {
"type": {
"type": "string",
"description": "Performance or Story. One of: \"performance\", \"story\"."
},
"what": {
"type": "string",
"maxLength": 2000,
"description": "\"What happens\" in this section."
},
"index": {
"type": "integer",
"maximum": 999,
"minimum": 0
},
"included": {
"type": "boolean",
"description": "The tick. False leaves this section out."
}
},
"additionalProperties": false
},
"maxItems": 24,
"minItems": 1,
"description": "The drafted sections. Each names the index it changes and any of what, type, included."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"written",
"sections",
"state",
"next",
"note"
],
"properties": {
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"state": {
"enum": [
"draft",
"storyboard_ready",
"making",
"ready",
"needs_attention"
]
},
"written": {
"type": "number"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"startMs",
"endMs",
"name",
"what",
"type",
"included",
"stillUrl",
"lines"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"performance",
"story"
]
},
"what": {
"type": "string"
},
"endMs": {
"type": "number"
},
"index": {
"type": "number"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs",
"role",
"sync"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"lead",
"adlib",
"guest"
]
},
"sync": {
"type": "boolean"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"guestName": {
"type": "string"
}
},
"additionalProperties": true
}
},
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"stillAssetId",
"stillUrl",
"label",
"startMs",
"endMs",
"stillState"
],
"properties": {
"endMs": {
"type": "number"
},
"label": {
"type": "string"
},
"startMs": {
"type": "number"
},
"stillUrl": {
"type": [
"string",
"null"
]
},
"stillState": {
"enum": [
"ready",
"making",
"needs_update",
"failed",
"none"
]
},
"stableShotId": {
"type": "string"
},
"stillAssetId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"startMs": {
"type": "number"
},
"included": {
"type": "boolean"
},
"stillUrl": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"projectId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Write the storyboard sections the customer drafted",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Updates included, type and/or what for one existing 30-second storyboard section. Omitted fields remain unchanged. Timing, names and pictures are outside this operation. No generation or charge.
| Parameter | Type | Description |
|---|---|---|
| type | string | Performance or Story. |
| what | string | "What happens" in this section. |
| index * | integer | |
| included | boolean | The tick. False leaves this section out of the generation. |
| projectId * | string | |
| revisionId | string | The revisionId returned by the read. Required by the hosted writer. |
{
"name": "studio_sections_update",
"title": "Change one section: tick, Performance/Story, or What happens",
"description": "Updates included, type and/or what for one existing 30-second storyboard section. Omitted fields remain unchanged. Timing, names and pictures are outside this operation. No generation or charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"index"
],
"properties": {
"type": {
"enum": [
"performance",
"story"
],
"type": "string",
"description": "Performance or Story."
},
"what": {
"type": "string",
"maxLength": 2000,
"description": "\"What happens\" in this section."
},
"index": {
"type": "integer",
"maximum": 999,
"minimum": 0
},
"included": {
"type": "boolean",
"description": "The tick. False leaves this section out of the generation."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The revisionId returned by the read. Required by the hosted writer."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"section",
"next"
],
"properties": {
"next": {
"type": "string"
},
"section": {
"type": "object",
"required": [
"index",
"startMs",
"endMs",
"name",
"what",
"type",
"included",
"stillUrl",
"lines"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"performance",
"story"
]
},
"what": {
"type": "string"
},
"endMs": {
"type": "number"
},
"index": {
"type": "number"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs",
"role",
"sync"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"lead",
"adlib",
"guest"
]
},
"sync": {
"type": "boolean"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"guestName": {
"type": "string"
}
},
"additionalProperties": true
}
},
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"stillAssetId",
"stillUrl",
"label",
"startMs",
"endMs",
"stillState"
],
"properties": {
"endMs": {
"type": "number"
},
"label": {
"type": "string"
},
"startMs": {
"type": "number"
},
"stillUrl": {
"type": [
"string",
"null"
]
},
"stillState": {
"enum": [
"ready",
"making",
"needs_update",
"failed",
"none"
]
},
"stableShotId": {
"type": "string"
},
"stillAssetId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"startMs": {
"type": "number"
},
"included": {
"type": "boolean"
},
"stillUrl": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"projectId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Change one section: tick, Performance/Story, or What happens",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Sets lip-sync for one existing lyric line identified by section index and stable line ID. sync:true means the artist mouths the line. Defaults are true for the artist's own words and false for guest/ad-lib lines. No generation or charge.
| Parameter | Type | Description |
|---|---|---|
| sync * | boolean | True when the artist mouths this line. |
| lineId * | string | The line id from studio_sections_read. |
| projectId * | string | |
| revisionId | string | The revisionId returned by the read. Required by the hosted writer. |
| expectedText | string | Exact line text from the read; a precondition, never an edit. Required by the hosted writer. |
| sectionIndex * | integer | |
| expectedStartMs | integer | Exact startMs from the read; a precondition, never a retiming. Required by the hosted writer. |
{
"name": "studio_sections_set_line_sync",
"title": "Set whether the artist mouths one line",
"description": "Sets lip-sync for one existing lyric line identified by section index and stable line ID. sync:true means the artist mouths the line. Defaults are true for the artist's own words and false for guest/ad-lib lines. No generation or charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"sectionIndex",
"lineId",
"sync"
],
"properties": {
"sync": {
"type": "boolean",
"description": "True when the artist mouths this line."
},
"lineId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The line id from studio_sections_read."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The revisionId returned by the read. Required by the hosted writer."
},
"expectedText": {
"type": "string",
"maxLength": 10000,
"description": "Exact line text from the read; a precondition, never an edit. Required by the hosted writer."
},
"sectionIndex": {
"type": "integer",
"maximum": 999,
"minimum": 0
},
"expectedStartMs": {
"type": "integer",
"minimum": 0,
"description": "Exact startMs from the read; a precondition, never a retiming. Required by the hosted writer."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"sectionIndex",
"line",
"next"
],
"properties": {
"line": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs",
"role",
"sync"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"lead",
"adlib",
"guest"
]
},
"sync": {
"type": "boolean"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"guestName": {
"type": "string"
}
},
"additionalProperties": true
},
"next": {
"type": "string"
},
"projectId": {
"type": "string"
},
"sectionIndex": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Set whether the artist mouths one line",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Imports finished screenplay-style Film text, with SCENE headings, NAME: dialogue and optional visualWorld. Preserves scenes, dialogue and speaker names, caps Film at five minutes and reports uncast speakers. Identical retries return the same plan. A visualWorld is required for quoting. No Brix36 planning model or credit charge.
| Parameter | Type | Description |
|---|---|---|
| cast | array | Optional: artist names to cast, in slot order. Names must be the customer's own artists. |
| script * | string | The finished script, exactly as written. Its language is preserved as-is. |
| language * | string | The selected Film language. The host validates its actual model capability; text is not translated. |
| projectId * | string | From studio_video_start with kind 'film'. |
| visualWorld | object | Board-wide visual facts. Optional characters, vehicles, locations, props and never are arrays of up to 12 non-empty strings, each at most 300 characters. Combined rendered fields are limited to 2,400 characters including labels, separators and newlines after trimming. Scene-specific costume and visu… |
| expectedRevisionId * | ["string","null"] | The revisionId from studio_sections_read, or null only when no storyboard exists. |
Validates a widget-selected stableShotId against the current visible storyboard and returns a request to price that picture change. No approval, generation or spending.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Current storyboard project. |
| stableShotId * | string | The shot whose picture the customer tapped. |
{
"name": "studio_storyboard_redo_request",
"title": "Request a picture redo",
"description": "Validates a widget-selected stableShotId against the current visible storyboard and returns a request to price that picture change. No approval, generation or spending.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"stableShotId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Current storyboard project."
},
"stableShotId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The shot whose picture the customer tapped."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"stableShotId",
"prompt"
],
"properties": {
"prompt": {
"type": "string"
},
"projectId": {
"type": "string"
},
"revisionId": {
"type": [
"string",
"null"
]
},
"stableShotId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Request a picture redo",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns the stored storyboard as 30-second section cards with lines and numbered shots. Each shot includes stableShotId and a signed stillUrl valid for about a day, or null if no picture exists. Supported hosts also receive an interactive preview. Free and read-only.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Project id from the Brix36 library. |
{
"name": "studio_storyboard_preview",
"title": "Preview the storyboard",
"description": "Returns the stored storyboard as 30-second section cards with lines and numbered shots. Each shot includes stableShotId and a signed stillUrl valid for about a day, or null if no picture exists. Supported hosts also receive an interactive preview. Free and read-only.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project id from the Brix36 library."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"required": [
"view",
"projectId",
"sections"
]
},
{
"required": [
"code",
"message"
]
}
],
"properties": {
"code": {
"type": "string"
},
"view": {
"const": "storyboard"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"message": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"performance",
"story"
]
},
"what": {
"type": "string"
},
"endMs": {
"type": "number"
},
"index": {
"type": "number"
},
"lines": {
"type": "array",
"items": {
"type": "object"
}
},
"shots": {
"type": "array",
"items": {
"type": "object"
}
},
"startMs": {
"type": "number"
},
"included": {
"type": "boolean"
},
"stillUrl": {
"type": [
"string",
"null"
]
}
}
}
},
"projectId": {
"type": "string"
},
"revisionId": {
"type": [
"string",
"null"
]
},
"mediaOrigin": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
},
"annotations": {
"title": "Preview the storyboard",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns current edit status and signed playback links for an existing finished master or selected range files, including finished results beside unfinished edits. Supported hosts receive players. No generation or credit charge.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Project id from the Brix36 library. |
{
"name": "studio_video_preview",
"title": "Play the finished video",
"description": "Returns current edit status and signed playback links for an existing finished master or selected range files, including finished results beside unfinished edits. Supported hosts receive players. No generation or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project id from the Brix36 library."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"required": [
"view",
"projectId",
"state",
"sections",
"artistNeedsPhoto"
]
},
{
"required": [
"code",
"message"
]
}
],
"properties": {
"code": {
"type": "string"
},
"view": {
"const": "video"
},
"issue": {
"type": "string"
},
"state": {
"type": "string"
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
}
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"message": {
"type": "string"
},
"ordered": {
"type": "boolean"
},
"artistId": {
"type": "string"
},
"sections": {
"type": "object",
"properties": {
"ready": {
"type": "number"
},
"total": {
"type": "number"
},
"failed": {
"type": "number"
},
"making": {
"type": "number"
},
"leftOut": {
"type": "number"
},
"waiting": {
"type": "number"
}
}
},
"projectId": {
"type": "string"
},
"mediaOrigin": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
},
"artistNeedsPhoto": {
"type": "boolean"
},
"artistPhotoReason": {
"type": "string"
}
},
"additionalProperties": true
},
"annotations": {
"title": "Play the finished video",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns signed download links for existing finished Music video or Film results and selected range files, including results beside unfinished edits. No public publishing, render, payment or extra export charge.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Project id from the Brix36 library. |
{
"name": "studio_video_export",
"title": "Get a video download link",
"description": "Returns signed download links for existing finished Music video or Film results and selected range files, including results beside unfinished edits. No public publishing, render, payment or extra export charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project id from the Brix36 library."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"downloadUrl",
"mimeType",
"note"
],
"properties": {
"note": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"projectId": {
"type": "string"
},
"downloadUrl": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Get a video download link",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Prices missing storyboard pictures plus the exact video price for one run without spending credits. Returns totalCredits, totalGbpInclVat, balance, shortfall, signed quoteToken, operationId, revisionId and priceVersion. engineRecommendations contains server-ranked choices, current selections and quoted alternatives; section engine selection returns a revised quote. Film filmScenes can quote one scene preview at a time (renderOnly:true), or remake named/missing scenes and assemble all saved clips (renderOnly:false). After each preview confirm, check the result, and quote the next scene. Film quotes include per-character, per-scene speech, motion and lip-sync routes, or historical_unavailable when prior evidence is absent. Chat-mode confirmation uses these exact quote fields. The saved financial approval covers pictures and video; requested picture changes have separate quotes. No checkout or approval-page URL is created. Existing app approvals and issued codes remain supported.
| Parameter | Type | Description |
|---|---|---|
| scope * | string | 'whole' for the whole song, 'ticked' for the sections currently ticked on the board. |
| projectId * | string | |
| filmScenes | object | |
| operationId * | string | Stable operation identifier shared by this quote and its confirmation. |
| stillQuality | string | Picture quality for the pictures. Default high. |
| stillShotIds | array | Optional customer-selected stableShotIds from studio_sections_read. Absence selects every shot without a picture. Other shots may have separate later quotes and financial approvals. |
Waits up to 45 seconds for an active rendering stage to finish, then returns its current state and continuation data. Reads a saved whole-job or picture-only operation by its original projectId and operationId. Returns approval and generation state, next-step data, balance or shortfall where applicable, and any fresh unapproved quote. Whole-job states include making_pictures, pictures_ready, video_waiting_for_payment, starting_video, making_video and failed. Picture-only approval covers only its quoted pictures. Video retains the original financial approval and applicable readiness gates; likeness not_required needs no likeness verdict. This free read does not advance stages or charge credits.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| operationId * | string | The original operationId from studio_generation_quote or studio_storyboard_stills_quote. |
{
"name": "studio_generation_status",
"title": "Where an approved generation has got to",
"description": "Waits up to 45 seconds for an active rendering stage to finish, then returns its current state and continuation data. Reads a saved whole-job or picture-only operation by its original projectId and operationId. Returns approval and generation state, next-step data, balance or shortfall where applicable, and any fresh unapproved quote. Whole-job states include making_pictures, pictures_ready, video_waiting_for_payment, starting_video, making_video and failed. Picture-only approval covers only its quoted pictures. Video retains the original financial approval and applicable readiness gates; likeness not_required needs no likeness verdict. This free read does not advance stages or charge credits.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"operationId": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 128,
"minLength": 8,
"description": "The original operationId from studio_generation_quote or studio_storyboard_stills_quote."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"operationId",
"creditsInformationUrl",
"stage",
"next",
"state",
"totalCredits",
"totalGbpInclVat",
"allowance",
"videoCapCredits",
"balance",
"shortfallNow",
"shortfall",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage"
],
"properties": {
"next": {
"type": "string"
},
"issue": {
"type": "string"
},
"stage": {
"enum": [
"waiting_for_chat_approval_or_top_up",
"waiting_for_approval",
"making_pictures",
"pictures_ready",
"video_waiting_for_payment",
"starting_video",
"making_video",
"failed",
"ready"
]
},
"state": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"pictures": {
"type": "object",
"required": [
"making",
"failed",
"missing"
],
"properties": {
"failed": {
"type": "number"
},
"making": {
"type": "number"
},
"missing": {
"type": "number"
}
},
"additionalProperties": true
},
"allowance": {
"type": "object",
"required": [
"picturesLeft",
"creditsLeft"
],
"properties": {
"creditsLeft": {
"type": "number"
},
"picturesLeft": {
"type": "number"
}
},
"additionalProperties": true
},
"completed": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"freshQuote": {
"type": "object",
"required": [
"revisionId",
"priceVersion",
"approvalId",
"approvalExpiresAt",
"state",
"quoteToken",
"modelId",
"totalCredits",
"totalGbpInclVat",
"stills",
"redos",
"video",
"balance",
"shortfallNow",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage",
"shortfall",
"operationId"
],
"properties": {
"redos": {
"type": "object",
"required": [
"allowance",
"creditCap",
"used",
"usedCredits"
],
"properties": {
"used": {
"type": "number"
},
"allowance": {
"type": "number"
},
"creditCap": {
"type": "number"
},
"usedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"state": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"video": {
"type": "object",
"required": [
"capCredits"
],
"properties": {
"capCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"stills": {
"type": "object",
"required": [
"shotCount",
"credits"
],
"properties": {
"credits": {
"type": "number"
},
"shotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"approvalId": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"consentMode": {
"enum": [
"chat"
]
},
"operationId": {
"type": "string"
},
"priceVersion": {
"type": "string"
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"approvalExpiresAt": {
"type": "string"
},
"topUpGbpInclVatNow": {
"type": "string"
}
},
"additionalProperties": true
},
"failureCode": {
"type": "string"
},
"operationId": {
"type": "string"
},
"continuation": {
"type": "object",
"required": [
"tool",
"arguments",
"waitSeconds"
],
"properties": {
"tool": {
"enum": [
"studio_generation_wait"
]
},
"arguments": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
"waitSeconds": {
"type": "number"
}
},
"additionalProperties": true
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"videoCapCredits": {
"type": "number"
},
"topUpGbpInclVatNow": {
"type": "string"
},
"creditsInformationUrl": {
"type": "string"
},
"customerActionRequired": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Where an approved generation has got to",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Waits up to 45 seconds for active picture generation or the finished video. projectId identifies the video; optional operationId identifies its original picture/video approval. A pending response is a nonterminal timeout containing the exact nextCall for another bounded wait. A completed video response contains video.url. Free and read-only; no generation, approval, quote, payment or credit change.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| operationId | string | Original operationId, when waiting on the picture stage or a combined generation. |
{
"name": "studio_generation_wait",
"title": "Wait for rendering and the finished video link",
"description": "Waits up to 45 seconds for active picture generation or the finished video. projectId identifies the video; optional operationId identifies its original picture/video approval. A pending response is a nonterminal timeout containing the exact nextCall for another bounded wait. A completed video response contains video.url. Free and read-only; no generation, approval, quote, payment or credit change.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 8,
"description": "Original operationId, when waiting on the picture stage or a combined generation."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"status",
"pending",
"completed",
"customerActionRequired",
"nextCall",
"next"
],
"properties": {
"next": {
"type": "string"
},
"status": {
"enum": [
"still_rendering"
]
},
"pending": {
"const": true
},
"nextCall": {
"type": "object",
"required": [
"tool",
"arguments"
],
"properties": {
"tool": {
"enum": [
"studio_generation_wait"
]
},
"arguments": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"completed": {
"const": false
},
"projectId": {
"type": "string"
},
"customerActionRequired": {
"const": false
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"projectId",
"operationId",
"creditsInformationUrl",
"stage",
"next",
"state",
"totalCredits",
"totalGbpInclVat",
"allowance",
"videoCapCredits",
"balance",
"shortfallNow",
"shortfall",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage",
"pending"
],
"properties": {
"next": {
"type": "string"
},
"issue": {
"type": "string"
},
"stage": {
"enum": [
"waiting_for_chat_approval_or_top_up",
"waiting_for_approval",
"making_pictures",
"pictures_ready",
"video_waiting_for_payment",
"starting_video",
"making_video",
"failed",
"ready"
]
},
"state": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"pending": {
"const": false
},
"pictures": {
"type": "object",
"required": [
"making",
"failed",
"missing"
],
"properties": {
"failed": {
"type": "number"
},
"making": {
"type": "number"
},
"missing": {
"type": "number"
}
},
"additionalProperties": true
},
"allowance": {
"type": "object",
"required": [
"picturesLeft",
"creditsLeft"
],
"properties": {
"creditsLeft": {
"type": "number"
},
"picturesLeft": {
"type": "number"
}
},
"additionalProperties": true
},
"completed": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"freshQuote": {
"type": "object",
"required": [
"revisionId",
"priceVersion",
"approvalId",
"approvalExpiresAt",
"state",
"quoteToken",
"modelId",
"totalCredits",
"totalGbpInclVat",
"stills",
"redos",
"video",
"balance",
"shortfallNow",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage",
"shortfall",
"operationId"
],
"properties": {
"redos": {
"type": "object",
"required": [
"allowance",
"creditCap",
"used",
"usedCredits"
],
"properties": {
"used": {
"type": "number"
},
"allowance": {
"type": "number"
},
"creditCap": {
"type": "number"
},
"usedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"state": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"video": {
"type": "object",
"required": [
"capCredits"
],
"properties": {
"capCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"stills": {
"type": "object",
"required": [
"shotCount",
"credits"
],
"properties": {
"credits": {
"type": "number"
},
"shotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"approvalId": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"consentMode": {
"enum": [
"chat"
]
},
"operationId": {
"type": "string"
},
"priceVersion": {
"type": "string"
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"approvalExpiresAt": {
"type": "string"
},
"topUpGbpInclVatNow": {
"type": "string"
}
},
"additionalProperties": true
},
"failureCode": {
"type": "string"
},
"operationId": {
"type": "string"
},
"continuation": {
"type": "object",
"required": [
"tool",
"arguments",
"waitSeconds"
],
"properties": {
"tool": {
"enum": [
"studio_generation_wait"
]
},
"arguments": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
"waitSeconds": {
"type": "number"
}
},
"additionalProperties": true
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"videoCapCredits": {
"type": "number"
},
"topUpGbpInclVatNow": {
"type": "string"
},
"creditsInformationUrl": {
"type": "string"
},
"customerActionRequired": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"projectId",
"state",
"progress",
"next",
"note",
"pending"
],
"properties": {
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"issue": {
"type": "string"
},
"state": {
"enum": [
"draft",
"storyboard_ready",
"making",
"ready",
"needs_attention"
]
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
},
"additionalProperties": true
},
"pending": {
"const": false
},
"progress": {
"type": "object",
"required": [
"total",
"ready",
"making",
"waiting",
"leftOut",
"failed"
],
"properties": {
"ready": {
"type": "number"
},
"total": {
"type": "number"
},
"failed": {
"type": "number"
},
"making": {
"type": "number"
},
"leftOut": {
"type": "number"
},
"waiting": {
"type": "number"
}
},
"additionalProperties": true
},
"completed": {
"type": "boolean"
},
"generated": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"continuation": {
"type": "object",
"required": [
"tool",
"arguments",
"waitSeconds"
],
"properties": {
"tool": {
"type": "string"
},
"arguments": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string"
}
},
"additionalProperties": true
},
"waitSeconds": {
"type": "number"
}
},
"additionalProperties": true
},
"libraryGroup": {
"enum": [
"finished",
"in_progress",
"carry_on",
"needs_attention"
]
},
"libraryAction": {
"enum": [
"open",
"carry_on",
"none"
]
},
"libraryBucket": {
"enum": [
"finished",
"to_finish"
]
},
"libraryInFlight": {
"type": "boolean"
},
"libraryStatusLabel": {
"type": "string"
},
"customerActionRequired": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Wait for rendering and the finished video link",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Prices requested picture changes by original projectId/operationId, a new requestId and selected stableShotIds. New approvals produce separate picture-only quotes containing operationId, quoteToken, revisionId, modelId, mode, priceVersion and totalCredits. Identical requestId retries return the original quotes. Historical approvals can complete their previously approved paid picture changes. No charge for quoting.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| requestId * | string | New identifier for this picture-change request. Identical retries retain the original requestId. |
| operationId * | string | The operationId of the customer's approval (from studio_generation_quote). |
| stableShotIds * | array | The shots to redo or make, as stableShotIds from studio_storyboard_preview. |
{
"name": "studio_storyboard_picture_changes_prepare",
"title": "Prepare selected storyboard picture changes",
"description": "Prices requested picture changes by original projectId/operationId, a new requestId and selected stableShotIds. New approvals produce separate picture-only quotes containing operationId, quoteToken, revisionId, modelId, mode, priceVersion and totalCredits. Identical requestId retries return the original quotes. Historical approvals can complete their previously approved paid picture changes. No charge for quoting.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"requestId",
"stableShotIds"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"requestId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]+$",
"maxLength": 64,
"minLength": 8,
"description": "New identifier for this picture-change request. Identical retries retain the original requestId."
},
"operationId": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 128,
"minLength": 8,
"description": "The operationId of the customer's approval (from studio_generation_quote)."
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"maxItems": 10,
"minItems": 1,
"description": "The shots to redo or make, as stableShotIds from studio_storyboard_preview.",
"uniqueItems": true
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"requestId",
"replayed",
"shots",
"creditsUsed",
"jobIds",
"allowance"
],
"properties": {
"shots": {
"type": "array",
"items": {
"type": "string"
}
},
"jobIds": {
"type": "array",
"items": {
"type": "string"
}
},
"replayed": {
"type": "boolean"
},
"allowance": {
"type": "object",
"required": [
"picturesLeft",
"creditsLeft"
],
"properties": {
"creditsLeft": {
"type": "number"
},
"picturesLeft": {
"type": "number"
}
},
"additionalProperties": true
},
"requestId": {
"type": "string"
},
"creditsUsed": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"requestId",
"replayed",
"shots",
"creditsUsed",
"jobIds",
"allowance",
"outcome",
"quotes",
"note"
],
"properties": {
"note": {
"type": "string"
},
"shots": {
"type": "array",
"items": {
"type": "string"
}
},
"jobIds": {
"type": "array",
"items": {
"type": "string"
}
},
"quotes": {
"type": "array",
"items": {
"type": "object",
"required": [
"projectId",
"operationId",
"revisionId",
"mode",
"quoteKind",
"quoteToken",
"modelId",
"stableShotIds",
"quality",
"priceVersion",
"approvalState",
"expiresAt",
"creditAmount",
"totalCredits",
"totalGbpInclVat",
"balance",
"shortfall",
"note"
],
"properties": {
"mode": {
"enum": [
"missing",
"new_version"
]
},
"note": {
"type": "string"
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"quality": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"projectId": {
"type": "string"
},
"quoteKind": {
"enum": [
"storyboard_stills"
]
},
"shortfall": {
"type": "number"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"consentMode": {
"enum": [
"chat"
]
},
"operationId": {
"type": "string"
},
"creditAmount": {
"type": "number"
},
"priceVersion": {
"type": "string"
},
"totalCredits": {
"type": "number"
},
"approvalState": {
"type": "string"
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"totalGbpInclVat": {
"type": "string"
}
},
"additionalProperties": true
}
},
"outcome": {
"enum": [
"confirmation_required"
]
},
"replayed": {
"type": "boolean"
},
"allowance": {
"type": "object",
"required": [
"picturesLeft",
"creditsLeft"
],
"properties": {
"creditsLeft": {
"type": "number"
},
"picturesLeft": {
"type": "number"
}
},
"additionalProperties": true
},
"requestId": {
"type": "string"
},
"creditsUsed": {
"type": "number"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Prepare selected storyboard picture changes",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Spends Brix36 credits and starts the quoted work under the customer's financial approval. In chat mode, stage:pictures records one approval for pictures and video using the original operationId, quoteToken, priceVersion, quotedCredits and revisionId. Insufficient balance returns balance, shortfall and creditsInformationUrl without a checkout. Stage:video uses the current picture revision and the same financial approval, subject to the existing readiness gates. Identical stage and argument retries reconcile the same operation. New authorizations retain pause/cap, OAuth studio.spend, account and exact-quote checks. The response waits up to 45 seconds for the started stage and includes current progress, a finished video link when available, or the free status-call arguments for work still rendering. Existing page-approved operations and confirmationToken codes remain supported.
| Parameter | Type | Description |
|---|---|---|
| stage | string | Chat mode: pictures records one financial approval and starts pictures; video starts video under that same approval and the current readiness gates. Each retry retains its original stage. |
| modelId | string | Optional with an approved quote (the approved model is used). Otherwise the id of the model the customer chose, from that quote's models list. |
| projectId * | string | |
| quoteToken * | string | The exact opaque quoteToken returned by studio_generation_quote. |
| revisionId | string | For pictures, the quoted revisionId; for video, the current picture revision with applicable readiness checks satisfied. |
Records the person's own answer to the AI-sharing question after a creation tool returned ai_processing_choice_required. allowed true means Allow and false means Not now. Consent counts only as that explicit reply; it is never inferred from the request to create and never supplied on the person's behalf. supersedes is the sequence that refusal returned (null when it was unset). Returns the stored answer; nothing is created or charged.
| Parameter | Type | Description |
|---|---|---|
| allowed * | boolean | The person's explicit answer: true for Allow, false for Not now. |
| supersedes | ["integer","null"] | The sequence from the ai_processing_choice_required refusal; null when it was unset. |
{
"name": "studio_ai_sharing_choose",
"title": "Record the AI-sharing answer",
"description": "Records the person's own answer to the AI-sharing question after a creation tool returned ai_processing_choice_required. allowed true means Allow and false means Not now. Consent counts only as that explicit reply; it is never inferred from the request to create and never supplied on the person's behalf. supersedes is the sequence that refusal returned (null when it was unset). Returns the stored answer; nothing is created or charged.",
"inputSchema": {
"type": "object",
"required": [
"allowed"
],
"properties": {
"allowed": {
"type": "boolean",
"description": "The person's explicit answer: true for Allow, false for Not now."
},
"supersedes": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "The sequence from the ai_processing_choice_required refusal; null when it was unset."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"saved",
"allowed"
],
"properties": {
"note": {
"type": "string"
},
"saved": {
"type": "boolean"
},
"allowed": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Record the AI-sharing answer",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Waits up to 45 seconds while rendering, then returns draft, storyboard_ready, making, ready or needs_attention state, section progress counts, the studio's explanation and video.url when finished, with selected range labels, extent and original file links. Excluded sections are counted separately from failures. Provider fallback remains within the quoted price. No new work or charge.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string |
{
"name": "studio_video_status",
"title": "How this video is going, and the finished video link",
"description": "Waits up to 45 seconds while rendering, then returns draft, storyboard_ready, making, ready or needs_attention state, section progress counts, the studio's explanation and video.url when finished, with selected range labels, extent and original file links. Excluded sections are counted separately from failures. Provider fallback remains within the quoted price. No new work or charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"state",
"progress",
"next",
"note"
],
"properties": {
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"issue": {
"type": "string"
},
"state": {
"enum": [
"draft",
"storyboard_ready",
"making",
"ready",
"needs_attention"
]
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
},
"additionalProperties": true
},
"progress": {
"type": "object",
"required": [
"total",
"ready",
"making",
"waiting",
"leftOut",
"failed"
],
"properties": {
"ready": {
"type": "number"
},
"total": {
"type": "number"
},
"failed": {
"type": "number"
},
"making": {
"type": "number"
},
"leftOut": {
"type": "number"
},
"waiting": {
"type": "number"
}
},
"additionalProperties": true
},
"completed": {
"type": "boolean"
},
"generated": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"continuation": {
"type": "object",
"required": [
"tool",
"arguments",
"waitSeconds"
],
"properties": {
"tool": {
"type": "string"
},
"arguments": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string"
}
},
"additionalProperties": true
},
"waitSeconds": {
"type": "number"
}
},
"additionalProperties": true
},
"libraryGroup": {
"enum": [
"finished",
"in_progress",
"carry_on",
"needs_attention"
]
},
"libraryAction": {
"enum": [
"open",
"carry_on",
"none"
]
},
"libraryBucket": {
"enum": [
"finished",
"to_finish"
]
},
"libraryInFlight": {
"type": "boolean"
},
"libraryStatusLabel": {
"type": "string"
},
"customerActionRequired": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "How this video is going, and the finished video link",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Prices selected storyboard pictures without spending. Supports missing pictures or new_version for exactly one existing picture, bound to the current revision, quality and stableShotIds. lookTest:true selects the saved bounded key-look set. Returns a signed picture-only quote and exact confirmation fields. Missing operationId is derived by the server; new_version uses a stable op_ ID. Chat approval and existing issued confirmation codes are supported. Short balance returns credit information only. This quote covers no video or planning model.
| Parameter | Type | Description |
|---|---|---|
| mode * | string | missing prepares selected shots without pictures; new_version buys another picture for exactly one shot that already has one. |
| quality * | string | The customer’s explicit picture quality; high is the app’s best-picture option. |
| lookTest | boolean | For missing mode, true selects the approved storyboard’s saved key-look set. In this mode stableShotIds and operationId are absent. |
| projectId * | string | The music-video or Film project id. |
| revisionId * | string | Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision. |
| operationId | string | Stable operationId from the picture quote. A new_version operation uses op_ followed by 10–120 letters, digits, underscores or dashes. |
Spends Brix36 credits for exactly the approved quoted pictures. Chat mode requires the quote's unchanged projectId, revisionId, mode, operationId, quoteToken, modelId, priceVersion and quotedCredits. Insufficient balance returns balance, shortfall and creditsInformationUrl without a checkout. Durable purchase/job reconciliation makes identical retries safe, including after expiry. Legacy confirmationToken remains supported. No video authorization or planning-model call.
| Parameter | Type | Description |
|---|---|---|
| mode * | string | missing prepares selected shots without pictures; new_version buys another picture for exactly one shot that already has one. |
| modelId * | string | The exact modelId label returned with that still quote. |
| projectId * | string | The music-video or Film project id. |
| quoteToken * | string | The exact opaque quoteToken returned by studio_storyboard_stills_quote. |
| revisionId * | string | Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision. |
| operationId * | string | Stable operationId from the picture quote. A new_version operation uses op_ followed by 10–120 letters, digits, underscores or dashes. |
Records the customer's storyboard approval for the exact current revisionId using the app's approval service. Changed revisions are refused. Directed-board and existing purchase guards remain enforced. No credits are spent and no media is generated.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | The music-video or Film project id. |
| revisionId * | string | Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision. |
{
"name": "studio_storyboard_approve",
"title": "Approve the customer’s storyboard",
"description": "Records the customer's storyboard approval for the exact current revisionId using the app's approval service. Changed revisions are refused. Directed-board and existing purchase guards remain enforced. No credits are spent and no media is generated.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"revisionId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The music-video or Film project id."
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"revision",
"status",
"generator",
"shotCount",
"createdAt",
"directionStatus",
"audioAnalysisId",
"treatmentVersionId",
"approvedAt"
],
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"approved"
]
},
"revision": {
"type": "number"
},
"createdAt": {
"type": "string"
},
"generator": {
"enum": [
"placeholder",
"llm_plan",
"user_edited",
"audio_planned"
]
},
"shotCount": {
"type": "number"
},
"approvedAt": {
"type": "string"
},
"audioAnalysisId": {
"type": [
"string",
"null"
]
},
"directionStatus": {
"enum": [
"placeholder",
"directed"
]
},
"treatmentVersionId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Approve the customer’s storyboard",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns readyForVideo, shotsMissingStills, public likenessGate, look-test state and reviewStills for the exact project and revision. Each review binding identifies a saved stableShotId/stillAssetId. A likenessGate of not_required needs no likeness verdict; an absent look test needs no look acceptance. Required likeness verdicts and acceptance of the saved look set are recorded separately. Video uses the original approved price and the existing readiness gates. No state change, provider call or charge.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | The music-video or Film project id. |
| revisionId * | string | Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision. |
{
"name": "studio_storyboard_readiness",
"title": "Check storyboard picture readiness",
"description": "Returns readyForVideo, shotsMissingStills, public likenessGate, look-test state and reviewStills for the exact project and revision. Each review binding identifies a saved stableShotId/stillAssetId. A likenessGate of not_required needs no likeness verdict; an absent look test needs no look acceptance. Required likeness verdicts and acceptance of the saved look set are recorded separately. Video uses the original approved price and the existing readiness gates. No state change, provider call or charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"revisionId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The music-video or Film project id."
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"readyForVideo",
"shotsMissingStills",
"likenessGate",
"lookTest",
"reviewStills"
],
"properties": {
"lookTest": {
"type": "object",
"required": [
"state",
"stableShotIds",
"missingStableShotIds"
],
"properties": {
"state": {
"enum": [
"not_started",
"preparing",
"review",
"accepted"
]
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"missingStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"likenessGate": {
"type": "object",
"required": [
"state",
"requiredStableShotIds",
"pendingStableShotIds",
"confirmedStableShotIds",
"rejectedStableShotIds"
],
"properties": {
"state": {
"enum": [
"not_required",
"pending",
"confirmed",
"rejected"
]
},
"pendingStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"rejectedStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"requiredStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"confirmedStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"reviewStills": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"stillAssetId",
"likenessRequired",
"lookSelected"
],
"properties": {
"lookSelected": {
"type": "boolean"
},
"stableShotId": {
"type": "string"
},
"stillAssetId": {
"type": [
"string",
"null"
]
},
"likenessRequired": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"readyForVideo": {
"type": "boolean"
},
"shotsMissingStills": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Check storyboard picture readiness",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Record the customer’s confirmed or rejected likeness verdict for one exact saved picture. Requires the revision, shot and still asset the customer reviewed. Changes no picture and spends no credits.
| Parameter | Type | Description |
|---|---|---|
| verdict * | string | For record_likeness: confirmed means the customer said this picture carries the right likeness; rejected means the customer said replace it. |
| projectId * | string | The music-video or Film project id. |
| revisionId * | string | Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision. |
| stableShotId * | string | For record_likeness: the exact stableShotId shown to the customer. |
| expectedStillAssetId * | string | For record_likeness: the exact saved stillAssetId reviewed by the customer, binding the verdict to that picture. |
{
"name": "studio_storyboard_likeness_record",
"title": "Record the customer’s likeness verdict",
"description": "Record the customer’s confirmed or rejected likeness verdict for one exact saved picture. Requires the revision, shot and still asset the customer reviewed. Changes no picture and spends no credits.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"revisionId",
"stableShotId",
"expectedStillAssetId",
"verdict"
],
"properties": {
"verdict": {
"enum": [
"confirmed",
"rejected"
],
"type": "string",
"description": "For record_likeness: confirmed means the customer said this picture carries the right likeness; rejected means the customer said replace it."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The music-video or Film project id."
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision."
},
"stableShotId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "For record_likeness: the exact stableShotId shown to the customer."
},
"expectedStillAssetId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "For record_likeness: the exact saved stillAssetId reviewed by the customer, binding the verdict to that picture."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"action",
"projectId",
"revisionId",
"likenessGate",
"note"
],
"properties": {
"note": {
"type": "string"
},
"action": {
"enum": [
"record_likeness"
]
},
"projectId": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"likenessGate": {
"type": "object",
"required": [
"state",
"requiredStableShotIds",
"pendingStableShotIds",
"confirmedStableShotIds",
"rejectedStableShotIds"
],
"properties": {
"state": {
"enum": [
"not_required",
"pending",
"confirmed",
"rejected"
]
},
"pendingStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"rejectedStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"requiredStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"confirmedStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"action",
"projectId",
"revisionId",
"lookTest",
"note"
],
"properties": {
"note": {
"type": "string"
},
"action": {
"enum": [
"accept_look"
]
},
"lookTest": {
"type": "object",
"required": [
"state",
"stableShotIds",
"missingStableShotIds"
],
"properties": {
"state": {
"enum": [
"not_started",
"preparing",
"review",
"accepted"
]
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"missingStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"projectId": {
"type": "string"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Record the customer’s likeness verdict",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Record the customer’s acceptance of the complete saved key-look picture set. Supply the exact revision and shot/asset pairs reviewed. Changes no picture and spends no credits.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | The music-video or Film project id. |
| revisionId * | string | Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision. |
| expectedStills * | array | For accept_look: the complete saved lookTest.stableShotIds set paired with the stillAssetIds reviewed by the customer. Corresponds to readiness.reviewStills entries with lookSelected:true, with one saved picture per stableShotId. |
{
"name": "studio_storyboard_look_accept",
"title": "Record the customer’s look acceptance",
"description": "Record the customer’s acceptance of the complete saved key-look picture set. Supply the exact revision and shot/asset pairs reviewed. Changes no picture and spends no credits.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"revisionId",
"expectedStills"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The music-video or Film project id."
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision."
},
"expectedStills": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"stillAssetId"
],
"properties": {
"stableShotId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "A saved key-look stableShotId."
},
"stillAssetId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The exact current saved picture the customer accepted for that shot."
}
},
"additionalProperties": false
},
"maxItems": 5,
"minItems": 1,
"description": "For accept_look: the complete saved lookTest.stableShotIds set paired with the stillAssetIds reviewed by the customer. Corresponds to readiness.reviewStills entries with lookSelected:true, with one saved picture per stableShotId.",
"uniqueItems": true
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"action",
"projectId",
"revisionId",
"likenessGate",
"note"
],
"properties": {
"note": {
"type": "string"
},
"action": {
"enum": [
"record_likeness"
]
},
"projectId": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"likenessGate": {
"type": "object",
"required": [
"state",
"requiredStableShotIds",
"pendingStableShotIds",
"confirmedStableShotIds",
"rejectedStableShotIds"
],
"properties": {
"state": {
"enum": [
"not_required",
"pending",
"confirmed",
"rejected"
]
},
"pendingStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"rejectedStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"requiredStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"confirmedStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"action",
"projectId",
"revisionId",
"lookTest",
"note"
],
"properties": {
"note": {
"type": "string"
},
"action": {
"enum": [
"accept_look"
]
},
"lookTest": {
"type": "object",
"required": [
"state",
"stableShotIds",
"missingStableShotIds"
],
"properties": {
"state": {
"enum": [
"not_started",
"preparing",
"review",
"accepted"
]
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"missingStableShotIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"projectId": {
"type": "string"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Record the customer’s look acceptance",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Saves finished song understanding against the current analysisId, assetId and understandingRevision. Accepts lyrics/description, language, themes and required words/lines arrays in the timed-transcription shape; empty arrays represent unavailable genuine timing. Source text alone supplies no lip-sync timing or voice ownership. voiceAnswer represents the customer's all_me, other_voices or skipped decision. Preserves measured audio facts and returns canonical understanding with a new revision. Stale input is refused. No transcription/planning model or credit charge.
| Parameter | Type | Description |
|---|---|---|
| lines * | array | TimedLine text/startMs/endMs, requiring supplied timed words. An empty array leaves section line-sync empty; prose alone supplies no timing. |
| words * | array | Existing TimedWord shape: text/startMs/endMs. Genuine customer-supplied master timing only; [] when unknown. IDs are assigned by the canonical app normalizer. |
| lyrics | string | Customer-supplied source lyrics with original line breaks. Absence retains existing lyrics; an empty string clears them. |
| themes | array | Optional song themes. Absence retains existing themes; [] clears them. |
| language | ["string","null"] | Customer-supplied language, null when unknown. Absence retains the existing language. |
| projectId * | string | Project whose currently uploaded master song is being described. |
| description |
Searches Brix36 creative skills and style cards by keyword, medium or family. Returns summaries rather than full bodies, plus resource URIs and nextCursor. No Brix36 language-model call.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum items to return, 1–50. Default 20. |
| query | string | Words to match in the approved catalogue. |
| cursor | string | Opaque previous-page nextCursor; absent for the first page. |
| family | string | Catalogue family returned by a previous result. |
| medium | string | one of ["music_video","film","advert_ugc","talking_video"] |
{
"name": "studio_list_skills",
"title": "Find Brix36 creative skills",
"description": "Searches Brix36 creative skills and style cards by keyword, medium or family. Returns summaries rather than full bodies, plus resource URIs and nextCursor. No Brix36 language-model call.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum items to return, 1–50. Default 20."
},
"query": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Words to match in the approved catalogue."
},
"cursor": {
"type": "string",
"maxLength": 512,
"minLength": 1,
"description": "Opaque previous-page nextCursor; absent for the first page."
},
"family": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Catalogue family returned by a previous result."
},
"medium": {
"enum": [
"music_video",
"film",
"advert_ugc",
"talking_video"
],
"type": "string"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"skills",
"nextCursor"
],
"properties": {
"skills": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"description",
"family",
"medium",
"version",
"uri"
],
"properties": {
"id": {
"type": "string"
},
"uri": {
"type": "string"
},
"name": {
"type": "string"
},
"family": {
"type": "string"
},
"medium": {
"enum": [
"music_video",
"film",
"advert_ugc",
"talking_video",
"any"
]
},
"version": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": true
}
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Find Brix36 creative skills",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns one Brix36 creative skill, style card or writing guide by catalogue ID, including full body, version, hash and resource URI. Read-only.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Exact id returned by studio_list_skills. |
{
"name": "studio_get_skill",
"title": "Read a Brix36 creative skill",
"description": "Returns one Brix36 creative skill, style card or writing guide by catalogue ID, including full body, version, hash and resource URI. Read-only.",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 240,
"minLength": 1,
"description": "Exact id returned by studio_list_skills."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"name",
"description",
"family",
"medium",
"version",
"uri",
"text",
"sha256"
],
"properties": {
"id": {
"type": "string"
},
"uri": {
"type": "string"
},
"name": {
"type": "string"
},
"text": {
"type": "string"
},
"family": {
"type": "string"
},
"medium": {
"enum": [
"music_video",
"film",
"advert_ugc",
"talking_video",
"any"
]
},
"sha256": {
"type": "string"
},
"version": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read a Brix36 creative skill",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Saves a ready server-rendered Motion scene and returns its exact paid-render quote plus an optional free first-frame preview. Supports lyric video, beat-reactive visualiser, kinetic titles, photo-motion poster, promo cards, the 6 music/lyric/visualiser templates (lyric_video, audio_visualiser, living_cover, kinetic_type, club_tunnel, organic_landscape) across 7 genre looks (pop, hiphop_drill, rnb, house_edm, rock, country_acoustic, afrobeats), and all 24 popular motion styles (styleId). Uses owned audio and picture asset IDs; saved song timing supplies lyric cues and the saved scene can be edited. No AI video model or paid render is called. requestId identifies the saved document across retries. Each returned quote has its own identity; rendering requires explicit customer approval bound to that quote.
| Parameter | Type | Description |
|---|---|---|
| style | string | one of ["bars","waves","particles"] |
| title | string | |
| aspect * | string | one of ["16:9","9:16"] |
| family * | string | one of ["lyric_video","beat_visualiser","kinetic_text","photo_poster","promo_cards"] |
| lookId | string | one of ["pop","hiphop_drill","rnb","house_edm","rock","country_acoustic","afrobeats"] |
| lyrics | string | |
| styleId | string | one of ["3d-text-flight","album-teaser","audio-visualiser","bold-hook","cast-billing","chapter-cards","chat-story","clean-creator","colour-pop","data-and-map","data-map-charts","festival-lineup","genre-title… |
Returns the server price in credits, bound to the exact revision, output, source and runtime. A paid render requires one explicit customer approval of this exact price. Edits invalidate prior quotes. No debit or render.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| revisionId * | string |
{
"name": "studio_motion_quote",
"title": "Quote Motion render",
"description": "Returns the server price in credits, bound to the exact revision, output, source and runtime. A paid render requires one explicit customer approval of this exact price. Edits invalidate prior quotes. No debit or render.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"revisionId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"revisionId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"quoteToken",
"estimateId",
"revisionId",
"inputDigest",
"credits",
"expiresAt",
"output",
"durationFrames",
"fps"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"credits": {
"type": "number"
},
"currency": {
"enum": [
"GBP"
]
},
"expiresAt": {
"type": "string"
},
"estimateId": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"inputDigest": {
"type": "string"
},
"operationId": {
"type": "string"
},
"vatIncluded": {
"const": true
},
"approvalScope": {
"enum": [
"writing_preview_render"
]
},
"durationFrames": {
"type": "number"
},
"pricingVersion": {
"type": "string"
},
"customerDueMinor": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Quote Motion render",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Starts the exact paid server render after the customer explicitly approves its quoted price. Chat approval returns operationId, quoteToken, revisionId, inputDigest and quotedCredits unchanged from the quote. Existing Brix36 confirmationToken codes remain supported as a separate flow. The server enforces spending permission, account policy and exact quote bindings. Identical retries reconcile the original operation. Annotations do not attest to consent or guarantee a host confirmation screen.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| quoteToken * | string | |
| revisionId | string | |
| inputDigest | string | |
| operationId * | string | |
| quotedCredits | integer | |
| confirmationToken | string |
{
"name": "studio_motion_confirm",
"title": "Render approved Motion scene",
"description": "Starts the exact paid server render after the customer explicitly approves its quoted price. Chat approval returns operationId, quoteToken, revisionId, inputDigest and quotedCredits unchanged from the quote. Existing Brix36 confirmationToken codes remain supported as a separate flow. The server enforces spending permission, account policy and exact quote bindings. Identical retries reconcile the original operation. Annotations do not attest to consent or guarantee a host confirmation screen.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"quoteToken"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"quoteToken": {
"type": "string",
"maxLength": 4096,
"minLength": 1
},
"revisionId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1
},
"inputDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"operationId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 8
},
"quotedCredits": {
"type": "integer",
"maximum": 1000000,
"minimum": 0
},
"confirmationToken": {
"type": "string",
"maxLength": 4096,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"truncated": true,
"chars": 45364
},
"annotations": {
"title": "Render approved Motion scene",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Waits up to 40 seconds for the original Motion operation, then returns its finished video.url and downloadUrl or a nonterminal pending response with an exact nextCall. Each status read checks current access. No generation, approval or credit change.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| operationId * | string |
{
"name": "studio_motion_wait",
"title": "Wait for Motion video link",
"description": "Waits up to 40 seconds for the original Motion operation, then returns its finished video.url and downloadUrl or a nonterminal pending response with an exact nextCall. Each status read checks current access. No generation, approval or credit change.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"operationId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 8
}
},
"additionalProperties": false
},
"outputSchema": {
"truncated": true,
"chars": 45364
},
"annotations": {
"title": "Wait for Motion video link",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List available Motion Graphics templates (lyric_video, audio_visualiser, living_cover, kinetic_type, club_tunnel, organic_landscape), 7 genre looks (pop, hiphop_drill, rnb, house_edm, rock, country_acoustic, afrobeats), and all 24 popular motion styles with preview video URLs and input requirements. Read-only discovery.
| Parameter | Type | Description |
|---|---|---|
| aspect | string | one of ["16:9","9:16"] |
{
"name": "studio_motion_catalogue",
"title": "Browse Motion Graphics catalogue",
"description": "List available Motion Graphics templates (lyric_video, audio_visualiser, living_cover, kinetic_type, club_tunnel, organic_landscape), 7 genre looks (pop, hiphop_drill, rnb, house_edm, rock, country_acoustic, afrobeats), and all 24 popular motion styles with preview video URLs and input requirements. Read-only discovery.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16"
],
"type": "string"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"templates",
"filmStyles",
"available"
],
"properties": {
"styles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"previewUrl"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"lookId": {
"type": "string"
},
"category": {
"type": "string"
},
"previewUrl": {
"type": "string"
},
"templateId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"version": {
"type": "number"
},
"available": {
"type": "boolean"
},
"templates": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
}
},
"additionalProperties": true
}
},
"filmStyles": {
"type": "array",
"items": {
"type": "object",
"required": [],
"properties": {},
"additionalProperties": true
}
},
"catalogueVersion": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Browse Motion Graphics catalogue",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read the connected customer account and its current catalogue memberships. Returns user details and up to 50 catalogues with roles. The connection determines identity; no account or workspace argument is accepted. Free.
No parameters.
{
"name": "studio_account_read",
"title": "Read Brix36 account",
"description": "Read the connected customer account and its current catalogue memberships. Returns user details and up to 50 catalogues with roles. The connection determines identity; no account or workspace argument is accepted. Free.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"user",
"catalogues",
"cataloguesTruncated"
],
"properties": {
"user": {
"type": "object",
"required": [
"id",
"displayName",
"email",
"emailVerified"
],
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string"
},
"displayName": {
"type": "string"
},
"emailVerified": {
"type": "boolean"
}
},
"additionalProperties": true
},
"catalogues": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"role"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
}
},
"additionalProperties": true
}
},
"cataloguesTruncated": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read Brix36 account",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read the connected customer wallet. Returns productionBalance, sandboxBalance, spendableBalance, status, reviewReason and sandboxSpendingEnabled from the app ledger. A review_required wallet cannot spend. Free; purchases remain in the Brix36 app.
No parameters.
{
"name": "studio_credits_balance_read",
"title": "Read Brix36 credit balance",
"description": "Read the connected customer wallet. Returns productionBalance, sandboxBalance, spendableBalance, status, reviewReason and sandboxSpendingEnabled from the app ledger. A review_required wallet cannot spend. Free; purchases remain in the Brix36 app.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"productionBalance",
"sandboxBalance",
"spendableBalance",
"status",
"reviewReason",
"sandboxSpendingEnabled"
],
"properties": {
"status": {
"enum": [
"active",
"review_required"
]
},
"reviewReason": {
"type": [
"string",
"null"
]
},
"sandboxBalance": {
"type": "number"
},
"spendableBalance": {
"type": "number"
},
"productionBalance": {
"type": "number"
},
"sandboxSpendingEnabled": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read Brix36 credit balance",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Lists the connected customer's purchases, spends, refunds and adjustments newest first. Returns signed amounts, source, time, accessible projectTitle and nextCursor. Pagination preserves the cursor value. No wallet changes.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum items to return, 1–50. Default 20. |
| cursor | string | Opaque previous-page nextCursor; absent for the first page. |
{
"name": "studio_credit_usage_list",
"title": "List Brix36 credit activity",
"description": "Lists the connected customer's purchases, spends, refunds and adjustments newest first. Returns signed amounts, source, time, accessible projectTitle and nextCursor. Pagination preserves the cursor value. No wallet changes.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum items to return, 1–50. Default 20."
},
"cursor": {
"type": "string",
"maxLength": 512,
"minLength": 1,
"description": "Opaque previous-page nextCursor; absent for the first page."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"entries",
"nextCursor"
],
"properties": {
"entries": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"createdAt",
"category",
"source",
"amount",
"projectTitle",
"projectKind",
"fullVideo",
"sectionName",
"sectionCount"
],
"properties": {
"id": {
"type": "string"
},
"amount": {
"type": "number"
},
"source": {
"enum": [
"store",
"video",
"still",
"correction",
"manual",
"other",
"photo",
"storyboard",
"song",
"referral"
]
},
"category": {
"enum": [
"purchase",
"spend",
"refund",
"adjustment"
]
},
"createdAt": {
"type": "string"
},
"fullVideo": {
"type": "boolean"
},
"projectKind": {
"enum": [
"music",
"film",
null
]
},
"sectionName": {
"type": [
"string",
"null"
]
},
"projectTitle": {
"type": [
"string",
"null"
]
},
"sectionCount": {
"type": "number"
}
},
"additionalProperties": true
}
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "List Brix36 credit activity",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns verified native-app navigation and privacy/support links. No IDs selects account controls; accessible artistId/projectId adds the corresponding artist or project screens and appOnlyActions with reasons. Each ID is checked against viewer access. App-only workflows retain existing consent and spend controls. No purchase, paid work or account deletion.
| Parameter | Type | Description |
|---|---|---|
| artistId | string | Optional Artist DNA ID whose app controls to open; current viewer access is required. |
| projectId | string | Optional project whose app screens to open; current viewer access is required. |
{
"name": "studio_account_links_read",
"title": "Open Brix36 account or project controls",
"description": "Returns verified native-app navigation and privacy/support links. No IDs selects account controls; accessible artistId/projectId adds the corresponding artist or project screens and appOnlyActions with reasons. Each ID is checked against viewer access. App-only workflows retain existing consent and spend controls. No purchase, paid work or account deletion.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Optional Artist DNA ID whose app controls to open; current viewer access is required."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Optional project whose app screens to open; current viewer access is required."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"accountUrl",
"privacyUrl",
"deletionInstructionsUrl",
"termsUrl",
"supportUrl",
"creditManagement",
"accountDeletion",
"appOnlyActions"
],
"properties": {
"termsUrl": {
"type": "string"
},
"accountUrl": {
"type": "string"
},
"privacyUrl": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"artistLinks": {
"type": "object",
"required": [
"artistId",
"dnaUrl",
"likenessUrl"
],
"properties": {
"dnaUrl": {
"type": "string"
},
"artistId": {
"type": "string"
},
"likenessUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"projectLinks": {
"type": "object",
"required": [
"projectId",
"storyboardUrl",
"filmUrl",
"productionUrl",
"referencesUrl",
"songUrl",
"makeSongUrl",
"videosUrl",
"reviewUrl"
],
"properties": {
"filmUrl": {
"type": "string"
},
"songUrl": {
"type": "string"
},
"projectId": {
"type": "string"
},
"reviewUrl": {
"type": "string"
},
"videosUrl": {
"type": "string"
},
"makeSongUrl": {
"type": "string"
},
"productionUrl": {
"type": "string"
},
"referencesUrl": {
"type": "string"
},
"storyboardUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"appOnlyActions": {
"type": "array",
"items": {
"type": "object",
"required": [
"action",
"url",
"reason"
],
"properties": {
"url": {
"type": "string"
},
"action": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"additionalProperties": true
}
},
"accountDeletion": {
"type": "string"
},
"creditManagement": {
"type": "string"
},
"deletionInstructionsUrl": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Open Brix36 account or project controls",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Lists the same free fictional character portraits offered by the Brix36 app, with each current star ID, name, description and versioned preview image. Read-only; creates no artist, image, generation or charge.
No parameters.
{
"name": "studio_ready_made_stars_list",
"title": "Browse Brix36 ready-made characters",
"description": "Lists the same free fictional character portraits offered by the Brix36 app, with each current star ID, name, description and versioned preview image. Read-only; creates no artist, image, generation or charge.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"stars"
],
"properties": {
"stars": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"description",
"imageUrl"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Browse Brix36 ready-made characters",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Saves one Brix36 ready-made fictional portrait on an existing artist using the same service as the app. Requires artist permission and a current starId from the ready-made star list. Returns the saved reference pack and whether it was newly created; choosing the same star retains the existing pack. No image generation or credit charge. Current generation readiness is read separately from the artist list.
| Parameter | Type | Description |
|---|---|---|
| starId * | string | Current star ID returned by studio_ready_made_stars_list; not an image URL. |
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
{
"name": "studio_artist_ready_made_choose",
"title": "Choose a free ready-made character",
"description": "Saves one Brix36 ready-made fictional portrait on an existing artist using the same service as the app. Requires artist permission and a current starId from the ready-made star list. Returns the saved reference pack and whether it was newly created; choosing the same star retains the existing pack. No image generation or credit charge. Current generation readiness is read separately from the artist list.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"starId"
],
"properties": {
"starId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Current star ID returned by studio_ready_made_stars_list; not an image URL."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"artistId",
"starId",
"created",
"pack",
"note"
],
"properties": {
"note": {
"type": "string"
},
"pack": {
"type": "object",
"required": [
"id",
"version",
"status",
"references",
"blockers",
"missingAngles",
"weakPhotos",
"authorizationStatus",
"publishable"
],
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"draft",
"published",
"superseded",
"needs_attention"
]
},
"version": {
"type": "number"
},
"blockers": {
"type": "array",
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"angle",
"contentUrl",
"screeningVerdict",
"createdAt",
"origin",
"confirmedAt"
],
"properties": {
"id": {
"type": "string"
},
"angle": {
"type": "string"
},
"origin": {
"enum": [
"photograph",
"generated"
]
},
"createdAt": {
"type": "string"
},
"contentUrl": {
"type": "string"
},
"confirmedAt": {
"type": [
"string",
"null"
]
},
"screeningVerdict": {
"type": "string"
}
},
"additionalProperties": true
}
},
"weakPhotos": {
"type": "boolean"
},
"publishable": {
"type": "boolean"
},
"missingAngles": {
"type": "array",
"items": {
"type": "string"
}
},
"authorizationStatus": {
"type": "string"
}
},
"additionalProperties": true
},
"starId": {
"type": "string"
},
"created": {
"type": "boolean"
},
"artistId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Choose a free ready-made character",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Creates an artist through the app service and returns profile and revision. Name is required; photos use dedicated upload/reference tools. catalogueArtistId optionally selects a manageable catalogue through an existing artist. Creation has no replay receipt; the artist list exposes persisted results after an uncertain response. No generation or charge.
| Parameter | Type | Description |
|---|---|---|
| bio | string | Artist biography; an empty string clears it. |
| name * | string | New artist name. |
| genres | array | Artist genres. An empty array clears the list. |
| location | string | Artist location; an empty string clears it. |
| influences | array | Artist influences. An empty array clears the list. |
| identityKind | string | Factual identity of the new artist. Real person by default. Adding a real face photo follows the app real-person rules. |
| visualKeywords | array | Artist visual keywords. An empty array clears the list. |
| primaryLanguage | string | Artist primary language; an empty string clears it. |
| recurringThemes | array | Artist recurring themes. An empty array clears the list. |
Returns one artist's profile, current revision and Artist DNA summary, including genres, visual notes and identity readiness. The revision binds profile and cover edits. Read-only.
| Parameter | Type | Description |
|---|---|---|
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
{
"name": "studio_artist_read",
"title": "Read Brix36 artist",
"description": "Returns one artist's profile, current revision and Artist DNA summary, including genres, visual notes and identity readiness. The revision binds profile and cover edits. Read-only.",
"inputSchema": {
"type": "object",
"required": [
"artistId"
],
"properties": {
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"workspaceId",
"name",
"genres",
"identityPackStatus",
"identityReferenceCount",
"activeProjectCount",
"updatedAt",
"revision"
],
"properties": {
"id": {
"type": "string"
},
"bio": {
"type": "string"
},
"name": {
"type": "string"
},
"avatar": {
"type": "object",
"required": [
"kind",
"value",
"alt"
],
"properties": {
"alt": {
"type": "string"
},
"kind": {
"enum": [
"gradient",
"upload"
]
},
"value": {
"type": "string"
}
},
"additionalProperties": true
},
"genres": {
"type": "array",
"items": {
"type": "string"
}
},
"voiceId": {
"type": [
"string",
"null"
]
},
"location": {
"type": "string"
},
"revision": {
"type": "number"
},
"updatedAt": {
"type": "string"
},
"influences": {
"type": "array",
"items": {
"type": "string"
}
},
"faceCovered": {
"type": "boolean"
},
"workspaceId": {
"type": "string"
},
"activeTakeId": {
"type": [
"string",
"null"
]
},
"identityKind": {
"enum": [
"real_person",
"fictional_character"
]
},
"packCoverage": {
"enum": [
3,
5,
null
]
},
"characterSpec": {
"anyOf": [
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"latestProject": {
"type": "object",
"required": [
"id",
"title",
"status",
"progress",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"enum": [
"brief",
"storyboard",
"generating",
"review",
"complete"
]
},
"progress": {
"type": "number"
},
"songTitle": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"releaseTitle": {
"type": "string"
}
},
"additionalProperties": true
},
"visualKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"primaryLanguage": {
"type": "string"
},
"recurringThemes": {
"type": "array",
"items": {
"type": "string"
}
},
"preferredPalette": {
"type": "array",
"items": {
"type": "string"
}
},
"profileCompletion": {
"type": "number"
},
"activeProjectCount": {
"type": "number"
},
"identityPackStatus": {
"enum": [
"empty",
"draft",
"ready",
"needs_attention"
]
},
"identityPackVersion": {
"type": "number"
},
"identityReferenceCount": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read Brix36 artist",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Updates supplied artist profile fields with expectedRevision from the current profile. Returns the updated profile and revision; conflicting edits are refused. Photos, voices, identity kind and Film casting have separate operations.
| Parameter | Type | Description |
|---|---|---|
| patch * | object | |
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
| expectedRevision * | integer | Current revision from the latest read. Stale revisions are refused. |
{
"name": "studio_artist_update",
"title": "Update Brix36 artist",
"description": "Updates supplied artist profile fields with expectedRevision from the current profile. Returns the updated profile and revision; conflicting edits are refused. Photos, voices, identity kind and Film casting have separate operations.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"expectedRevision",
"patch"
],
"properties": {
"patch": {
"type": "object",
"required": [],
"properties": {
"bio": {
"type": "string",
"maxLength": 4000,
"description": "Artist biography; an empty string clears it."
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Artist display name."
},
"genres": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "One value."
},
"maxItems": 24,
"description": "Artist genres. An empty array clears the list."
},
"location": {
"type": "string",
"maxLength": 120,
"description": "Artist location; an empty string clears it."
},
"influences": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "One value."
},
"maxItems": 24,
"description": "Artist influences. An empty array clears the list."
},
"faceCovered": {
"type": "boolean",
"description": "Whether the artist intentionally covers their face. This does not declare a fictional identity."
},
"activeTakeId": {
"type": [
"string",
"null"
],
"maxLength": 200,
"minLength": 1,
"description": "Chosen Character Studio active take ID, or null to clear."
},
"packCoverage": {
"enum": [
3,
5,
null
],
"type": [
"null",
"integer"
],
"description": "Character Studio reference pack coverage (3 or 5 angles), or null to clear."
},
"characterSpec": {
"type": [
"object",
"null"
],
"description": "Character Studio 6-card JSON specification (up to 16 KB), or null to clear.",
"additionalProperties": true
},
"visualKeywords": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "One value."
},
"maxItems": 24,
"description": "Artist visual keywords. An empty array clears the list."
},
"primaryLanguage": {
"type": "string",
"maxLength": 60,
"description": "Artist primary language; an empty string clears it."
},
"recurringThemes": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "One value."
},
"maxItems": 24,
"description": "Artist recurring themes. An empty array clears the list."
},
"preferredPalette": {
"type": "array",
"items": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"description": "One value."
},
"maxItems": 12,
"description": "Artist palette tokens. An empty array clears the list."
}
},
"minProperties": 1,
"additionalProperties": false
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "Current revision from the latest read. Stale revisions are refused."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"workspaceId",
"name",
"genres",
"identityPackStatus",
"identityReferenceCount",
"activeProjectCount",
"updatedAt",
"revision"
],
"properties": {
"id": {
"type": "string"
},
"bio": {
"type": "string"
},
"name": {
"type": "string"
},
"avatar": {
"type": "object",
"required": [
"kind",
"value",
"alt"
],
"properties": {
"alt": {
"type": "string"
},
"kind": {
"enum": [
"gradient",
"upload"
]
},
"value": {
"type": "string"
}
},
"additionalProperties": true
},
"genres": {
"type": "array",
"items": {
"type": "string"
}
},
"voiceId": {
"type": [
"string",
"null"
]
},
"location": {
"type": "string"
},
"revision": {
"type": "number"
},
"updatedAt": {
"type": "string"
},
"influences": {
"type": "array",
"items": {
"type": "string"
}
},
"faceCovered": {
"type": "boolean"
},
"workspaceId": {
"type": "string"
},
"activeTakeId": {
"type": [
"string",
"null"
]
},
"identityKind": {
"enum": [
"real_person",
"fictional_character"
]
},
"packCoverage": {
"enum": [
3,
5,
null
]
},
"characterSpec": {
"anyOf": [
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"latestProject": {
"type": "object",
"required": [
"id",
"title",
"status",
"progress",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"enum": [
"brief",
"storyboard",
"generating",
"review",
"complete"
]
},
"progress": {
"type": "number"
},
"songTitle": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"releaseTitle": {
"type": "string"
}
},
"additionalProperties": true
},
"visualKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"primaryLanguage": {
"type": "string"
},
"recurringThemes": {
"type": "array",
"items": {
"type": "string"
}
},
"preferredPalette": {
"type": "array",
"items": {
"type": "string"
}
},
"profileCompletion": {
"type": "number"
},
"activeProjectCount": {
"type": "number"
},
"identityPackStatus": {
"enum": [
"empty",
"draft",
"ready",
"needs_attention"
]
},
"identityPackVersion": {
"type": "number"
},
"identityReferenceCount": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Update Brix36 artist",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Permanently erases an artist and their projects, storyboards, references and identity photos. Requires catalogue-owner access, the customer's deletion request and their exact current artist name as confirmation. In-flight work or payments prevent deletion. Returns artist=deleted and queued purge counts; external erasure is asynchronous.
| Parameter | Type | Description |
|---|---|---|
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
| confirmation * | string | Artist exact current name, supplied by the customer after they request permanent deletion. |
{
"name": "studio_artist_delete",
"title": "Delete Brix36 artist",
"description": "Permanently erases an artist and their projects, storyboards, references and identity photos. Requires catalogue-owner access, the customer's deletion request and their exact current artist name as confirmation. In-flight work or payments prevent deletion. Returns artist=deleted and queued purge counts; external erasure is asynchronous.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"confirmation"
],
"properties": {
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
},
"confirmation": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Artist exact current name, supplied by the customer after they request permanent deletion."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"artist",
"purgesRecorded",
"purgesCompleted"
],
"properties": {
"artist": {
"enum": [
"deleted"
]
},
"purgesRecorded": {
"type": "number"
},
"purgesCompleted": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Delete Brix36 artist",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Returns an existing artist's Film castId, identity readiness and Film creation link. castId equals artistId. No duplicate actor or artist-flag change is created.
| Parameter | Type | Description |
|---|---|---|
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
{
"name": "studio_artist_actor_read",
"title": "Use artist as Film actor",
"description": "Returns an existing artist's Film castId, identity readiness and Film creation link. castId equals artistId. No duplicate actor or artist-flag change is created.",
"inputSchema": {
"type": "object",
"required": [
"artistId"
],
"properties": {
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"artistId",
"castId",
"name",
"identityPackStatus",
"identityReferenceCount",
"filmUrl",
"usage"
],
"properties": {
"name": {
"type": "string"
},
"usage": {
"type": "string"
},
"castId": {
"type": "string"
},
"filmUrl": {
"type": "string"
},
"artistId": {
"type": "string"
},
"identityPackStatus": {
"enum": [
"empty",
"draft",
"ready",
"needs_attention"
]
},
"identityReferenceCount": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Use artist as Film actor",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns identity summary, published photo pack, pending screening, approved creative facts and up to 20 recent social-scan statuses. Pending or held photos retain their status. The app link identifies consent and scan controls. No scan, language model or image generation starts.
| Parameter | Type | Description |
|---|---|---|
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
{
"name": "studio_artist_dna_read",
"title": "Read Artist DNA and photo status",
"description": "Returns identity summary, published photo pack, pending screening, approved creative facts and up to 20 recent social-scan statuses. Pending or held photos retain their status. The app link identifies consent and scan controls. No scan, language model or image generation starts.",
"inputSchema": {
"type": "object",
"required": [
"artistId"
],
"properties": {
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"artist",
"publishedPack",
"pendingPhotos",
"pendingPhotosTruncated",
"creativeFacts",
"socialScans",
"socialScansTruncated",
"appUrl",
"languageWork"
],
"properties": {
"appUrl": {
"type": "string"
},
"artist": {
"type": "object",
"required": [
"id",
"workspaceId",
"name",
"genres",
"identityPackStatus",
"identityReferenceCount",
"activeProjectCount",
"updatedAt",
"revision"
],
"properties": {
"id": {
"type": "string"
},
"bio": {
"type": "string"
},
"name": {
"type": "string"
},
"avatar": {
"type": "object",
"required": [
"kind",
"value",
"alt"
],
"properties": {
"alt": {
"type": "string"
},
"kind": {
"enum": [
"gradient",
"upload"
]
},
"value": {
"type": "string"
}
},
"additionalProperties": true
},
"genres": {
"type": "array",
"items": {
"type": "string"
}
},
"voiceId": {
"type": [
"string",
"null"
]
},
"location": {
"type": "string"
},
"revision": {
"type": "number"
},
"updatedAt": {
"type": "string"
},
"influences": {
"type": "array",
"items": {
"type": "string"
}
},
"faceCovered": {
"type": "boolean"
},
"workspaceId": {
"type": "string"
},
"activeTakeId": {
"type": [
"string",
"null"
]
},
"identityKind": {
"enum": [
"real_person",
"fictional_character"
]
},
"packCoverage": {
"enum": [
3,
5,
null
]
},
"characterSpec": {
"anyOf": [
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"latestProject": {
"type": "object",
"required": [
"id",
"title",
"status",
"progress",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"enum": [
"brief",
"storyboard",
"generating",
"review",
"complete"
]
},
"progress": {
"type": "number"
},
"songTitle": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"releaseTitle": {
"type": "string"
}
},
"additionalProperties": true
},
"visualKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"primaryLanguage": {
"type": "string"
},
"recurringThemes": {
"type": "array",
"items": {
"type": "string"
}
},
"preferredPalette": {
"type": "array",
"items": {
"type": "string"
}
},
"profileCompletion": {
"type": "number"
},
"activeProjectCount": {
"type": "number"
},
"identityPackStatus": {
"enum": [
"empty",
"draft",
"ready",
"needs_attention"
]
},
"identityPackVersion": {
"type": "number"
},
"identityReferenceCount": {
"type": "number"
}
},
"additionalProperties": true
},
"socialScans": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"scanId",
"platform",
"state",
"accessState",
"counts",
"startedAt",
"updatedAt",
"completedAt",
"canRetry",
"canScanAgain"
],
"properties": {
"state": {
"enum": [
"authorizing",
"connected",
"importing",
"history_stabilising",
"analysing_dna",
"ready_to_cleanup",
"disconnecting",
"complete_disconnected",
"partial",
"retrying",
"cleanup_failed"
]
},
"counts": {
"type": "object",
"required": [
"walked",
"captured",
"analysed",
"metadataOnly",
"unavailable",
"rejected",
"failed"
],
"properties": {
"failed": {
"type": "number"
},
"walked": {
"type": "number"
},
"analysed": {
"type": "number"
},
"captured": {
"type": "number"
},
"rejected": {
"type": "number"
},
"unavailable": {
"type": "number"
},
"metadataOnly": {
"type": "number"
}
},
"additionalProperties": true
},
"scanId": {
"type": "string"
},
"canRetry": {
"type": "boolean"
},
"platform": {
"type": "string"
},
"startedAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"accessState": {
"enum": [
"none",
"temporary",
"removing",
"removed",
"removal_failed"
]
},
"completedAt": {
"type": [
"string",
"null"
]
},
"canScanAgain": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
]
},
"languageWork": {
"type": "string"
},
"creativeFacts": {
"type": "object",
"required": [
"versionId",
"facts"
],
"properties": {
"facts": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"category",
"statement",
"priority",
"origin"
],
"properties": {
"id": {
"type": "string"
},
"origin": {
"enum": [
"machine",
"user"
]
},
"category": {
"type": "string"
},
"priority": {
"type": "number"
},
"statement": {
"type": "string"
}
},
"additionalProperties": true
}
},
"versionId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"pendingPhotos": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"pack_id",
"angle",
"origin",
"screening_verdict",
"confirmed_at"
],
"properties": {
"id": {
"type": "string"
},
"angle": {
"type": "string"
},
"origin": {
"type": "string"
},
"pack_id": {
"type": "string"
},
"confirmed_at": {
"type": [
"string",
"null"
]
},
"screening_verdict": {
"type": "string"
}
},
"additionalProperties": true
}
},
"publishedPack": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"version",
"status",
"references",
"blockers",
"missingAngles",
"weakPhotos",
"authorizationStatus",
"publishable"
],
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"draft",
"published",
"superseded",
"needs_attention"
]
},
"version": {
"type": "number"
},
"blockers": {
"type": "array",
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"angle",
"contentUrl",
"screeningVerdict",
"createdAt",
"origin",
"confirmedAt"
],
"properties": {
"id": {
"type": "string"
},
"angle": {
"type": "string"
},
"origin": {
"enum": [
"photograph",
"generated"
]
},
"createdAt": {
"type": "string"
},
"contentUrl": {
"type": "string"
},
"confirmedAt": {
"type": [
"string",
"null"
]
},
"screeningVerdict": {
"type": "string"
}
},
"additionalProperties": true
}
},
"weakPhotos": {
"type": "boolean"
},
"publishable": {
"type": "boolean"
},
"missingAngles": {
"type": "array",
"items": {
"type": "string"
}
},
"authorizationStatus": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"socialScansTruncated": {
"type": "boolean"
},
"pendingPhotosTruncated": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read Artist DNA and photo status",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Saves customer-authored or approved creative facts as a new published Artist DNA version, preserving facts pinned by older projects. baseVersionId identifies the current version, or null when absent. Returns versionId and facts. Facts apply at once and need no pin. Requires manager permission; no language model or credit charge.
| Parameter | Type | Description |
|---|---|---|
| facts * | array | Full replacement set; an empty array clears the artist creative facts. |
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
| baseVersionId * | ["string","null"] | Current versionId from the last Artist DNA read, or explicit null when no version exists. |
{
"name": "studio_artist_dna_write",
"title": "Save artist creative facts",
"description": "Saves customer-authored or approved creative facts as a new published Artist DNA version, preserving facts pinned by older projects. baseVersionId identifies the current version, or null when absent. Returns versionId and facts. Facts apply at once and need no pin. Requires manager permission; no language model or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"baseVersionId",
"facts"
],
"properties": {
"facts": {
"type": "array",
"items": {
"type": "object",
"required": [
"category",
"statement"
],
"properties": {
"id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Existing fact ID, if preserving a fact read from the app."
},
"category": {
"type": "string",
"description": "Existing app Artist DNA fact category. One of: \"visual_language\", \"palette\", \"wardrobe\", \"performance\", \"cinematography\", \"narrative\", \"avoid\"."
},
"priority": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "Importance of this fact; defaults to the app value 100."
},
"statement": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "One concrete creative fact approved by the customer."
}
},
"additionalProperties": false
},
"maxItems": 200,
"description": "Full replacement set; an empty array clears the artist creative facts."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
},
"baseVersionId": {
"type": [
"string",
"null"
],
"maxLength": 64,
"minLength": 1,
"description": "Current versionId from the last Artist DNA read, or explicit null when no version exists."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"versionId",
"facts"
],
"properties": {
"facts": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"category",
"statement",
"priority",
"origin"
],
"properties": {
"id": {
"type": "string"
},
"origin": {
"enum": [
"machine",
"user"
]
},
"category": {
"type": "string"
},
"priority": {
"type": "number"
},
"statement": {
"type": "string"
}
},
"additionalProperties": true
}
},
"versionId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Save artist creative facts",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Adds a customer photograph to Artist DNA through screened identity-reference services. Inline input accepts canonical base64, MIME type and angle up to 512 KiB. Larger files have dedicated upload/app paths. Validates and deduplicates bytes under existing face-source/publication rules. Returns pack and created flag. No image generation.
| Parameter | Type | Description |
|---|---|---|
| angle * | string | Camera angle shown in this existing photo. |
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
| mimeType * | string | Actual photo MIME type; the app also checks bytes. |
| bytesBase64 * | string | Canonical base64 file bytes without a data URL prefix, up to 512 KiB decoded. Larger files have an app upload-link path. |
{
"name": "studio_artist_reference_add",
"title": "Add existing artist photo",
"description": "Adds a customer photograph to Artist DNA through screened identity-reference services. Inline input accepts canonical base64, MIME type and angle up to 512 KiB. Larger files have dedicated upload/app paths. Validates and deduplicates bytes under existing face-source/publication rules. Returns pack and created flag. No image generation.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"angle",
"mimeType",
"bytesBase64"
],
"properties": {
"angle": {
"enum": [
"front",
"three_quarter_left",
"three_quarter_right",
"smiling",
"left",
"right",
"full_body",
"detail"
],
"type": "string",
"description": "Camera angle shown in this existing photo."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
},
"mimeType": {
"enum": [
"image/png",
"image/jpeg",
"image/webp"
],
"type": "string",
"description": "Actual photo MIME type; the app also checks bytes."
},
"bytesBase64": {
"type": "string",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"maxLength": 699052,
"minLength": 4,
"description": "Canonical base64 file bytes without a data URL prefix, up to 512 KiB decoded. Larger files have an app upload-link path."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"pack",
"created",
"appUrl"
],
"properties": {
"pack": {
"type": "object",
"required": [
"id",
"version",
"status",
"references",
"blockers",
"missingAngles",
"weakPhotos",
"authorizationStatus",
"publishable"
],
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"draft",
"published",
"superseded",
"needs_attention"
]
},
"version": {
"type": "number"
},
"blockers": {
"type": "array",
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"angle",
"contentUrl",
"screeningVerdict",
"createdAt",
"origin",
"confirmedAt"
],
"properties": {
"id": {
"type": "string"
},
"angle": {
"type": "string"
},
"origin": {
"enum": [
"photograph",
"generated"
]
},
"createdAt": {
"type": "string"
},
"contentUrl": {
"type": "string"
},
"confirmedAt": {
"type": [
"string",
"null"
]
},
"screeningVerdict": {
"type": "string"
}
},
"additionalProperties": true
}
},
"weakPhotos": {
"type": "boolean"
},
"publishable": {
"type": "boolean"
},
"missingAngles": {
"type": "array",
"items": {
"type": "string"
}
},
"authorizationStatus": {
"type": "string"
}
},
"additionalProperties": true
},
"appUrl": {
"type": "string"
},
"created": {
"type": "boolean"
},
"photoTips": {
"type": "array",
"items": {
"type": "string"
}
},
"smallPhotoNote": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Add existing artist photo",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Remove one identity reference photo using the app service. Requires artist-level permission and the customer choosing this specific photo. Returns the updated identity pack. This can affect future likeness generation; older pinned projects keep their existing rules.
| Parameter | Type | Description |
|---|---|---|
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
| referenceId * | string | Identity reference ID from studio_artist_dna_read. |
{
"name": "studio_artist_reference_delete",
"title": "Remove artist photo",
"description": "Remove one identity reference photo using the app service. Requires artist-level permission and the customer choosing this specific photo. Returns the updated identity pack. This can affect future likeness generation; older pinned projects keep their existing rules.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"referenceId"
],
"properties": {
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
},
"referenceId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Identity reference ID from studio_artist_dna_read."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"version",
"status",
"references",
"blockers",
"missingAngles",
"weakPhotos",
"authorizationStatus",
"publishable"
],
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"draft",
"published",
"superseded",
"needs_attention"
]
},
"version": {
"type": "number"
},
"blockers": {
"type": "array",
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"angle",
"contentUrl",
"screeningVerdict",
"createdAt",
"origin",
"confirmedAt"
],
"properties": {
"id": {
"type": "string"
},
"angle": {
"type": "string"
},
"origin": {
"enum": [
"photograph",
"generated"
]
},
"createdAt": {
"type": "string"
},
"contentUrl": {
"type": "string"
},
"confirmedAt": {
"type": [
"string",
"null"
]
},
"screeningVerdict": {
"type": "string"
}
},
"additionalProperties": true
}
},
"weakPhotos": {
"type": "boolean"
},
"publishable": {
"type": "boolean"
},
"missingAngles": {
"type": "array",
"items": {
"type": "string"
}
},
"authorizationStatus": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Remove artist photo",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Sets an existing passed DNA photograph as the artist cover; referenceId:null restores automatic cover selection. Requires artist permission and expectedRevision from the current profile. Returns profile and revision; creates no image.
| Parameter | Type | Description |
|---|---|---|
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
| referenceId * | ["string","null"] | Passed current DNA photo ID, or null for automatic cover. |
| expectedRevision * | integer | Current revision from the latest read. Stale revisions are refused. |
{
"name": "studio_artist_cover_set",
"title": "Choose artist cover photo",
"description": "Sets an existing passed DNA photograph as the artist cover; referenceId:null restores automatic cover selection. Requires artist permission and expectedRevision from the current profile. Returns profile and revision; creates no image.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"expectedRevision",
"referenceId"
],
"properties": {
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
},
"referenceId": {
"type": [
"string",
"null"
],
"maxLength": 64,
"minLength": 1,
"description": "Passed current DNA photo ID, or null for automatic cover."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "Current revision from the latest read. Stale revisions are refused."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"workspaceId",
"name",
"genres",
"identityPackStatus",
"identityReferenceCount",
"activeProjectCount",
"updatedAt",
"revision"
],
"properties": {
"id": {
"type": "string"
},
"bio": {
"type": "string"
},
"name": {
"type": "string"
},
"avatar": {
"type": "object",
"required": [
"kind",
"value",
"alt"
],
"properties": {
"alt": {
"type": "string"
},
"kind": {
"enum": [
"gradient",
"upload"
]
},
"value": {
"type": "string"
}
},
"additionalProperties": true
},
"genres": {
"type": "array",
"items": {
"type": "string"
}
},
"voiceId": {
"type": [
"string",
"null"
]
},
"location": {
"type": "string"
},
"revision": {
"type": "number"
},
"updatedAt": {
"type": "string"
},
"influences": {
"type": "array",
"items": {
"type": "string"
}
},
"faceCovered": {
"type": "boolean"
},
"workspaceId": {
"type": "string"
},
"activeTakeId": {
"type": [
"string",
"null"
]
},
"identityKind": {
"enum": [
"real_person",
"fictional_character"
]
},
"packCoverage": {
"enum": [
3,
5,
null
]
},
"characterSpec": {
"anyOf": [
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"latestProject": {
"type": "object",
"required": [
"id",
"title",
"status",
"progress",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"enum": [
"brief",
"storyboard",
"generating",
"review",
"complete"
]
},
"progress": {
"type": "number"
},
"songTitle": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"releaseTitle": {
"type": "string"
}
},
"additionalProperties": true
},
"visualKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"primaryLanguage": {
"type": "string"
},
"recurringThemes": {
"type": "array",
"items": {
"type": "string"
}
},
"preferredPalette": {
"type": "array",
"items": {
"type": "string"
}
},
"profileCompletion": {
"type": "number"
},
"activeProjectCount": {
"type": "number"
},
"identityPackStatus": {
"enum": [
"empty",
"draft",
"ready",
"needs_attention"
]
},
"identityPackVersion": {
"type": "number"
},
"identityReferenceCount": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Choose artist cover photo",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Lists the customer unified Hub Library across Web QuickCreate/DirectCreate, Mobile and ChatGPT (videos, images, audio and edits), with signed preview URLs, webUrl links to open in the Brix36 Web Studio or NLE Editor, and nextCursor. Free and read-only. A finished item also carries a watch link that opens it full size to watch, share or download, a remake link that opens where it is made again (the storyboard for a video), and the finished actions watch, share and remake. The preview is the video or picture itself, so a finished item is shown from its preview first, and the remake link is for a customer who wants it made again or changed. A to-finish item carries none of these finished links.
| Parameter | Type | Description |
|---|---|---|
| kind | string | Optional media kind filter. |
| limit | integer | Maximum items to return, 1–50. Default 20. |
| cursor | string | Opaque previous-page nextCursor; absent for the first page. |
| status | string | Optional creation status filter. |
| artistId | string | Optional artist ID filter. |
| projectId | string | Optional project ID filter. |
| libraryBucket | string | Optional tab bucket filter: 'finished' or 'to_finish'. |
Attaches existing customer audio from an accessible source project to an empty target through the durable upload/analysis path. sourceAttachmentId identifies the saved song attachment. Returns attachment/asset/job IDs or already_attached for identical audio. Repeats return the existing result; different current audio refuses replacement. No arbitrary URL fetch, generated audio or language-model call.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
| sourceProjectId * | string | Readable source project already holding the song. |
| sourceAttachmentId * | string | Source audio attachment ID from studio_song_status. |
{
"name": "studio_song_reuse",
"title": "Reuse an uploaded song",
"description": "Attaches existing customer audio from an accessible source project to an empty target through the durable upload/analysis path. sourceAttachmentId identifies the saved song attachment. Returns attachment/asset/job IDs or already_attached for identical audio. Repeats return the existing result; different current audio refuses replacement. No arbitrary URL fetch, generated audio or language-model call.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"sourceProjectId",
"sourceAttachmentId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
},
"sourceProjectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Readable source project already holding the song."
},
"sourceAttachmentId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Source audio attachment ID from studio_song_status."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"outcome",
"attachmentId",
"assetId"
],
"properties": {
"assetId": {
"type": "string"
},
"outcome": {
"enum": [
"already_attached"
]
},
"projectId": {
"type": "string"
},
"attachmentId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"projectId",
"outcome",
"state",
"replayed",
"attachmentId",
"assetId",
"analysisJobId"
],
"properties": {
"state": {
"enum": [
"accepted"
]
},
"assetId": {
"type": "string"
},
"outcome": {
"enum": [
"accepted"
]
},
"replayed": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"attachmentId": {
"type": "string"
},
"analysisJobId": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Reuse an uploaded song",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Browse customer image/video references across their accessible projects, or filter one project. Returns up to 50 references with projectId, attachmentId, signed contentUrl, scope, analysis status and a small preview of existing facts, plus nextCursor. Shot references affect only bound shots. Nothing is analysed by this tool.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum items to return, 1–50. Default 20. |
| cursor | string | Opaque previous-page nextCursor; absent for the first page. |
| projectId | string | Project ID returned by studio_projects_list or studio_video_start. |
{
"name": "studio_references_list",
"title": "List video and Film references",
"description": "Browse customer image/video references across their accessible projects, or filter one project. Returns up to 50 references with projectId, attachmentId, signed contentUrl, scope, analysis status and a small preview of existing facts, plus nextCursor. Shot references affect only bound shots. Nothing is analysed by this tool.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum items to return, 1–50. Default 20."
},
"cursor": {
"type": "string",
"maxLength": 512,
"minLength": 1,
"description": "Opaque previous-page nextCursor; absent for the first page."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"references",
"nextCursor"
],
"properties": {
"nextCursor": {
"type": [
"string",
"null"
]
},
"references": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"kind",
"name",
"scope",
"analysisStatus",
"analyzedAt",
"facts",
"attachmentId",
"projectId",
"assetId",
"contentUrl",
"size",
"moreFacts"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"reference_image",
"reference_video",
"audio"
]
},
"name": {
"type": "string"
},
"size": {
"type": "number"
},
"facts": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"attachmentId",
"category",
"statement",
"status",
"origin",
"priority"
],
"properties": {
"id": {
"type": "string"
},
"origin": {
"enum": [
"machine",
"user"
]
},
"status": {
"enum": [
"proposed",
"approved",
"rejected"
]
},
"category": {
"enum": [
"world",
"wardrobe",
"object",
"palette",
"cinematography",
"avoid"
]
},
"priority": {
"type": "number"
},
"statement": {
"type": "string"
},
"attachmentId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"scope": {
"enum": [
"project",
"shot"
]
},
"assetId": {
"type": "string"
},
"moreFacts": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"analyzedAt": {
"type": [
"string",
"null"
]
},
"contentUrl": {
"type": "string"
},
"attachmentId": {
"type": "string"
},
"intendedAtMs": {
"type": "number"
},
"analysisStatus": {
"enum": [
"unanalyzed",
"analyzing",
"ready",
"failed",
"unsupported"
]
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "List video and Film references",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns a paginated list of existing approved, proposed or rejected reference notes for a project, optionally filtered by attachment. No server interpretation starts.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum items to return, 1–50. Default 20. |
| cursor | string | Opaque previous-page nextCursor; absent for the first page. |
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
| attachmentId | string | Attachment ID returned by studio_references_list or studio_song_status. |
{
"name": "studio_reference_notes_list",
"title": "Read reference creative notes",
"description": "Returns a paginated list of existing approved, proposed or rejected reference notes for a project, optionally filtered by attachment. No server interpretation starts.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum items to return, 1–50. Default 20."
},
"cursor": {
"type": "string",
"maxLength": 512,
"minLength": 1,
"description": "Opaque previous-page nextCursor; absent for the first page."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
},
"attachmentId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Attachment ID returned by studio_references_list or studio_song_status."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"facts",
"nextCursor"
],
"properties": {
"facts": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"attachmentId",
"category",
"statement",
"status",
"origin",
"priority"
],
"properties": {
"id": {
"type": "string"
},
"origin": {
"enum": [
"machine",
"user"
]
},
"status": {
"enum": [
"proposed",
"approved",
"rejected"
]
},
"category": {
"enum": [
"world",
"wardrobe",
"object",
"palette",
"cinematography",
"avoid"
]
},
"priority": {
"type": "number"
},
"statement": {
"type": "string"
},
"attachmentId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read reference creative notes",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns the app reference-upload screen for an editable project, including for files over the 512 KiB inline limit. Uploaded results appear in the project's reference list. No upload or generation occurs in this read.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
{
"name": "studio_reference_upload_link",
"title": "Open reference upload screen",
"description": "Returns the app reference-upload screen for an editable project, including for files over the 512 KiB inline limit. Uploaded results appear in the project's reference list. No upload or generation occurs in this read.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"appUrl",
"next"
],
"properties": {
"next": {
"type": "string"
},
"appUrl": {
"type": "string"
},
"projectId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Open reference upload screen",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Stores and screens an image/video reference through the app attachment service. Inline files are limited to 512 KiB; larger files have an app upload-link path. Returns attachment and signed preview. scope:project applies to the project; scope:shot supports later shot binding. The reference list exposes persisted results after uncertain replies. No language model or generation-credit charge.
| Parameter | Type | Description |
|---|---|---|
| kind * | string | Existing reference media kind. |
| name * | string | File display name, for example wardrobe.webp. |
| scope | string | Whole project by default; shot is supported only for an image. |
| mimeType * | string | Actual MIME type. It must match the kind and file bytes. |
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
| bytesBase64 * | string | Canonical base64 file bytes without a data URL prefix, up to 512 KiB decoded. Larger files have an app upload-link path. |
| intendedAtMs | integer | Optional song position for a shot-scoped image; this records intent and does not bind a shot. |
Save one concrete creative instruction about a customer reference already on this project. The connected assistant does the interpretation with the customer; Brix36 validates and stores the finished sentence through the existing app fact service. Returns an approved user-authored fact. Duplicate category/sentence on the same attachment is reused. Free; no server language model is called.
| Parameter | Type | Description |
|---|---|---|
| category * | string | App reference fact category. |
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
| statement * | string | One customer-approved instruction grounded in the uploaded reference. |
| attachmentId * | string | Attachment ID returned by studio_references_list or studio_song_status. |
{
"name": "studio_reference_note_add",
"title": "Add assistant-authored reference note",
"description": "Save one concrete creative instruction about a customer reference already on this project. The connected assistant does the interpretation with the customer; Brix36 validates and stores the finished sentence through the existing app fact service. Returns an approved user-authored fact. Duplicate category/sentence on the same attachment is reused. Free; no server language model is called.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"attachmentId",
"category",
"statement"
],
"properties": {
"category": {
"enum": [
"world",
"wardrobe",
"object",
"palette",
"cinematography",
"avoid"
],
"type": "string",
"description": "App reference fact category."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
},
"statement": {
"type": "string",
"maxLength": 240,
"minLength": 1,
"description": "One customer-approved instruction grounded in the uploaded reference."
},
"attachmentId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Attachment ID returned by studio_references_list or studio_song_status."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"attachmentId",
"category",
"statement",
"status",
"origin",
"priority"
],
"properties": {
"id": {
"type": "string"
},
"origin": {
"enum": [
"machine",
"user"
]
},
"status": {
"enum": [
"proposed",
"approved",
"rejected"
]
},
"category": {
"enum": [
"world",
"wardrobe",
"object",
"palette",
"cinematography",
"avoid"
]
},
"priority": {
"type": "number"
},
"statement": {
"type": "string"
},
"attachmentId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Add assistant-authored reference note",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Approve, reject or rewrite one reference note using the app service. Rewriting records the sentence as user-authored; omitted fields stay unchanged. Returns the updated fact. Requires permission to edit its project and the customer choosing the change. No server interpretation or paid work starts.
| Parameter | Type | Description |
|---|---|---|
| factId * | string | Fact ID returned by studio_reference_notes_list. |
| status | string | Customer review choice for this fact. |
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
| statement | string | Replacement sentence approved by the customer. |
{
"name": "studio_reference_note_update",
"title": "Review or rewrite reference note",
"description": "Approve, reject or rewrite one reference note using the app service. Rewriting records the sentence as user-authored; omitted fields stay unchanged. Returns the updated fact. Requires permission to edit its project and the customer choosing the change. No server interpretation or paid work starts.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"factId"
],
"properties": {
"factId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Fact ID returned by studio_reference_notes_list."
},
"status": {
"enum": [
"approved",
"rejected"
],
"type": "string",
"description": "Customer review choice for this fact."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
},
"statement": {
"type": "string",
"maxLength": 240,
"minLength": 1,
"description": "Replacement sentence approved by the customer."
}
},
"minProperties": 3,
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"attachmentId",
"category",
"statement",
"status",
"origin",
"priority"
],
"properties": {
"id": {
"type": "string"
},
"origin": {
"enum": [
"machine",
"user"
]
},
"status": {
"enum": [
"proposed",
"approved",
"rejected"
]
},
"category": {
"enum": [
"world",
"wardrobe",
"object",
"palette",
"cinematography",
"avoid"
]
},
"priority": {
"type": "number"
},
"statement": {
"type": "string"
},
"attachmentId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Review or rewrite reference note",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Remove an existing image/video reference attachment from a project using the app service. Requires editor permission and the customer choosing this reference. The app removes its dependent notes and applies existing reference binding rules. Returns deleted=true; it does not delete another project reference or a song.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
| attachmentId * | string | Attachment ID returned by studio_references_list or studio_song_status. |
{
"name": "studio_reference_delete",
"title": "Remove customer reference",
"description": "Remove an existing image/video reference attachment from a project using the app service. Requires editor permission and the customer choosing this reference. The app removes its dependent notes and applies existing reference binding rules. Returns deleted=true; it does not delete another project reference or a song.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"attachmentId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
},
"attachmentId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Attachment ID returned by studio_references_list or studio_song_status."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"attachmentId",
"deleted"
],
"properties": {
"deleted": {
"const": true
},
"projectId": {
"type": "string"
},
"attachmentId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Remove customer reference",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Lists an artist's album, EP and single collections with projectIds, status, artwork, year, verified app project-creation links and nextCursor. Free and read-only. MCP project creation currently creates standalone releases; collection project creation uses the app.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum items to return, 1–50. Default 20. |
| cursor | string | Opaque previous-page nextCursor; absent for the first page. |
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
{
"name": "studio_releases_list",
"title": "List artist release collections",
"description": "Lists an artist's album, EP and single collections with projectIds, status, artwork, year, verified app project-creation links and nextCursor. Free and read-only. MCP project creation currently creates standalone releases; collection project creation uses the app.",
"inputSchema": {
"type": "object",
"required": [
"artistId"
],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum items to return, 1–50. Default 20."
},
"cursor": {
"type": "string",
"maxLength": 512,
"minLength": 1,
"description": "Opaque previous-page nextCursor; absent for the first page."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"releases",
"nextCursor",
"projectCreationReason"
],
"properties": {
"releases": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"artistId",
"title",
"type",
"year",
"artwork",
"status",
"projectIds",
"updatedAt",
"createProjectLinks"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"album",
"ep",
"single"
]
},
"year": {
"type": "number"
},
"title": {
"type": "string"
},
"status": {
"enum": [
"draft",
"active",
"complete"
]
},
"artwork": {
"enum": [
"afterglow",
"glasshouse",
"signal",
"solstice",
"archive"
]
},
"artistId": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"projectIds": {
"type": "array",
"items": {
"type": "string"
}
},
"createProjectLinks": {
"type": "object",
"required": [
"musicUrl",
"filmUrl"
],
"properties": {
"filmUrl": {
"type": "string"
},
"musicUrl": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"projectCreationReason": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "List artist release collections",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Creates an album, EP or single collection with title, type, year and artwork preset. Returns release summary and app project-creation links. Creation has no replay receipt; the artist's release list exposes saved title/type/year after an uncertain response. No language model, generation or charge.
| Parameter | Type | Description |
|---|---|---|
| type * | string | Existing app release collection type. |
| year * | integer | Four-digit release year accepted by the app. |
| title * | string | Collection title, such as an album name. |
| artwork * | string | Existing app artwork preset. |
| artistId * | string | Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film. |
{
"name": "studio_release_create",
"title": "Create artist release collection",
"description": "Creates an album, EP or single collection with title, type, year and artwork preset. Returns release summary and app project-creation links. Creation has no replay receipt; the artist's release list exposes saved title/type/year after an uncertain response. No language model, generation or charge.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"title",
"type",
"year",
"artwork"
],
"properties": {
"type": {
"enum": [
"album",
"ep",
"single"
],
"type": "string",
"description": "Existing app release collection type."
},
"year": {
"type": "integer",
"maximum": 2200,
"minimum": 1900,
"description": "Four-digit release year accepted by the app."
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Collection title, such as an album name."
},
"artwork": {
"enum": [
"afterglow",
"glasshouse",
"signal",
"solstice",
"archive"
],
"type": "string",
"description": "Existing app artwork preset."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Artist ID returned by studio_artists_list or studio_artist_read. Also identifies this artist when casting a Film."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"artistId",
"title",
"type",
"year",
"artwork",
"status",
"projectIds",
"updatedAt",
"createProjectLinks",
"projectCreationReason"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"album",
"ep",
"single"
]
},
"year": {
"type": "number"
},
"title": {
"type": "string"
},
"status": {
"enum": [
"draft",
"active",
"complete"
]
},
"artwork": {
"enum": [
"afterglow",
"glasshouse",
"signal",
"solstice",
"archive"
]
},
"artistId": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"projectIds": {
"type": "array",
"items": {
"type": "string"
}
},
"createProjectLinks": {
"type": "object",
"required": [
"musicUrl",
"filmUrl"
],
"properties": {
"filmUrl": {
"type": "string"
},
"musicUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"projectCreationReason": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Create artist release collection",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Renames a video or Film using expectedRevision, title and optional songTitle. Returns updated project and revision. No generation or charge.
| Parameter | Type | Description |
|---|---|---|
| title * | string | New project title. |
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
| songTitle | string | Optional song catalogue title; absence leaves it unchanged. |
| expectedRevision * | integer | Current revision from the latest read. Stale revisions are refused. |
{
"name": "studio_project_rename",
"title": "Rename Brix36 project",
"description": "Renames a video or Film using expectedRevision, title and optional songTitle. Returns updated project and revision. No generation or charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"expectedRevision",
"title"
],
"properties": {
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "New project title."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
},
"songTitle": {
"type": "string",
"maxLength": 200,
"description": "Optional song catalogue title; absence leaves it unchanged."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "Current revision from the latest read. Stale revisions are refused."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"artistId",
"releaseId",
"title",
"songTitle",
"durationMs",
"stage",
"artwork",
"updatedAt",
"revision"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"music",
"film",
null
]
},
"stage": {
"enum": [
"brief",
"planning",
"storyboard_draft",
"storyboard_approved",
"video_queued",
"generating",
"review",
"complete"
]
},
"title": {
"type": "string"
},
"prompt": {
"type": "string"
},
"artwork": {
"enum": [
"afterglow",
"glasshouse",
"signal",
"solstice",
"archive"
]
},
"artistId": {
"type": "string"
},
"revision": {
"type": "number"
},
"releaseId": {
"type": "string"
},
"songTitle": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"durationMs": {
"type": "number"
},
"outputIntent": {
"type": "object",
"required": [
"version",
"aspect",
"resolution",
"modelPreference"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"version": {
"enum": [
1
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
},
"modelPreference": {
"anyOf": [
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"enum": [
"auto"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"kind",
"modelKey"
],
"properties": {
"kind": {
"enum": [
"model"
]
},
"modelKey": {
"type": "string"
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
"creatorPalette": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Rename Brix36 project",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Archive one video or Film using the app project deletion service after the customer requests deletion. Requires editor permission. In-flight orders, paid work awaiting consumption and open/review-required checkouts refuse deletion. Returns deleted=true. This is separate from permanently erasing an artist or account.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
{
"name": "studio_project_delete",
"title": "Delete Brix36 project",
"description": "Archive one video or Film using the app project deletion service after the customer requests deletion. Requires editor permission. In-flight orders, paid work awaiting consumption and open/review-required checkouts refuse deletion. Returns deleted=true. This is separate from permanently erasing an artist or account.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"deleted"
],
"properties": {
"deleted": {
"const": true
},
"projectId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Delete Brix36 project",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Saves the project's film shape and quality through the same app service as Brix36. aspect is required (16:9 widescreen, 9:16 upright, 1:1 square); resolution keeps the saved choice when omitted. expectedRevision is optional: when present it is the project revision returned by an earlier answer of this tool and a stale one is refused; when absent the current project is used. A change starts a new version of the storyboard the same way the app does. Pictures already on the storyboard belong to the earlier shape and quality: they stay on the earlier version and are not carried onto the new one, where pictures are made or attached again. With such pictures present and without confirmPicturesRemade:true, nothing is changed and the result is changed:false with picturesAffected and an explanatory note. Returns the saved outputIntent, a customer-words shape and quality, the project revision and every available aspect/resolution. No generation or charge.
| Parameter | Type | Description |
|---|---|---|
| aspect * | string | The shape the customer wants. Phones and social feeds are upright (9:16); widescreen is 16:9; square is 1:1. |
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
| resolution | string | Optional quality. Absent keeps the saved one, else the project default (720p standard for Film; 1080p for music videos or Film HD upgrade). |
| expectedRevision | integer | Current revision from the latest read. Stale revisions are refused. |
| confirmPicturesRemade | boolean | True records that the customer was told the pictures already on this storyboard are not carried onto the new shape, and agreed. The customer’s own agreement is its only valid source. |
Prices the artist's missing reference views (photo_pack) or invented look (look) with the same signed price the Brix36 app shows. Charges nothing. Returns creditAmount, operationId, quoteToken, priceVersion and approvalExpiresAt. Approval of the exact credits takes place in this chat; no link is created. When nothing can be offered, says so without claiming their references are complete. Creating an artist stays free.
| Parameter | Type | Description |
|---|---|---|
| kind * | string | photo_pack: missing views from their existing photo. look: an invented look for an artist with no customer photo. |
| artistId * | string | The artist, from studio_artists_list or studio_artist_create. |
| lookDescription | string | Look only: the look to make, up to 1000 characters. Send the same text to quote and confirm. |
| inspirationAssetIds | array | Look only, optional: up to four owned inspiration photos. Send the same list to quote and confirm. |
{
"name": "studio_artist_reference_pack_quote",
"title": "Price an artist's missing reference pack",
"description": "Prices the artist's missing reference views (photo_pack) or invented look (look) with the same signed price the Brix36 app shows. Charges nothing. Returns creditAmount, operationId, quoteToken, priceVersion and approvalExpiresAt. Approval of the exact credits takes place in this chat; no link is created. When nothing can be offered, says so without claiming their references are complete. Creating an artist stays free.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"kind"
],
"properties": {
"kind": {
"enum": [
"photo_pack",
"look"
],
"type": "string",
"description": "photo_pack: missing views from their existing photo. look: an invented look for an artist with no customer photo."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The artist, from studio_artists_list or studio_artist_create."
},
"lookDescription": {
"type": "string",
"maxLength": 1000,
"minLength": 1,
"description": "Look only: the look to make, up to 1000 characters. Send the same text to quote and confirm."
},
"inspirationAssetIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Owned inspiration photo asset."
},
"maxItems": 4,
"description": "Look only, optional: up to four owned inspiration photos. Send the same list to quote and confirm.",
"uniqueItems": true
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"artistId",
"kind",
"offered",
"charged",
"operationId",
"quoteToken",
"creditAmount",
"totalCredits",
"expiresAt",
"priceVersion",
"approvalExpiresAt",
"approvalState",
"consentMode",
"note"
],
"properties": {
"kind": {
"enum": [
"photo_pack",
"look"
]
},
"note": {
"type": "string"
},
"charged": {
"const": false
},
"offered": {
"const": true
},
"artistId": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"weakPhotos": {
"type": "boolean"
},
"consentMode": {
"enum": [
"chat",
"unavailable"
]
},
"operationId": {
"type": "string"
},
"creditAmount": {
"type": "number"
},
"priceVersion": {
"type": "string"
},
"totalCredits": {
"type": "number"
},
"approvalState": {
"enum": [
"quoted"
]
},
"missingAngles": {
"type": "array",
"items": {
"type": "string"
}
},
"lookDescription": {
"type": "string"
},
"approvalExpiresAt": {
"type": "string"
},
"inspirationAssetIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"artistId",
"kind",
"offered",
"charged",
"reason",
"note",
"artistDnaUrl"
],
"properties": {
"kind": {
"enum": [
"photo_pack",
"look"
]
},
"note": {
"type": "string"
},
"reason": {
"enum": [
"no_missing_views",
"not_offered_now"
]
},
"charged": {
"const": false
},
"offered": {
"const": false
},
"artistId": {
"type": "string"
},
"artistDnaUrl": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Price an artist's missing reference pack",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Places the one quoted reference-pack purchase only after the customer has explicitly approved the exact credits in this chat. Takes the exact operationId, quoteToken, quotedCredits and priceVersion from the quote (and the same look inputs); an existing Brix36 approval code is accepted as confirmationToken instead. Identical retries return the first outcome and never charge twice. status still_checking keeps the original operation; an identical later call returns its outcome without a new price.
| Parameter | Type | Description |
|---|---|---|
| kind * | string | photo_pack: missing views from their existing photo. look: an invented look for an artist with no customer photo. |
| artistId * | string | The artist, from studio_artists_list or studio_artist_create. |
| quoteToken * | string | Exact signed quote. |
| operationId * | string | Exact quoted operation ID. |
| priceVersion | string | The priceVersion returned by the quote. |
| quotedCredits | integer | The exact credits the customer approved in chat. |
| lookDescription | string | Look only: the look to make, up to 1000 characters. Send the same text to quote and confirm. |
Returns saved Film scenes, dialogue, cast, voice assignments, planning state and savedPlan.revision. Add include:['languages'] for supportedLanguages and nativeSpeechLanguages (the video model's own speech), and include:['artists'] for every artist who can join the cast; leave include out for the project view. nativeSpeechEngines holds model-specific evidence. Saved per-scene voice choices determine routing; absent saved voices use native speech. Audio-off prices are unavailable for speaking scenes. operationId reads prior plan progress without starting or settling work.
| Parameter | Type | Description |
|---|---|---|
| include | array | Optional extras: 'languages' adds supportedLanguages and nativeSpeechLanguages; 'artists' adds availableArtists. Omit for the project view. |
| projectId * | string | The Film project id. |
| operationId | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
{
"name": "studio_film_read",
"title": "Read the Film, cast and dialogue",
"description": "Returns saved Film scenes, dialogue, cast, voice assignments, planning state and savedPlan.revision. Add include:['languages'] for supportedLanguages and nativeSpeechLanguages (the video model's own speech), and include:['artists'] for every artist who can join the cast; leave include out for the project view. nativeSpeechEngines holds model-specific evidence. Saved per-scene voice choices determine routing; absent saved voices use native speech. Audio-off prices are unavailable for speaking scenes. operationId reads prior plan progress without starting or settling work.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"languages",
"artists"
],
"type": "string"
},
"maxItems": 2,
"description": "Optional extras: 'languages' adds supportedLanguages and nativeSpeechLanguages; 'artists' adds availableArtists. Omit for the project view.",
"uniqueItems": true
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"title",
"workspaceId",
"filmEnabled",
"capabilityState",
"planning",
"savedPlan",
"planningOperation",
"pendingOperationIds",
"scenes",
"sound",
"cast",
"voices",
"defaultVoiceId",
"quote",
"generation",
"unavailable"
],
"properties": {
"cast": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"state",
"id",
"reason"
],
"properties": {
"id": {
"type": "string"
},
"state": {
"enum": [
"unavailable"
]
},
"reason": {
"enum": [
"not_available"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"state",
"id",
"name",
"photoUrl",
"kind",
"faceCovered",
"voiceId",
"angles"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"real",
"ai",
null
]
},
"name": {
"type": "string"
},
"state": {
"enum": [
"available"
]
},
"angles": {
"anyOf": [
{
"type": "object",
"required": [],
"properties": {
"left": {
"type": [
"string",
"null"
]
},
"front": {
"type": [
"string",
"null"
]
},
"right": {
"type": [
"string",
"null"
]
},
"smiling": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"voiceId": {
"type": [
"string",
"null"
]
},
"photoUrl": {
"type": [
"string",
"null"
]
},
"faceCovered": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": true
}
]
}
},
{
"type": "null"
}
]
},
"quote": {
"type": "null"
},
"sound": {
"anyOf": [
{
"type": "object",
"required": [
"music",
"background",
"effects"
],
"properties": {
"music": {
"type": "boolean"
},
"effects": {
"type": "boolean"
},
"background": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"title": {
"type": "string"
},
"scenes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"startMs",
"endMs",
"name",
"what",
"included",
"stillUrl",
"lines",
"sound"
],
"properties": {
"name": {
"type": "string"
},
"what": {
"type": "string"
},
"endMs": {
"type": "number"
},
"index": {
"type": "number"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"actorId",
"speaker",
"speakerName",
"speakerParenthetical",
"text",
"onCamera"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"castBy": {
"enum": [
"auto"
]
},
"actorId": {
"type": [
"string",
"null"
]
},
"speaker": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"startMs": {
"type": "number"
},
"onCamera": {
"type": "boolean"
},
"speakerName": {
"type": [
"string",
"null"
]
},
"scriptSpeaker": {
"type": "string"
},
"voiceDescription": {
"type": "string"
},
"useCharacterVoice": {
"type": "boolean"
},
"speakerParenthetical": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"sound": {
"type": "object",
"required": [
"music",
"background",
"effects"
],
"properties": {
"music": {
"type": "boolean"
},
"effects": {
"type": "boolean"
},
"background": {
"type": "boolean"
}
},
"additionalProperties": true
},
"camera": {
"type": "string"
},
"startMs": {
"type": "number"
},
"actionMs": {
"type": "number"
},
"included": {
"type": "boolean"
},
"stillUrl": {
"type": [
"string",
"null"
]
},
"direction": {
"type": "object",
"required": [
"cameraMovement",
"lens",
"lighting",
"look",
"engine"
],
"properties": {
"lens": {
"enum": [
"auto",
"wide_24mm",
"natural_35mm",
"portrait_50mm",
"telephoto_85mm",
"anamorphic"
]
},
"look": {
"enum": [
"auto",
"cinematic",
"documentary",
"film_noir",
"vintage",
"vivid"
]
},
"engine": {
"enum": [
"auto",
"seedance_2_5",
"minimax_h3",
"kling_v4",
"kling_o3",
"wan_3"
]
},
"lighting": {
"enum": [
"auto",
"natural",
"soft_studio",
"golden_hour",
"low_key",
"neon"
]
},
"cameraMovement": {
"enum": [
"auto",
"locked",
"pan",
"tilt",
"dolly_in",
"dolly_out",
"tracking",
"handheld",
"orbit"
]
}
},
"additionalProperties": true
},
"stableShotId": {
"type": "string"
},
"stableSceneId": {
"type": "string"
},
"durationSource": {
"enum": [
"script",
"inferred",
"customer"
]
},
"lipSyncOverride": {
"enum": [
"on",
"off",
null
]
},
"referenceAttachmentIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
]
},
"voices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"description"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
]
},
"language": {
"type": [
"string",
"null"
]
},
"planning": {
"enum": [
"not_planned",
"making",
"ready",
"failed",
"unavailable"
]
},
"projectId": {
"type": "string"
},
"savedPlan": {
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"sceneCount"
],
"properties": {
"revision": {
"type": "number"
},
"sceneCount": {
"type": "number"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"generation": {
"type": "null"
},
"filmEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"outputShape": {
"type": "string"
},
"unavailable": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"reason"
],
"properties": {
"field": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"additionalProperties": true
}
},
"workspaceId": {
"type": "string"
},
"libraryGroup": {
"enum": [
"finished",
"in_progress",
"carry_on",
"needs_attention"
]
},
"outputIntent": {
"anyOf": [
{
"type": "object",
"required": [
"version",
"aspect",
"resolution",
"modelPreference"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"version": {
"enum": [
1
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
},
"modelPreference": {
"anyOf": [
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"enum": [
"auto"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"kind",
"modelKey"
],
"properties": {
"kind": {
"enum": [
"model"
]
},
"modelKey": {
"type": "string"
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"libraryAction": {
"enum": [
"open",
"carry_on",
"none"
]
},
"libraryBucket": {
"enum": [
"finished",
"to_finish"
]
},
"outputQuality": {
"enum": [
"720p",
"1080p",
"4k"
]
},
"defaultVoiceId": {
"type": [
"string",
"null"
]
},
"capabilityState": {
"enum": [
"available",
"unavailable"
]
},
"libraryInFlight": {
"type": "boolean"
},
"availableArtists": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"state",
"id",
"reason"
],
"properties": {
"id": {
"type": "string"
},
"state": {
"enum": [
"unavailable"
]
},
"reason": {
"enum": [
"not_available"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"state",
"id",
"name",
"photoUrl",
"kind",
"faceCovered",
"voiceId",
"angles"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"real",
"ai",
null
]
},
"name": {
"type": "string"
},
"state": {
"enum": [
"available"
]
},
"angles": {
"anyOf": [
{
"type": "object",
"required": [],
"properties": {
"left": {
"type": [
"string",
"null"
]
},
"front": {
"type": [
"string",
"null"
]
},
"right": {
"type": [
"string",
"null"
]
},
"smiling": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"voiceId": {
"type": [
"string",
"null"
]
},
"photoUrl": {
"type": [
"string",
"null"
]
},
"faceCovered": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": true
}
]
}
},
{
"type": "null"
}
]
},
"planningOperation": {
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"state",
"revision"
],
"properties": {
"state": {
"enum": [
"none",
"resolving",
"done",
"failed"
]
},
"revision": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"libraryStatusLabel": {
"type": "string"
},
"supportedLanguages": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"label"
],
"properties": {
"code": {
"type": "string"
},
"label": {
"type": "string"
}
},
"additionalProperties": true
}
},
"defaultOutputIntent": {
"type": "object",
"required": [
"version",
"aspect",
"resolution",
"modelPreference"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"version": {
"enum": [
1
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
},
"modelPreference": {
"anyOf": [
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"enum": [
"auto"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"kind",
"modelKey"
],
"properties": {
"kind": {
"enum": [
"model"
]
},
"modelKey": {
"type": "string"
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
"nativeSpeechEngines": {
"type": "array",
"items": {
"type": "object",
"required": [
"providerId",
"modelId",
"nativeSpeech",
"supportedLanguages"
],
"properties": {
"modelId": {
"type": "string"
},
"providerId": {
"type": "string"
},
"nativeSpeech": {
"enum": [
"audio_included"
]
},
"supportedLanguages": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"additionalProperties": true
}
},
"pendingOperationIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"nativeSpeechLanguages": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"label"
],
"properties": {
"code": {
"type": "string"
},
"label": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read the Film, cast and dialogue",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Saves finished Film scenes, visualWorld, camera directions and dialogue against the current revision. Scenes form 30-second cards, with at most six spoken lines per card and five minutes per Film. Identical operationId/input retries return the saved result. visualWorld is required for quoting. No Brix36 planning model, media generation or credit charge. Each scene's sound comes from the scene's text unless stated. Music is included only when sound.music is true.
| Parameter | Type | Description |
|---|---|---|
| scenes * | array | |
| castIds * | array | |
| language * | string | The selected supported Film language; studio_film_read with include:['languages'] lists them. Text is preserved, never translated. |
| projectId * | string | A project created by studio_video_start with kind film. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| visualWorld | object | Board-wide visual facts. Optional characters, vehicles, locations, props and never are arrays of up to 12 non-empty strings, each at most 300 characters. Combined rendered fields are limited to 2,400 characters including labels, separators and newlines after trimming. Scene-specific costume and visu… |
| expectedRevisionId |
Searches the voice library's ready-made voices. Returns offered opaque IDs, names, descriptions, selected voice, current revision and nextCursor. lib: voices use Brix36's account; acct: voices belong to connected personal accounts and are currently unavailable for Film. No speech generation or credit charge.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum items to return, 1–50. Default 20. |
| cursor | string | Opaque previous-page nextCursor; absent for the first page. |
| search | string | Voice name or traits to search for. |
| artistId * | string | The cast artist whose speaking voice this operation concerns. |
{
"name": "studio_artist_voices_list",
"title": "Find a character’s voice",
"description": "Searches the voice library's ready-made voices. Returns offered opaque IDs, names, descriptions, selected voice, current revision and nextCursor. lib: voices use Brix36's account; acct: voices belong to connected personal accounts and are currently unavailable for Film. No speech generation or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"artistId"
],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum items to return, 1–50. Default 20."
},
"cursor": {
"type": "string",
"maxLength": 512,
"minLength": 1,
"description": "Opaque previous-page nextCursor; absent for the first page."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Voice name or traits to search for."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The cast artist whose speaking voice this operation concerns."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"voiceId",
"voices",
"defaultVoiceId",
"canSing",
"revision",
"accountVoicesUnavailable",
"nextCursor",
"count",
"note"
],
"properties": {
"note": {
"type": "string"
},
"count": {
"type": "number"
},
"voices": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"description"
],
"properties": {
"id": {
"type": "string"
},
"tag": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"accent": {
"type": [
"string",
"null"
]
},
"gender": {
"type": [
"string",
"null"
]
},
"previewUrl": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
}
},
"additionalProperties": true
}
},
"canSing": {
"type": "boolean"
},
"voiceId": {
"type": [
"string",
"null"
]
},
"revision": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"defaultVoiceId": {
"type": "string"
},
"accountVoicesUnavailable": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Find a character’s voice",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Assigns an offered ready-made voice from the voice library through a durable revision-bound operation. voiceId is an opaque catalogue ID and expectedRevision is the current voice revision, or null when no voice exists. May add a shared library voice; creates no speech and debits no credits. Film speech requires its separate quoted financial approval. Identical operation retries retain identity.
| Parameter | Type | Description |
|---|---|---|
| voiceId * | string | An offered lib:<owner>:<voice> or acct:<voice> ID. Film supports lib: voices. |
| artistId * | string | The cast artist id. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| expectedRevision * | ["integer","null"] | The revision from studio_artist_voices_list, or null when no saved voice exists. |
{
"name": "studio_artist_voice_choose",
"title": "Assign an offered character voice",
"description": "Assigns an offered ready-made voice from the voice library through a durable revision-bound operation. voiceId is an opaque catalogue ID and expectedRevision is the current voice revision, or null when no voice exists. May add a shared library voice; creates no speech and debits no credits. Film speech requires its separate quoted financial approval. Identical operation retries retain identity.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"operationId",
"expectedRevision",
"voiceId"
],
"properties": {
"voiceId": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "An offered lib:<owner>:<voice> or acct:<voice> ID. Film supports lib: voices."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The cast artist id."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"expectedRevision": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "The revision from studio_artist_voices_list, or null when no saved voice exists."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"voiceId",
"revision",
"singing"
],
"properties": {
"singing": {
"const": false
},
"voiceId": {
"type": "string"
},
"revision": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Assign an offered character voice",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Returns pending, unknown, refused or succeeded for an earlier owned voice operation, with saved voice/revision on success. Unknown provider effects remain unresolved. This read does not repeat provider work or synthesize speech.
| Parameter | Type | Description |
|---|---|---|
| artistId * | string | The artist id from the original request. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
{
"name": "studio_artist_voice_status",
"title": "Recover a character voice request",
"description": "Returns pending, unknown, refused or succeeded for an earlier owned voice operation, with saved voice/revision on success. Unknown provider effects remain unresolved. This read does not repeat provider work or synthesize speech.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"operationId"
],
"properties": {
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The artist id from the original request."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"artistId",
"kind",
"status"
],
"properties": {
"kind": {
"enum": [
"choose",
"record",
"design_preview",
"design_save"
]
},
"status": {
"enum": [
"pending",
"unknown"
]
},
"artistId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"operationId",
"artistId",
"kind",
"status",
"code"
],
"properties": {
"code": {
"type": "string"
},
"kind": {
"enum": [
"choose",
"record",
"design_preview",
"design_save"
]
},
"status": {
"enum": [
"refused"
]
},
"artistId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"operationId",
"artistId",
"kind",
"status",
"result"
],
"properties": {
"kind": {
"enum": [
"choose",
"record",
"design_preview",
"design_save"
]
},
"result": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"saved"
],
"properties": {
"type": {
"enum": [
"saved_voice"
]
},
"saved": {
"type": "object",
"required": [
"voiceId",
"revision",
"singing"
],
"properties": {
"singing": {
"const": false
},
"voiceId": {
"type": "string"
},
"revision": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"type",
"roundsLeft",
"previews"
],
"properties": {
"type": {
"enum": [
"design_previews"
]
},
"previews": {
"type": "array",
"items": {
"type": "object",
"required": [
"generatedVoiceId",
"durationMs",
"mimeType",
"audioBase64"
],
"properties": {
"mimeType": {
"type": "string"
},
"durationMs": {
"type": [
"number",
"null"
]
},
"audioBase64": {
"type": "string"
},
"generatedVoiceId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"roundsLeft": {
"type": "number"
}
},
"additionalProperties": true
}
]
},
"status": {
"enum": [
"succeeded"
]
},
"artistId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Recover a character voice request",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Validates and saves visualWorld for an existing Music or Film storyboard at expectedRevisionId. Preserves scenes, dialogue, timing, stable shot IDs, cast, identity choices and references. Returns ready synchronously for a valid world, or needs_visual_world with saved-scene context and schema when absent. An already-valid saved world returns ready without a new revision. No planning model, queue, generation provider or credit use.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Existing music-video or Film project. |
| visualWorld | object | Board-wide visual facts. Optional characters, vehicles, locations, props and never are arrays of up to 12 non-empty strings, each at most 300 characters. Combined rendered fields are limited to 2,400 characters including labels, separators and newlines after trimming. Scene-specific costume and visu… |
| expectedRevisionId * | string | Exact current authored storyboard revision. Current saved state is available through storyboard reads after uncertain replies. |
{
"name": "studio_storyboard_prepare",
"title": "Prepare the saved storyboard’s visual world",
"description": "Validates and saves visualWorld for an existing Music or Film storyboard at expectedRevisionId. Preserves scenes, dialogue, timing, stable shot IDs, cast, identity choices and references. Returns ready synchronously for a valid world, or needs_visual_world with saved-scene context and schema when absent. An already-valid saved world returns ready without a new revision. No planning model, queue, generation provider or credit use.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"expectedRevisionId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Existing music-video or Film project."
},
"visualWorld": {
"type": "object",
"required": [
"timeOfDay",
"light",
"setting"
],
"properties": {
"light": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"never": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"props": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"artist": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"palette": {
"type": "array",
"items": {
"type": "string",
"pattern": "^#[0-9A-F]{6}$"
},
"maxItems": 5,
"description": "Optional creator-selected palette: 0–5 unique uppercase #RRGGBB colours.",
"uniqueItems": true
},
"setting": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"vehicles": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"locations": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"timeOfDay": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"characters": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
}
},
"description": "Board-wide visual facts. Optional characters, vehicles, locations, props and never are arrays of up to 12 non-empty strings, each at most 300 characters. Combined rendered fields are limited to 2,400 characters including labels, separators and newlines after trimming. Scene-specific costume and visual direction belong to scene text.",
"additionalProperties": false
},
"expectedRevisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact current authored storyboard revision. Current saved state is available through storyboard reads after uncertain replies."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"revisionId",
"scenesPreserved",
"free",
"credits",
"next",
"inputSchema",
"state",
"visualWorld"
],
"properties": {
"free": {
"const": true
},
"next": {
"type": "string"
},
"state": {
"enum": [
"ready"
]
},
"credits": {
"const": 0
},
"revision": {
"type": "number"
},
"projectId": {
"type": "string"
},
"shotCount": {
"type": "number"
},
"authoredBy": {
"enum": [
"customer_ai"
]
},
"revisionId": {
"type": "string"
},
"inputSchema": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"object"
]
}
},
"additionalProperties": true
},
"visualWorld": {
"type": "object",
"required": [
"timeOfDay",
"light",
"setting"
],
"properties": {
"light": {
"type": "string"
},
"never": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "array",
"items": {
"type": "string"
}
},
"artist": {
"type": "string"
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"setting": {
"type": "string"
},
"vehicles": {
"type": "array",
"items": {
"type": "string"
}
},
"locations": {
"type": "array",
"items": {
"type": "string"
}
},
"timeOfDay": {
"type": "string"
},
"characters": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"worldSource": {
"enum": [
"saved"
]
},
"scenesPreserved": {
"const": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"projectId",
"revisionId",
"scenesPreserved",
"free",
"credits",
"next",
"inputSchema",
"state",
"visualWorld",
"authoredBy",
"context"
],
"properties": {
"free": {
"const": true
},
"next": {
"type": "string"
},
"state": {
"enum": [
"needs_visual_world"
]
},
"context": {
"type": "object",
"required": [
"shots",
"film"
],
"properties": {
"film": {
"anyOf": [
{
"type": "object",
"required": [
"scenes",
"cast_ids",
"language"
],
"properties": {
"scenes": {
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"startMs",
"endMs",
"what",
"lines"
],
"properties": {
"what": {
"type": "string"
},
"endMs": {
"type": "number"
},
"index": {
"type": "number"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": true
}
},
"startMs": {
"type": "number"
}
},
"additionalProperties": true
}
},
"cast_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"language": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"order",
"label",
"description",
"startMs",
"endMs",
"visual",
"status",
"setup",
"role",
"performance",
"motion",
"camera"
],
"properties": {
"role": {
"enum": [
"hook-anchor",
"verse",
"insert",
"payoff"
]
},
"endMs": {
"type": "number"
},
"label": {
"type": "string"
},
"order": {
"type": "number"
},
"setup": {
"type": "string"
},
"camera": {
"type": "string"
},
"motion": {
"type": "string"
},
"status": {
"enum": [
"draft",
"approved",
"changes_requested"
]
},
"visual": {
"type": "string"
},
"startMs": {
"type": "number"
},
"description": {
"type": "string"
},
"performance": {
"type": "boolean"
},
"stableShotId": {
"type": "string"
},
"identityTarget": {
"enum": [
"artist",
"none",
null
]
},
"sectionDirection": {
"type": [
"string",
"null"
]
},
"referenceAttachmentIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"credits": {
"const": 0
},
"projectId": {
"type": "string"
},
"authoredBy": {
"enum": [
"customer_ai"
]
},
"revisionId": {
"type": "string"
},
"inputSchema": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"object"
]
}
},
"additionalProperties": true
},
"visualWorld": {
"type": "null"
},
"scenesPreserved": {
"const": true
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Prepare the saved storyboard’s visual world",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Returns current song analysis, brief, approved Artist DNA, references, exact shot timings and storyboard for a Music project. Includes audioAnalysisId, expectedRevisionId, fixed skeleton, approved evidence and submission schema for direction and visualWorld. No planning model or other work starts.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Music-video project to read. |
| targetShotCount | integer | Optional first-board shot count, shared with studio_storyboard_submit. |
{
"name": "studio_storyboard_context",
"title": "Read the song and fixed storyboard format",
"description": "Returns current song analysis, brief, approved Artist DNA, references, exact shot timings and storyboard for a Music project. Includes audioAnalysisId, expectedRevisionId, fixed skeleton, approved evidence and submission schema for direction and visualWorld. No planning model or other work starts.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Music-video project to read."
},
"targetShotCount": {
"type": "integer",
"maximum": 240,
"minimum": 1,
"description": "Optional first-board shot count, shared with studio_storyboard_submit."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"expectedRevisionId",
"audioAnalysisId",
"timingBasis",
"artistPresence",
"identityPack",
"creativeContext",
"skeleton",
"currentShots",
"sections",
"inputSchema",
"authoredBy",
"skillIds",
"note"
],
"properties": {
"note": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"startMs",
"endMs",
"name",
"what",
"type",
"included",
"stillUrl",
"lines",
"stillState"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"performance",
"story"
]
},
"what": {
"type": "string"
},
"endMs": {
"type": "number"
},
"index": {
"type": "number"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs",
"role",
"sync"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"lead",
"adlib",
"guest"
]
},
"sync": {
"type": "boolean"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"guestName": {
"type": "string"
}
},
"additionalProperties": true
}
},
"startMs": {
"type": "number"
},
"included": {
"type": "boolean"
},
"stillUrl": {
"type": [
"string",
"null"
]
},
"stillState": {
"enum": [
"making",
"ready",
"failed",
"none"
]
}
},
"additionalProperties": true
}
},
"skeleton": {
"type": "array",
"items": {
"type": "object",
"required": [
"order",
"startMs",
"endMs",
"energy",
"sectionLabel"
],
"properties": {
"endMs": {
"type": "number"
},
"order": {
"type": "number"
},
"energy": {
"type": "number"
},
"lyrics": {
"type": "array",
"items": {
"type": "object",
"required": [
"text",
"voice",
"startMs",
"endMs"
],
"properties": {
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"voice": {
"type": "string"
},
"startMs": {
"type": "number"
}
},
"additionalProperties": true
}
},
"startMs": {
"type": "number"
},
"sectionLabel": {
"type": "string"
}
},
"additionalProperties": true
}
},
"skillIds": {
"type": "array",
"items": {
"type": "string"
}
},
"projectId": {
"type": "string"
},
"authoredBy": {
"enum": [
"customer_ai"
]
},
"inputSchema": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"object"
]
}
},
"additionalProperties": true
},
"timingBasis": {
"enum": [
"measured_audio",
"even"
]
},
"currentShots": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"order",
"label",
"description",
"startMs",
"endMs",
"visual",
"status"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"hook-anchor",
"verse",
"insert",
"payoff"
]
},
"endMs": {
"type": "number"
},
"label": {
"type": "string"
},
"order": {
"type": "number"
},
"setup": {
"type": "string"
},
"camera": {
"type": "string"
},
"motion": {
"type": "string"
},
"status": {
"enum": [
"draft",
"approved",
"changes_requested"
]
},
"visual": {
"type": "string"
},
"startMs": {
"type": "number"
},
"description": {
"type": "string"
},
"performance": {
"type": "boolean"
},
"identityTarget": {
"enum": [
"artist",
"none",
null
]
},
"sectionDirection": {
"type": [
"string",
"null"
]
},
"referenceAttachmentIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"identityPack": {
"type": "object",
"required": [
"pinned",
"packId",
"version",
"publishedPackAvailable"
],
"properties": {
"packId": {
"type": [
"string",
"null"
]
},
"pinned": {
"type": "boolean"
},
"version": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publishedPackAvailable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"artistPresence": {
"enum": [
"featured",
"not_featured"
]
},
"audioAnalysisId": {
"type": "string"
},
"creativeContext": {
"type": "object",
"required": [
"artistName",
"genres",
"visualKeywords",
"recurringThemes",
"influences",
"brief",
"songTitle",
"tempoBpm"
],
"properties": {
"brief": {
"type": "string"
},
"genres": {
"type": "array",
"items": {
"type": "string"
}
},
"brandDna": {
"type": "object",
"required": [
"versionId",
"facts",
"avoid"
],
"properties": {
"avoid": {
"type": "array",
"items": {
"type": "string"
}
},
"facts": {
"type": "array",
"items": {
"type": "object",
"required": [
"category",
"statement"
],
"properties": {
"category": {
"type": "string"
},
"statement": {
"type": "string"
}
},
"additionalProperties": true
}
},
"context": {
"type": "array",
"items": {
"type": "object",
"required": [
"evidenceId",
"title",
"mediaType",
"source",
"purpose",
"era",
"allowedUses"
],
"properties": {
"era": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"source": {
"type": "string"
},
"purpose": {
"type": "string"
},
"mediaType": {
"type": "string"
},
"evidenceId": {
"type": "string"
},
"allowedUses": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"versionId": {
"type": [
"string",
"null"
]
},
"selectable": {
"type": "array",
"items": {
"type": "object",
"required": [
"evidenceId",
"title",
"mediaType",
"source",
"purpose",
"era",
"allowedUses"
],
"properties": {
"era": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"source": {
"type": "string"
},
"purpose": {
"type": "string"
},
"mediaType": {
"type": "string"
},
"evidenceId": {
"type": "string"
},
"allowedUses": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"tempoBpm": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"songTitle": {
"type": "string"
},
"artistName": {
"type": "string"
},
"influences": {
"type": "array",
"items": {
"type": "string"
}
},
"songThemes": {
"type": "array",
"items": {
"type": "string"
}
},
"artistPresence": {
"enum": [
"featured",
"not_featured",
null
]
},
"visualKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"recurringThemes": {
"type": "array",
"items": {
"type": "string"
}
},
"projectReferences": {
"type": "object",
"required": [
"facts",
"avoid"
],
"properties": {
"avoid": {
"type": "array",
"items": {
"type": "string"
}
},
"facts": {
"type": "array",
"items": {
"type": "object",
"required": [
"category",
"statement"
],
"properties": {
"category": {
"type": "string"
},
"statement": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"expectedRevisionId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read the song and fixed storyboard format",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Validates and saves a finished Music storyboard with one DirectedShot per fixed shot order, exact expectedRevisionId/audioAnalysisId, optional treatment and visualWorld. Creates an immutable revision while preserving server-owned timing. visualWorld is required for quoting. No model, queue, provider or credit use.
| Parameter | Type | Description |
|---|---|---|
| shots * | array | Finished direction, exactly one entry per server-owned shot order. |
| projectId * | string | Existing music-video project id. |
| treatment | object | |
| visualWorld | object | Board-wide visual facts. Optional characters, vehicles, locations, props and never are arrays of up to 12 non-empty strings, each at most 300 characters. Combined rendered fields are limited to 2,400 characters including labels, separators and newlines after trimming. Scene-specific costume and visu… |
| audioAnalysisId * | string | Exact current song analysis id returned by the context. |
| targetShotCount | integer | Optional first-board shot count used when reading the context. Existing timing is preserved. |
| expectedRevisionId * | ["string","null"] | Exact current revision id, or null only for the first storyboard. |
Saves finished prompt text, identityTarget ('artist' or 'none') and existing uploaded references as an immutable storyboard revision. Whole/section scope writes shared sectionDirection; shot/still scope writes frame description and optional motion/camera. Set identityTarget='none' for person-free shots so pictures skip artist photos, face swap and likeness checks while unchanged stills carry forward. References replace targeted bindings; [] clears and omission inherits. Requires the current revision. No pictures, video, planning model or credit charge.
| Parameter | Type | Description |
|---|---|---|
| scope * | string | Whole/section saves a shared sectionDirection; shot/still edits the visible frame prompt. |
| camera | string | Finished camera movement for a shot/still. |
| motion | string | Finished subject movement for a shot/still. |
| prompt | string | Finished prompt, at most 4,000 characters for shot/still or 2,000 for whole/section. The server fits saved direction to the selected engine. |
| shotId | string | Current stable shot id, required for shot or still scope. |
| projectId * | string | Project identified by the current storyboard read. |
| sectionIndex | integer | Current section index, required for section scope. |
| identityTarget | string |
Returns engine options for one section of an existing generation quote identified by costEstimateId or quoteToken. Film sectionIndex is the saved zero-based scene.index. Includes availability, requirements, selection, server Recommended marker, allocated_final_total section share, availableProfiles and finalVideoCredits. Option selection_total is a whole alternative video quote total, excluding pictures. No selection change or spending.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Project identified by the quote. |
| sectionIndex * | integer | Music section index, or the exact saved Film scene.index, to show options for. |
| costEstimateId * | string | Exact costEstimateId returned by studio_generate_quote or studio_section_engine_select. |
| expectedRevisionId * | string | Exact current storyboard revision from studio_storyboard_context. |
{
"name": "studio_section_engines",
"title": "Read the app’s quoted engine choices for a section",
"description": "Returns engine options for one section of an existing generation quote identified by costEstimateId or quoteToken. Film sectionIndex is the saved zero-based scene.index. Includes availability, requirements, selection, server Recommended marker, allocated_final_total section share, availableProfiles and finalVideoCredits. Option selection_total is a whole alternative video quote total, excluding pictures. No selection change or spending.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"expectedRevisionId",
"costEstimateId",
"sectionIndex"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project identified by the quote."
},
"sectionIndex": {
"type": "integer",
"maximum": 239,
"minimum": 0,
"description": "Music section index, or the exact saved Film scene.index, to show options for."
},
"costEstimateId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact costEstimateId returned by studio_generate_quote or studio_section_engine_select."
},
"expectedRevisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact current storyboard revision from studio_storyboard_context."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"storyboardRevisionId",
"costEstimateId",
"sectionIndex",
"delivery",
"expiresAt",
"shots"
],
"properties": {
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"work",
"selection",
"selectedModelName",
"recommendedChoiceId",
"selectedChoiceId",
"reason",
"families"
],
"properties": {
"work": {
"enum": [
"generate",
"reuse"
]
},
"reason": {
"anyOf": [
{
"type": "object",
"required": [
"basis",
"text"
],
"properties": {
"text": {
"type": "string"
},
"basis": {
"enum": [
"measured",
"capability_fit",
"fallback"
]
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"families": {
"type": "array",
"items": {
"type": "object",
"required": [
"family",
"options"
],
"properties": {
"family": {
"enum": [
"kling",
"seedance",
"wan",
"minimax"
]
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"choiceId",
"modelName",
"available",
"requirement",
"explanation"
],
"properties": {
"pricing": {
"type": "object",
"required": [
"basis",
"allInCredits",
"deltaCredits",
"savedWork"
],
"properties": {
"basis": {
"enum": [
"selection_total"
]
},
"savedWork": {
"enum": [
"applied",
"not_assumed"
]
},
"allInCredits": {
"type": "number"
},
"deltaCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"choiceId": {
"type": [
"string",
"null"
]
},
"available": {
"type": "boolean"
},
"modelName": {
"type": "string"
},
"explanation": {
"type": [
"string",
"null"
]
},
"requirement": {
"enum": [
"none",
"verification",
"permission",
"unsupported_shot",
"unavailable"
]
},
"verificationRoute": {
"enum": [
"artist_identity_verification"
]
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"selection": {
"enum": [
"automatic",
"explicit",
"saved_video"
]
},
"stableShotId": {
"type": "string"
},
"selectedChoiceId": {
"type": [
"string",
"null"
]
},
"selectedModelName": {
"type": [
"string",
"null"
]
},
"recommendedChoiceId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"section": {
"type": "object",
"required": [
"sectionIndex",
"sectionId",
"stableShotIds",
"delivery",
"availableProfiles",
"pricing"
],
"properties": {
"pricing": {
"type": "object",
"required": [
"basis",
"credits"
],
"properties": {
"basis": {
"enum": [
"allocated_final_total"
]
},
"credits": {
"type": "number"
}
},
"additionalProperties": true
},
"delivery": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"sectionId": {
"type": [
"string",
"null"
]
},
"sectionIndex": {
"type": "number"
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"availableProfiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"delivery": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"expiresAt": {
"type": "string"
},
"projectId": {
"type": "string"
},
"sectionIndex": {
"type": "number"
},
"costEstimateId": {
"type": "string"
},
"finalVideoCredits": {
"type": "number"
},
"storyboardRevisionId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read the app’s quoted engine choices for a section",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Selects an available modelName or generation profile for one quoted section and returns a revised signed quote with costEstimateId. Film uses saved scene.index. modelName:null restores the server-ranked Recommended choice; omitted modelName preserves explicit selections. profile {aspect,resolution} is constrained to availableProfiles. Other sections retain their choices; outputs fit the project canvas without cropping. The revised quote has its own price and approval binding. operationId identifies identical selection retries. Film speech data reports the actual per-scene routes or historical_unavailable. No credits are spent and no generation starts.
| Parameter | Type | Description |
|---|---|---|
| profile | object | |
| modelName | ["string","null"] | Available modelName from studio_section_engines; null restores Recommended and absence retains explicit selections during a profile change. Profiles are constrained to returned availableProfiles. |
| projectId * | string | Project identified by the quote. |
| operationId * | string | Client-generated identity for a selection quote. Identical retries share the identity; different selections have distinct identities. |
| sectionIndex * | integer | Music section index, or the exact saved Film scene.index, whose new generation uses this engine. |
| costEstimateId * | string | Exact estimate returned by the preceding quote. |
Read the artist’s saved speaking voice and revision, with a private sample link when available. A recorded voice is already selected for this artist’s Film dialogue. No voice is created, no speech is generated and no credits are spent.
| Parameter | Type | Description |
|---|---|---|
| artistId * | string | The existing cast artist. |
{
"name": "studio_artist_voice_read",
"title": "Read the artist’s own voice",
"description": "Read the artist’s saved speaking voice and revision, with a private sample link when available. A recorded voice is already selected for this artist’s Film dialogue. No voice is created, no speech is generated and no credits are spent.",
"inputSchema": {
"type": "object",
"required": [
"artistId"
],
"properties": {
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The existing cast artist."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"artistId",
"voiceId",
"revision",
"canSing",
"sample",
"cloningAvailable",
"uses"
],
"properties": {
"uses": {
"type": "string"
},
"sample": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"name",
"description"
],
"properties": {
"id": {
"type": "string"
},
"tag": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"accent": {
"type": [
"string",
"null"
]
},
"gender": {
"type": [
"string",
"null"
]
},
"previewUrl": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"canSing": {
"type": "boolean"
},
"voiceId": {
"type": [
"string",
"null"
]
},
"artistId": {
"type": "string"
},
"revision": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"cloningAvailable": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read the artist’s own voice",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Creates and selects an artist's own speaking voice from an owned confirmed audio sampleAssetId, typically 30–120 seconds. App recording validation, durable operation, provider admission and daily spend guards apply. Setup cost is included in the artist's first Film quote; this call debits no customer credits. Identical operation/input retries reconcile the saved effect. Unconfigured cloning refuses before provider work. This voice is for Film dialogue, not song singing.
| Parameter | Type | Description |
|---|---|---|
| artistId * | string | The existing cast artist. |
| operationId * | string | Stable operation identity. Identical retries retain the original identifier and arguments; new work has a distinct identifier. |
| sampleAssetId * | string | Confirmed audio assetId returned by the upload/import path. |
| expectedRevision * | ["integer","null"] | The current voice revision from studio_artist_voice_read; null only when no voice exists. |
{
"name": "studio_artist_voice_record",
"title": "Use my voice for this artist",
"description": "Creates and selects an artist's own speaking voice from an owned confirmed audio sampleAssetId, typically 30–120 seconds. App recording validation, durable operation, provider admission and daily spend guards apply. Setup cost is included in the artist's first Film quote; this call debits no customer credits. Identical operation/input retries reconcile the saved effect. Unconfigured cloning refuses before provider work. This voice is for Film dialogue, not song singing.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"sampleAssetId",
"operationId",
"expectedRevision"
],
"properties": {
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The existing cast artist."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identity. Identical retries retain the original identifier and arguments; new work has a distinct identifier."
},
"sampleAssetId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Confirmed audio assetId returned by the upload/import path."
},
"expectedRevision": {
"type": [
"integer",
"null"
],
"minimum": 1,
"description": "The current voice revision from studio_artist_voice_read; null only when no voice exists."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"artistId",
"operationId",
"voiceId",
"revision",
"singing",
"uses"
],
"properties": {
"uses": {
"type": "string"
},
"singing": {
"const": false
},
"voiceId": {
"type": "string"
},
"artistId": {
"type": "string"
},
"revision": {
"type": "number"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Use my voice for this artist",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Sets an owned uploaded photograph as a shot's original picture, bound to attachment contentHash and confirmed rights. Creates a canonical revision and retains earlier versions. Identical argument retries reconcile the same operation. No generation or credit charge.
| Parameter | Type | Description |
|---|---|---|
| shotId * | string | The stable shot ID from that board. |
| projectId * | string | The current owned project. |
| revisionId * | string | The exact current storyboard revision. |
| attachmentId * | string | Owned image attachment. |
| rightsConfirmed * | boolean | |
| expectedContentHash * | string |
{
"name": "studio_picture_use_upload",
"title": "Use my uploaded picture",
"description": "Sets an owned uploaded photograph as a shot's original picture, bound to attachment contentHash and confirmed rights. Creates a canonical revision and retains earlier versions. Identical argument retries reconcile the same operation. No generation or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"revisionId",
"shotId",
"attachmentId",
"expectedContentHash",
"rightsConfirmed"
],
"properties": {
"shotId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The stable shot ID from that board."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The current owned project."
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The exact current storyboard revision."
},
"attachmentId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Owned image attachment."
},
"rightsConfirmed": {
"type": "boolean",
"const": true
},
"expectedContentHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"changed",
"revisionId",
"revision",
"origin"
],
"properties": {
"origin": {
"enum": [
"uploaded"
]
},
"changed": {
"type": "boolean"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Use my uploaded picture",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Save 0–5 unique uppercase #RRGGBB colours as exact project creative direction. An empty list clears the selection. Existing work remains in history; stale revision and active work refuse safely.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | The current owned project. |
| creatorPalette * | array | |
| expectedRevision * | integer | Current project revision. A stale revision returns revision_conflict. |
{
"name": "studio_project_palette_write",
"title": "Choose project colours",
"description": "Save 0–5 unique uppercase #RRGGBB colours as exact project creative direction. An empty list clears the selection. Existing work remains in history; stale revision and active work refuse safely.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"expectedRevision",
"creatorPalette"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The current owned project."
},
"creatorPalette": {
"type": "array",
"items": {
"type": "string",
"pattern": "^#[0-9A-F]{6}$"
},
"maxItems": 5,
"minItems": 0,
"uniqueItems": true
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "Current project revision. A stale revision returns revision_conflict."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"artistId",
"releaseId",
"title",
"songTitle",
"durationMs",
"stage",
"artwork",
"updatedAt",
"revision"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"music",
"film",
null
]
},
"stage": {
"enum": [
"brief",
"planning",
"storyboard_draft",
"storyboard_approved",
"video_queued",
"generating",
"review",
"complete"
]
},
"title": {
"type": "string"
},
"prompt": {
"type": "string"
},
"artwork": {
"enum": [
"afterglow",
"glasshouse",
"signal",
"solstice",
"archive"
]
},
"artistId": {
"type": "string"
},
"revision": {
"type": "number"
},
"releaseId": {
"type": "string"
},
"songTitle": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"durationMs": {
"type": "number"
},
"outputIntent": {
"type": "object",
"required": [
"version",
"aspect",
"resolution",
"modelPreference"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"version": {
"enum": [
1
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
},
"modelPreference": {
"anyOf": [
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"enum": [
"auto"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"kind",
"modelKey"
],
"properties": {
"kind": {
"enum": [
"model"
]
},
"modelKey": {
"type": "string"
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
"creatorPalette": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Choose project colours",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read the actual owned driving-video references for a shot. These are distinct from extracted reference pictures. No paid work.
| Parameter | Type | Description |
|---|---|---|
| shotId * | string | The stable shot ID from that board. |
| projectId * | string | The current owned project. |
| revisionId * | string | The exact current storyboard revision. |
{
"name": "studio_shot_video_references_read",
"title": "Read shot video references",
"description": "Read the actual owned driving-video references for a shot. These are distinct from extracted reference pictures. No paid work.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"revisionId",
"shotId"
],
"properties": {
"shotId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The stable shot ID from that board."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The current owned project."
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The exact current storyboard revision."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"use",
"references"
],
"properties": {
"use": {
"enum": [
"driving_video"
]
},
"references": {
"type": "array",
"items": {
"type": "object",
"required": [
"attachmentId",
"assetId",
"contentHash",
"durationMs",
"width",
"height",
"fps",
"approvedBy"
],
"properties": {
"fps": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"assetId": {
"type": "string"
},
"approvedBy": {
"type": "string"
},
"durationMs": {
"type": "number"
},
"contentHash": {
"type": "string"
},
"attachmentId": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read shot video references",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Binds up to three owned uploaded 1–15 second original clips as shot motion/composition references. Measures bytes and creates one canonical revision. Stricter model limits or unsupported driving-video inputs refuse before payment. Clips remain video references rather than sampled pictures. Empty attachmentIds clears the selection; identical retries reconcile the same write.
| Parameter | Type | Description |
|---|---|---|
| shotId * | string | The stable shot ID from that board. |
| projectId * | string | The current owned project. |
| revisionId * | string | The exact current storyboard revision. |
| attachmentIds * | array | |
| rightsConfirmed * | boolean | |
| expectedRevisionId * | string | The exact current storyboard revision. |
{
"name": "studio_shot_video_references_write",
"title": "Choose shot video references",
"description": "Binds up to three owned uploaded 1–15 second original clips as shot motion/composition references. Measures bytes and creates one canonical revision. Stricter model limits or unsupported driving-video inputs refuse before payment. Clips remain video references rather than sampled pictures. Empty attachmentIds clears the selection; identical retries reconcile the same write.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"revisionId",
"shotId",
"expectedRevisionId",
"attachmentIds",
"rightsConfirmed"
],
"properties": {
"shotId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The stable shot ID from that board."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The current owned project."
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The exact current storyboard revision."
},
"attachmentIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Owned original video attachment."
},
"maxItems": 3,
"uniqueItems": true
},
"rightsConfirmed": {
"type": "boolean",
"const": true
},
"expectedRevisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The exact current storyboard revision."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"changed",
"revisionId",
"revision",
"references",
"use"
],
"properties": {
"use": {
"enum": [
"driving_video"
]
},
"changed": {
"type": "boolean"
},
"revision": {
"type": "number"
},
"references": {
"type": "array",
"items": {
"type": "object",
"required": [
"attachmentId",
"assetId",
"contentHash",
"durationMs",
"width",
"height",
"fps",
"approvedBy"
],
"properties": {
"fps": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"assetId": {
"type": "string"
},
"approvedBy": {
"type": "string"
},
"durationMs": {
"type": "number"
},
"contentHash": {
"type": "string"
},
"attachmentId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Choose shot video references",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns an owned completed creative result by operationId with image.url or video.url, downloadUrl and gallery-widget data. Links are private and signed; another read refreshes expired links. The original source is retained. No processing or charge is repeated.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | The current owned project. |
| operationId * | string | Quoted operation ID. |
{
"name": "studio_creative_result",
"title": "Read the finished creative result",
"description": "Returns an owned completed creative result by operationId with image.url or video.url, downloadUrl and gallery-widget data. Links are private and signed; another read refreshes expired links. The original source is retained. No processing or charge is repeated.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The current owned project."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Quoted operation ID."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"required": [
"kind",
"resultId",
"result"
]
},
{
"required": [
"kind",
"assetId",
"url",
"mimeType",
"view",
"items"
]
},
{
"required": [
"code",
"message"
]
}
],
"properties": {
"url": {
"type": "string"
},
"code": {
"type": "string"
},
"kind": {
"enum": [
"media",
"text"
]
},
"note": {
"type": "string"
},
"view": {
"const": "gallery"
},
"image": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
}
},
"items": {
"type": "array",
"items": {
"type": "object"
}
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
}
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"result": {
"type": "object",
"required": [
"version",
"variations"
],
"properties": {
"version": {
"const": 1
},
"variations": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"assetId": {
"type": "string"
},
"message": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"resultId": {
"type": "string"
},
"projectId": {
"type": "string"
},
"contentHash": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"mediaOrigin": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
},
"annotations": {
"title": "Read the finished creative result",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Saves finished customer-authored headline/caption drafts and supporting source facts as a free text version. Identical source/revision/result inputs return the saved version. No Brix36 language-model request, publishing or credit charge.
| Parameter | Type | Description |
|---|---|---|
| result * | object | |
| projectId * | string | The current owned project. |
| sourceText * | string | Exact customer-supplied source facts supporting the draft. |
| finishedAssetId | string | Optional completed master the text accompanies. |
| expectedRevision * | integer | Current project revision. A stale revision returns revision_conflict. |
{
"name": "studio_copy_save",
"title": "Save my AI’s text variations",
"description": "Saves finished customer-authored headline/caption drafts and supporting source facts as a free text version. Identical source/revision/result inputs return the saved version. No Brix36 language-model request, publishing or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"expectedRevision",
"sourceText",
"result"
],
"properties": {
"result": {
"type": "object",
"required": [
"version",
"variations"
],
"properties": {
"version": {
"type": "integer",
"const": 1
},
"variations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "An exact customer-AI-authored draft."
},
"maxItems": 8,
"minItems": 1
}
},
"additionalProperties": false
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The current owned project."
},
"sourceText": {
"type": "string",
"maxLength": 8000,
"minLength": 1,
"description": "Exact customer-supplied source facts supporting the draft."
},
"finishedAssetId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Optional completed master the text accompanies."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "Current project revision. A stale revision returns revision_conflict."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"projectRevision",
"origin",
"result",
"changed"
],
"properties": {
"id": {
"type": "string"
},
"origin": {
"enum": [
"customer_ai"
]
},
"result": {
"type": "object",
"required": [
"version",
"variations"
],
"properties": {
"version": {
"enum": [
1
]
},
"variations": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"changed": {
"type": "boolean"
},
"projectRevision": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Save my AI’s text variations",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read an owned saved customer-AI text version without generating or charging.
| Parameter | Type | Description |
|---|---|---|
| copyId * | string | Saved copy version. |
| projectId * | string | The current owned project. |
{
"name": "studio_copy_read",
"title": "Read saved text variations",
"description": "Read an owned saved customer-AI text version without generating or charging.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"copyId"
],
"properties": {
"copyId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Saved copy version."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The current owned project."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"projectRevision",
"origin",
"result",
"createdAt"
],
"properties": {
"id": {
"type": "string"
},
"origin": {
"enum": [
"customer_ai"
]
},
"result": {
"type": "object",
"required": [
"version",
"variations"
],
"properties": {
"version": {
"enum": [
1
]
},
"variations": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"createdAt": {
"type": "string"
},
"projectRevision": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read saved text variations",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Prices one standalone picture from a text prompt and optional owned uploads, using the same pricing as the Brix36 create box. Returns the exact credits and price with draftId and quoteId. Nothing is generated or charged.
| Parameter | Type | Description |
|---|---|---|
| prompt * | string | What the picture should show, in the customer's words. |
| draftId | string | Stable draft ID for this picture. Optional when pricing; the price returns one. Reusing it with changed details reprices the same draft. |
| artistId | string | Optional Artist DNA ID when the picture stars an existing artist. |
| modelKey | string | Optional picture model identifier or display name when a specific engine is requested. |
| profileKey | string | Optional picture profile or quality tier when requested. |
| aspectRatio | string | Optional picture aspect ratio. |
| attachmentIds | array | Optional owned uploaded pictures that guide the result. |
{
"name": "studio_image_quote",
"title": "Price a picture",
"description": "Prices one standalone picture from a text prompt and optional owned uploads, using the same pricing as the Brix36 create box. Returns the exact credits and price with draftId and quoteId. Nothing is generated or charged.",
"inputSchema": {
"type": "object",
"required": [
"prompt"
],
"properties": {
"prompt": {
"type": "string",
"maxLength": 100000,
"minLength": 1,
"description": "What the picture should show, in the customer's words."
},
"draftId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Stable draft ID for this picture. Optional when pricing; the price returns one. Reusing it with changed details reprices the same draft."
},
"artistId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Optional Artist DNA ID when the picture stars an existing artist."
},
"modelKey": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Optional picture model identifier or display name when a specific engine is requested."
},
"profileKey": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Optional picture profile or quality tier when requested."
},
"aspectRatio": {
"enum": [
"1:1",
"16:9",
"9:16",
"4:5",
"4:3",
"3:4",
"3:2",
"2:3",
"21:9"
],
"type": "string",
"description": "Optional picture aspect ratio."
},
"attachmentIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Owned uploaded picture ID."
},
"maxItems": 64,
"description": "Optional owned uploaded pictures that guide the result.",
"uniqueItems": true
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"draftId",
"quoteId",
"available",
"vatInclusive",
"expiresAt",
"note"
],
"properties": {
"note": {
"type": "string"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind",
"label",
"amountMinor"
],
"properties": {
"kind": {
"type": "string"
},
"label": {
"type": "string"
},
"amountMinor": {
"type": "number"
}
},
"additionalProperties": true
}
},
"reason": {
"type": "string"
},
"credits": {
"type": "number"
},
"draftId": {
"type": "string"
},
"quoteId": {
"type": "string"
},
"gbpMinor": {
"type": "number"
},
"available": {
"type": "boolean"
},
"expiresAt": {
"type": "string"
},
"confirmWith": {
"type": "object",
"required": [
"draftId",
"quoteId"
],
"properties": {
"draftId": {
"type": "string"
},
"quoteId": {
"type": "string"
}
},
"additionalProperties": true
},
"vatInclusive": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Price a picture",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Spends Brix36 credits and starts one picture under the customer's financial approval of the exact quoted draftId and quoteId. Identical retries return the same operation without another charge.
| Parameter | Type | Description |
|---|---|---|
| draftId * | string | Exact draftId returned with the picture price. |
| quoteId * | string | Exact quoteId returned with the picture price. |
| confirmationToken | string | Customer-issued approval code, when the customer has one. |
{
"name": "studio_image_confirm",
"title": "Make the approved picture",
"description": "Spends Brix36 credits and starts one picture under the customer's financial approval of the exact quoted draftId and quoteId. Identical retries return the same operation without another charge.",
"inputSchema": {
"type": "object",
"required": [
"draftId",
"quoteId"
],
"properties": {
"draftId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Exact draftId returned with the picture price."
},
"quoteId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Exact quoteId returned with the picture price."
},
"confirmationToken": {
"type": "string",
"maxLength": 4096,
"minLength": 1,
"description": "Customer-issued approval code, when the customer has one."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"draftId",
"quoteId",
"operationId",
"state",
"chargedCredits",
"settlement",
"note"
],
"properties": {
"note": {
"type": "string"
},
"state": {
"enum": [
"accepted",
"queued",
"submitting",
"running",
"reconciling",
"succeeded",
"failed",
"cancelled"
]
},
"draftId": {
"type": "string"
},
"quoteId": {
"type": "string"
},
"settlement": {
"enum": [
"not_charged",
"debited",
"refunded",
"review"
]
},
"operationId": {
"type": "string"
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Make the approved picture",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Returns the owned picture for an approved quoteId with image.url, downloadUrl and gallery-widget data once ready, or its current progress. Links are private and signed; another read refreshes them. No processing or charge is repeated.
| Parameter | Type | Description |
|---|---|---|
| quoteId * | string | Exact quoteId returned with the picture price. |
{
"name": "studio_image_result",
"title": "Read the finished picture",
"description": "Returns the owned picture for an approved quoteId with image.url, downloadUrl and gallery-widget data once ready, or its current progress. Links are private and signed; another read refreshes them. No processing or charge is repeated.",
"inputSchema": {
"type": "object",
"required": [
"quoteId"
],
"properties": {
"quoteId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Exact quoteId returned with the picture price."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"quoteId",
"operationId",
"state",
"settlement",
"chargedCredits",
"ready",
"view",
"items",
"note"
],
"properties": {
"note": {
"type": "string"
},
"view": {
"enum": [
"gallery"
]
},
"image": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"mimeType": {
"type": "string"
}
},
"additionalProperties": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind",
"assetId",
"url",
"mimeType",
"title"
],
"properties": {
"url": {
"type": "string"
},
"kind": {
"enum": [
"image",
"video"
]
},
"title": {
"type": "string"
},
"assetId": {
"type": "string"
},
"mimeType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"ready": {
"type": "boolean"
},
"state": {
"enum": [
"accepted",
"queued",
"submitting",
"running",
"reconciling",
"succeeded",
"failed",
"cancelled"
]
},
"failure": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
},
"quoteId": {
"type": "string"
},
"progress": {
"type": "number"
},
"settlement": {
"enum": [
"not_charged",
"debited",
"refunded",
"review"
]
},
"downloadUrl": {
"type": "string"
},
"operationId": {
"type": "string"
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read the finished picture",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Prices one standalone video clip or talking video from a prompt or script and optional owned uploads, using the same pricing as the Brix36 create box. kind clip is a video clip from the prompt; kind talking is a person speaking that audio, and needs the audio upload plus a picture, a video or an existing artist. Returns the exact credits and price with draftId and quoteId, the model and the shape and length the price includes when those are part of it, and whether a price is available. Nothing is generated or charged. The prompt for a clip reads as a shot and describes its sound: the place's few sounds and their distance, the action's sounds at their beats, music only when asked for or for an advert, trailer or reel, and an ending that settles and holds to the last frame unless the last beat is a deliberate hit.
| Parameter | Type | Description |
|---|---|---|
| kind * | string | clip for a video clip, or talking for a person speaking uploaded audio. |
| shape | string | Optional shape such as 16:9, 9:16 or 1:1 when the chosen model offers a shape setting. |
| sound | object | Optional music, effects and background for this clip. |
| prompt * | string | What the video should show, or the script in the customer's words. |
| draftId | string | Stable draft ID for this video. Optional when pricing; the price returns one. Reusing it with changed details reprices the same draft. |
| artistId | string | Optional Artist DNA ID when the video stars an existing artist or character. |
Spends Brix36 credits and starts one custom video under the customer's financial approval of the exact quoted draftId and quoteId. Identical retries return the same operation without another charge.
| Parameter | Type | Description |
|---|---|---|
| draftId * | string | Exact draftId returned with the video price. |
| quoteId * | string | Exact quoteId returned with the video price. |
| confirmationToken | string | Customer-issued approval code, when the customer has one. |
{
"name": "studio_custom_video_confirm",
"title": "Make the approved custom video",
"description": "Spends Brix36 credits and starts one custom video under the customer's financial approval of the exact quoted draftId and quoteId. Identical retries return the same operation without another charge.",
"inputSchema": {
"type": "object",
"required": [
"draftId",
"quoteId"
],
"properties": {
"draftId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Exact draftId returned with the video price."
},
"quoteId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Exact quoteId returned with the video price."
},
"confirmationToken": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 4096,
"minLength": 1,
"description": "Customer-issued approval code, when the customer has one."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"draftId",
"quoteId",
"operationId",
"state",
"chargedCredits",
"settlement",
"note"
],
"properties": {
"note": {
"type": "string"
},
"state": {
"enum": [
"accepted",
"queued",
"submitting",
"running",
"reconciling",
"succeeded",
"failed",
"cancelled"
]
},
"draftId": {
"type": "string"
},
"quoteId": {
"type": "string"
},
"settlement": {
"enum": [
"not_charged",
"debited",
"refunded",
"review"
]
},
"operationId": {
"type": "string"
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Make the approved custom video",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Returns the owned custom video or talking video for an approved quoteId with video.url, downloadUrl and gallery-widget data once ready, or its current progress. Links are private and signed; a link stays valid for a while and a later read gives a fresh one. No processing or charge is repeated.
| Parameter | Type | Description |
|---|---|---|
| quoteId * | string | Exact quoteId returned with the video price. |
{
"name": "studio_custom_video_result",
"title": "Read the finished custom video",
"description": "Returns the owned custom video or talking video for an approved quoteId with video.url, downloadUrl and gallery-widget data once ready, or its current progress. Links are private and signed; a link stays valid for a while and a later read gives a fresh one. No processing or charge is repeated.",
"inputSchema": {
"type": "object",
"required": [
"quoteId"
],
"properties": {
"quoteId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Exact quoteId returned with the video price."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"quoteId",
"operationId",
"state",
"settlement",
"chargedCredits",
"ready",
"view",
"items",
"note"
],
"properties": {
"note": {
"type": "string"
},
"view": {
"enum": [
"gallery"
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind",
"assetId",
"url",
"mimeType",
"title"
],
"properties": {
"url": {
"type": "string"
},
"kind": {
"enum": [
"image",
"video"
]
},
"title": {
"type": "string"
},
"assetId": {
"type": "string"
},
"mimeType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"ready": {
"type": "boolean"
},
"state": {
"enum": [
"accepted",
"queued",
"submitting",
"running",
"reconciling",
"succeeded",
"failed",
"cancelled"
]
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"mimeType": {
"type": "string"
}
},
"additionalProperties": true
},
"failure": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
},
"quoteId": {
"type": "string"
},
"progress": {
"type": "number"
},
"settlement": {
"enum": [
"not_charged",
"debited",
"refunded",
"review"
]
},
"downloadUrl": {
"type": "string"
},
"operationId": {
"type": "string"
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read the finished custom video",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Reads the public product page at one HTTPS link and returns its name, description, advertised price and currency, offer text, domain, brand colour and picture candidates (addresses only), or read false when the page cannot be read. Reads only: no project, storyboard, generation or charge is created. No picture is saved. A page may list several products or options; the customer must choose which one is the advert's product. A price in another currency is kept in that currency and is not converted. When all readable offers use one currency and have different prices, priceIsFrom is true, priceRange gives their lowest and highest (an open upper end is null), and priceMinor is empty. Mixed currencies set mixedCurrencies true and priceIsFrom false, with no single price or priceRange; individual variants keep their own currencies. Unreadable or conflicting prices never become an exact price. Up to 100 products and 100 variant rows are displayed. candidateCount/candidatesMore and variantCount/variantsMore state the totals and whether rows were omitted; offerCount/offersMore report offer objects and whether some have no individual displayed row. Candidates list no individual offer rows, so their offersMore is true when any offers exist.
| Parameter | Type | Description |
|---|---|---|
| productUrl * | string | The public HTTPS product page link to read. |
{
"name": "studio_product_link_read",
"title": "Read a product page link",
"description": "Reads the public product page at one HTTPS link and returns its name, description, advertised price and currency, offer text, domain, brand colour and picture candidates (addresses only), or read false when the page cannot be read. Reads only: no project, storyboard, generation or charge is created. No picture is saved. A page may list several products or options; the customer must choose which one is the advert's product. A price in another currency is kept in that currency and is not converted. When all readable offers use one currency and have different prices, priceIsFrom is true, priceRange gives their lowest and highest (an open upper end is null), and priceMinor is empty. Mixed currencies set mixedCurrencies true and priceIsFrom false, with no single price or priceRange; individual variants keep their own currencies. Unreadable or conflicting prices never become an exact price. Up to 100 products and 100 variant rows are displayed. candidateCount/candidatesMore and variantCount/variantsMore state the totals and whether rows were omitted; offerCount/offersMore report offer objects and whether some have no individual displayed row. Candidates list no individual offer rows, so their offersMore is true when any offers exist.",
"inputSchema": {
"type": "object",
"required": [
"productUrl"
],
"properties": {
"productUrl": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"description": "The public HTTPS product page link to read."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"read"
],
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"note": {
"type": "string"
},
"read": {
"type": "boolean"
},
"image": {
"anyOf": [
{
"type": "object",
"required": [
"assetId",
"state"
],
"properties": {
"state": {
"enum": [
"passed",
"pending",
"failed",
"review"
]
},
"assetId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"domain": {
"type": [
"string",
"null"
]
},
"images": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"reason": {
"anyOf": [
{
"enum": [
"not_public_address",
"not_found",
"timed_out",
"too_large",
"blocked_by_site",
"needs_sign_in",
"needs_browser",
"not_a_product_page",
"several_products",
"unreadable"
]
},
{
"type": "null"
}
]
},
"currency": {
"type": [
"string",
"null"
]
},
"variants": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"availability"
],
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"options": {
"type": [
"string",
"null"
]
},
"currency": {
"type": [
"string",
"null"
]
},
"imageUrl": {
"type": [
"string",
"null"
]
},
"priceText": {
"type": [
"string",
"null"
]
},
"priceMinor": {
"type": [
"number",
"null"
]
},
"availability": {
"anyOf": [
{
"enum": [
"in_stock",
"out_of_stock",
"pre_order",
"discontinued",
"unknown"
]
},
{
"type": "null"
}
]
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
]
},
"offerText": {
"type": [
"string",
"null"
]
},
"priceText": {
"type": [
"string",
"null"
]
},
"candidates": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"currency": {
"type": [
"string",
"null"
]
},
"imageUrl": {
"type": [
"string",
"null"
]
},
"priceText": {
"type": [
"string",
"null"
]
},
"offerCount": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"offersMore": {
"type": [
"boolean",
"null"
]
},
"priceMinor": {
"type": [
"number",
"null"
]
},
"priceRange": {
"anyOf": [
{
"type": "object",
"required": [],
"properties": {
"low": {
"type": [
"number",
"null"
]
},
"high": {
"type": [
"number",
"null"
]
},
"currency": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"productUrl": {
"type": [
"string",
"null"
]
},
"priceIsFrom": {
"type": [
"boolean",
"null"
]
},
"availability": {
"anyOf": [
{
"enum": [
"in_stock",
"out_of_stock",
"pre_order",
"discontinued",
"unknown"
]
},
{
"type": "null"
}
]
},
"mixedCurrencies": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": true
}
},
{
"type": "null"
}
]
},
"offerCount": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"offersMore": {
"type": [
"boolean",
"null"
]
},
"priceMinor": {
"type": [
"number",
"null"
]
},
"priceRange": {
"anyOf": [
{
"type": "object",
"required": [],
"properties": {
"low": {
"type": [
"number",
"null"
]
},
"high": {
"type": [
"number",
"null"
]
},
"currency": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"brandColour": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"priceIsFrom": {
"type": [
"boolean",
"null"
]
},
"availability": {
"anyOf": [
{
"enum": [
"in_stock",
"out_of_stock",
"pre_order",
"discontinued",
"unknown"
]
},
{
"type": "null"
}
]
},
"variantCount": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"variantsMore": {
"type": [
"boolean",
"null"
]
},
"pictureReason": {
"type": [
"string",
"null"
]
},
"candidateCount": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"candidatesMore": {
"type": [
"boolean",
"null"
]
},
"mixedCurrencies": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read a product page link",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Pin this artist’s currently published DNA to this project once, within its existing pin window. Read project state after a lost response before retrying. No generation or charge.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
{
"name": "studio_project_dna_pin",
"title": "Pin current Artist DNA to a project",
"description": "Pin this artist’s currently published DNA to this project once, within its existing pin window. Read project state after a lost response before retrying. No generation or charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"action",
"identityPack"
],
"properties": {
"action": {
"enum": [
"pin_current_dna"
]
},
"projectId": {
"type": "string"
},
"identityPack": {
"type": "object",
"required": [
"pinned",
"packId",
"version",
"publishedPackAvailable"
],
"properties": {
"packId": {
"type": [
"string",
"null"
]
},
"pinned": {
"type": "boolean"
},
"version": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publishedPackAvailable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"projectId",
"action",
"artistPresence"
],
"properties": {
"action": {
"enum": [
"featured",
"not_featured"
]
},
"projectId": {
"type": "string"
},
"artistPresence": {
"enum": [
"featured",
"not_featured"
]
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Pin current Artist DNA to a project",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Set featured or not_featured for this project. Featured requires pinned DNA; the existing directed-storyboard rules still apply. No generation or charge.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | Project ID returned by studio_projects_list or studio_video_start. |
| artistPresence * | string | one of ["featured","not_featured"] |
{
"name": "studio_project_artist_presence_set",
"title": "Set whether the artist appears in a video",
"description": "Set featured or not_featured for this project. Featured requires pinned DNA; the existing directed-storyboard rules still apply. No generation or charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"artistPresence"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
},
"artistPresence": {
"enum": [
"featured",
"not_featured"
],
"type": "string"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"action",
"identityPack"
],
"properties": {
"action": {
"enum": [
"pin_current_dna"
]
},
"projectId": {
"type": "string"
},
"identityPack": {
"type": "object",
"required": [
"pinned",
"packId",
"version",
"publishedPackAvailable"
],
"properties": {
"packId": {
"type": [
"string",
"null"
]
},
"pinned": {
"type": "boolean"
},
"version": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publishedPackAvailable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"projectId",
"action",
"artistPresence"
],
"properties": {
"action": {
"enum": [
"featured",
"not_featured"
]
},
"projectId": {
"type": "string"
},
"artistPresence": {
"enum": [
"featured",
"not_featured"
]
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Set whether the artist appears in a video",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Set the saved-character or native speech voice choice for one character in one scene. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.
| Parameter | Type | Description |
|---|---|---|
| artistId * | string | A speaking cast character in this Film. |
| projectId * | string | The Film project id. |
| sceneIndex * | integer | The saved scene index from studio_film_read. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| expectedRevision * | integer | The savedPlan.revision from studio_film_read. |
| voiceDescription | string | Optional native voice direction. |
| useCharacterVoice * | boolean | The customer’s voice choice for this scene and character: true selects the saved voice; false selects native video-model speech. |
Replace one scene’s direction and reference pictures. A null sceneIndex with empty text binds whole-Film references. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.
| Parameter | Type | Description |
|---|---|---|
| text * | string | |
| projectId * | string | The Film project id. |
| sceneIndex * | ["integer","null"] | |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| expectedRevision * | integer | The savedPlan.revision from studio_film_read. |
| referenceAttachmentIds * | array |
{
"name": "studio_film_direction_set",
"title": "Set Film direction and reference pictures",
"description": "Replace one scene’s direction and reference pictures. A null sceneIndex with empty text binds whole-Film references. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision",
"sceneIndex",
"text",
"referenceAttachmentIds"
],
"properties": {
"text": {
"type": "string",
"maxLength": 2000
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"sceneIndex": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "The savedPlan.revision from studio_film_read."
},
"referenceAttachmentIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "An attachment id belonging to this project."
},
"maxItems": 8,
"uniqueItems": true
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"revisionId"
],
"properties": {
"lineId": {
"type": "string"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Set Film direction and reference pictures",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Assign one available artist to one saved dialogue line. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.
| Parameter | Type | Description |
|---|---|---|
| lineId * | string | The saved dialogue line id from studio_film_read. |
| artistId * | string | An available artist in this project’s workspace. |
| projectId * | string | The Film project id. |
| sceneIndex * | integer | The saved scene index from studio_film_read. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| expectedRevision * | integer | The savedPlan.revision from studio_film_read. |
{
"name": "studio_film_assign_actor",
"title": "Assign a Film dialogue actor",
"description": "Assign one available artist to one saved dialogue line. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision",
"sceneIndex",
"lineId",
"artistId"
],
"properties": {
"lineId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The saved dialogue line id from studio_film_read."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "An available artist in this project’s workspace."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"sceneIndex": {
"type": "integer",
"minimum": 0,
"description": "The saved scene index from studio_film_read."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "The savedPlan.revision from studio_film_read."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"revisionId"
],
"properties": {
"lineId": {
"type": "string"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Assign a Film dialogue actor",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Add one finished dialogue line to a scene and return its lineId. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.
| Parameter | Type | Description |
|---|---|---|
| text * | string | The finished dialogue line. |
| projectId * | string | The Film project id. |
| sceneIndex * | integer | The saved scene index from studio_film_read. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| expectedRevision * | integer | The savedPlan.revision from studio_film_read. |
{
"name": "studio_film_add_line",
"title": "Add a Film dialogue line",
"description": "Add one finished dialogue line to a scene and return its lineId. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision",
"sceneIndex",
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 4000,
"minLength": 1,
"description": "The finished dialogue line."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"sceneIndex": {
"type": "integer",
"minimum": 0,
"description": "The saved scene index from studio_film_read."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "The savedPlan.revision from studio_film_read."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"revisionId"
],
"properties": {
"lineId": {
"type": "string"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Add a Film dialogue line",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Replace the text of one saved dialogue line. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.
| Parameter | Type | Description |
|---|---|---|
| text * | string | The finished replacement dialogue line. |
| lineId * | string | The saved dialogue line id from studio_film_read. |
| projectId * | string | The Film project id. |
| sceneIndex * | integer | The saved scene index from studio_film_read. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| expectedRevision * | integer | The savedPlan.revision from studio_film_read. |
{
"name": "studio_film_edit_line",
"title": "Replace a Film dialogue line",
"description": "Replace the text of one saved dialogue line. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision",
"sceneIndex",
"lineId",
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 4000,
"minLength": 1,
"description": "The finished replacement dialogue line."
},
"lineId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The saved dialogue line id from studio_film_read."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"sceneIndex": {
"type": "integer",
"minimum": 0,
"description": "The saved scene index from studio_film_read."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "The savedPlan.revision from studio_film_read."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"revisionId"
],
"properties": {
"lineId": {
"type": "string"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Replace a Film dialogue line",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Remove one saved dialogue line. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.
| Parameter | Type | Description |
|---|---|---|
| lineId * | string | The saved dialogue line id from studio_film_read. |
| projectId * | string | The Film project id. |
| sceneIndex * | integer | The saved scene index from studio_film_read. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| expectedRevision * | integer | The savedPlan.revision from studio_film_read. |
{
"name": "studio_film_remove_line",
"title": "Remove a Film dialogue line",
"description": "Remove one saved dialogue line. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision",
"sceneIndex",
"lineId"
],
"properties": {
"lineId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The saved dialogue line id from studio_film_read."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"sceneIndex": {
"type": "integer",
"minimum": 0,
"description": "The saved scene index from studio_film_read."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "The savedPlan.revision from studio_film_read."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"revisionId"
],
"properties": {
"lineId": {
"type": "string"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Remove a Film dialogue line",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Toggle whether one dialogue line’s speaker is on camera. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.
| Parameter | Type | Description |
|---|---|---|
| lineId * | string | The saved dialogue line id from studio_film_read. |
| projectId * | string | The Film project id. |
| sceneIndex * | integer | The saved scene index from studio_film_read. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| expectedRevision * | integer | The savedPlan.revision from studio_film_read. |
{
"name": "studio_film_toggle_camera",
"title": "Toggle a Film speaker’s visibility",
"description": "Toggle whether one dialogue line’s speaker is on camera. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision",
"sceneIndex",
"lineId"
],
"properties": {
"lineId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The saved dialogue line id from studio_film_read."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"sceneIndex": {
"type": "integer",
"minimum": 0,
"description": "The saved scene index from studio_film_read."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "The savedPlan.revision from studio_film_read."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"revisionId"
],
"properties": {
"lineId": {
"type": "string"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Toggle a Film speaker’s visibility",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Toggle one Film music, background or effects layer. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.
| Parameter | Type | Description |
|---|---|---|
| layer * | string | one of ["music","background","effects"] |
| projectId * | string | The Film project id. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| expectedRevision * | integer | The savedPlan.revision from studio_film_read. |
{
"name": "studio_film_toggle_sound",
"title": "Toggle a Film sound layer",
"description": "Toggle one Film music, background or effects layer. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision",
"layer"
],
"properties": {
"layer": {
"enum": [
"music",
"background",
"effects"
],
"type": "string"
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "The savedPlan.revision from studio_film_read."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"revisionId"
],
"properties": {
"lineId": {
"type": "string"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Toggle a Film sound layer",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Set the lip-sync choice for one saved scene. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.
| Parameter | Type | Description |
|---|---|---|
| choice * | ["null","string"] | one of ["on","off",null] |
| sceneId * | string | The stableSceneId from studio_film_read. |
| projectId * | string | The Film project id. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| expectedRevision * | integer | The savedPlan.revision from studio_film_read. |
{
"name": "studio_film_set_lip_sync",
"title": "Set Film scene lip sync",
"description": "Set the lip-sync choice for one saved scene. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision",
"sceneId",
"choice"
],
"properties": {
"choice": {
"enum": [
"on",
"off",
null
],
"type": [
"null",
"string"
]
},
"sceneId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The stableSceneId from studio_film_read."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "The savedPlan.revision from studio_film_read."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"revisionId"
],
"properties": {
"lineId": {
"type": "string"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Set Film scene lip sync",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Set one scene’s duration, normalized to 4–30 seconds; later scenes move to follow it. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | The Film project id. |
| durationMs * | integer | How long this scene lasts, in milliseconds. Brought onto the 4-30 second range, in whole seconds; later scenes move to follow it and the quote prices the new length. |
| sceneIndex * | integer | The saved scene index from studio_film_read. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| expectedRevision * | integer | The savedPlan.revision from studio_film_read. |
{
"name": "studio_film_set_duration",
"title": "Set Film scene duration",
"description": "Set one scene’s duration, normalized to 4–30 seconds; later scenes move to follow it. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision",
"sceneIndex",
"durationMs"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"durationMs": {
"type": "integer",
"maximum": 600000,
"minimum": 1,
"description": "How long this scene lasts, in milliseconds. Brought onto the 4-30 second range, in whole seconds; later scenes move to follow it and the quote prices the new length."
},
"sceneIndex": {
"type": "integer",
"minimum": 0,
"description": "The saved scene index from studio_film_read."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "The savedPlan.revision from studio_film_read."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"revisionId"
],
"properties": {
"lineId": {
"type": "string"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Set Film scene duration",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Set one storyboard shot’s video engine, camera movement, lens, lighting or look; unnamed controls keep their saved values. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.
| Parameter | Type | Description |
|---|---|---|
| direction * | object | Only the controls to change; the others keep their saved values. |
| projectId * | string | The Film project id. |
| operationId * | string | Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier. |
| stableShotId * | string | The storyboard stableShotId for the scene, from studio_storyboard_readiness. |
| expectedRevision * | integer | The savedPlan.revision from studio_film_read. |
{
"name": "studio_film_set_shot_direction",
"title": "Set a Film shot’s engine and direction",
"description": "Set one storyboard shot’s video engine, camera movement, lens, lighting or look; unnamed controls keep their saved values. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision",
"stableShotId",
"direction"
],
"properties": {
"direction": {
"type": "object",
"required": [],
"properties": {
"lens": {
"enum": [
"auto",
"wide_24mm",
"natural_35mm",
"portrait_50mm",
"telephoto_85mm",
"anamorphic"
],
"type": "string"
},
"look": {
"enum": [
"auto",
"cinematic",
"documentary",
"film_noir",
"vintage",
"vivid"
],
"type": "string"
},
"engine": {
"enum": [
"auto",
"seedance_2_5",
"minimax_h3",
"kling_v4",
"kling_o3",
"wan_3"
],
"type": "string",
"description": "The exact video engine for this shot; kling_v4 carries native sound when a sound layer is on. auto lets Brix36 choose."
},
"lighting": {
"enum": [
"auto",
"natural",
"soft_studio",
"golden_hour",
"low_key",
"neon"
],
"type": "string"
},
"cameraMovement": {
"enum": [
"auto",
"locked",
"pan",
"tilt",
"dolly_in",
"dolly_out",
"tracking",
"handheld",
"orbit"
],
"type": "string"
}
},
"description": "Only the controls to change; the others keep their saved values.",
"minProperties": 1,
"additionalProperties": false
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"stableShotId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The storyboard stableShotId for the scene, from studio_storyboard_readiness."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "The savedPlan.revision from studio_film_read."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"revisionId"
],
"properties": {
"lineId": {
"type": "string"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Set a Film shot’s engine and direction",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Read the exact authored scene and revision, including editable lyric cue timing, text and owned media layers.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| documentId * | string |
{
"name": "studio_motion_read",
"title": "Read Motion scene",
"description": "Read the exact authored scene and revision, including editable lyric cue timing, text and owned media layers.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"documentId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"documentId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"documentId",
"projectId",
"revisionId",
"revision",
"sceneDigest",
"scene"
],
"properties": {
"scene": {
"anyOf": [
{
"type": "object",
"required": [
"version",
"family",
"fps",
"durationFrames",
"output",
"background",
"palette",
"layers"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"audio": {
"type": "object",
"required": [
"assetId",
"sourceStartFrame",
"volume"
],
"properties": {
"volume": {
"type": "number"
},
"assetId": {
"type": "string"
},
"sourceStartFrame": {
"type": "number"
}
},
"additionalProperties": true
},
"family": {
"enum": [
"lyric_video",
"beat_visualiser",
"photo_poster",
"promo_cards",
"titles",
"kinetic_text",
"captions",
"logo_animation",
"charts",
"slides",
"lower_thirds"
]
},
"layers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"text"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"role": {
"enum": [
"title",
"credit",
"endcard",
"kinetic",
"lower_third"
]
},
"text": {
"type": "string"
},
"type": {
"enum": [
"text"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"cues"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"cues": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"role": {
"enum": [
"lyrics",
"captions"
]
},
"type": {
"enum": [
"cues"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"role",
"assetId",
"sourceStartFrame",
"fit"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"fit": {
"enum": [
"contain",
"cover"
]
},
"role": {
"enum": [
"logo",
"image",
"clip"
]
},
"type": {
"enum": [
"media"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"assetId": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"sourceStartFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"chart",
"title",
"series"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"chart"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"chart": {
"enum": [
"bar",
"line",
"pie"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"series": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value",
"color"
],
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"title",
"body",
"accent"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"body": {
"type": "string"
},
"type": {
"enum": [
"slide"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"accent": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"style",
"color"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"visualiser"
]
},
"color": {
"type": "string"
},
"style": {
"enum": [
"bars",
"waves",
"particles",
"ring"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"enum": [
1
]
},
"background": {
"type": "string"
},
"durationFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"version",
"family",
"fps",
"durationFrames",
"output",
"background",
"palette",
"layers",
"recipe"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"audio": {
"type": "object",
"required": [
"assetId",
"sourceStartFrame",
"volume"
],
"properties": {
"volume": {
"type": "number"
},
"assetId": {
"type": "string"
},
"sourceStartFrame": {
"type": "number"
}
},
"additionalProperties": true
},
"family": {
"enum": [
"lyric_video",
"beat_visualiser",
"photo_poster",
"promo_cards",
"titles",
"kinetic_text",
"captions",
"logo_animation",
"charts",
"slides",
"lower_thirds"
]
},
"layers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"text"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"role": {
"enum": [
"title",
"credit",
"endcard",
"kinetic",
"lower_third"
]
},
"text": {
"type": "string"
},
"type": {
"enum": [
"text"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"cues"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"cues": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"role": {
"enum": [
"lyrics",
"captions"
]
},
"type": {
"enum": [
"cues"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"role",
"assetId",
"sourceStartFrame",
"fit"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"fit": {
"enum": [
"contain",
"cover"
]
},
"role": {
"enum": [
"logo",
"image",
"clip"
]
},
"type": {
"enum": [
"media"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"assetId": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"sourceStartFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"chart",
"title",
"series"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"chart"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"chart": {
"enum": [
"bar",
"line",
"pie"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"series": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value",
"color"
],
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"title",
"body",
"accent"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"body": {
"type": "string"
},
"type": {
"enum": [
"slide"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"accent": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"style",
"color"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"visualiser"
]
},
"color": {
"type": "string"
},
"style": {
"enum": [
"bars",
"waves",
"particles",
"ring"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"recipe": {
"type": "object",
"required": [
"id",
"version",
"lookId",
"lookVersion",
"engine",
"fontId",
"fontHash",
"artistId",
"artistRevision",
"artistDigest",
"featureDigest",
"featureVersion",
"sources",
"intensity"
],
"properties": {
"id": {
"enum": [
"lyric_video",
"audio_visualiser",
"living_cover",
"kinetic_type",
"club_tunnel",
"organic_landscape"
]
},
"engine": {
"enum": [
"ffmpeg-templates.v1"
]
},
"fontId": {
"type": "string"
},
"lookId": {
"enum": [
"pop",
"hiphop_drill",
"rnb",
"house_edm",
"rock",
"country_acoustic",
"afrobeats"
]
},
"sources": {
"type": "array",
"items": {
"type": "object",
"required": [
"assetId",
"hash"
],
"properties": {
"hash": {
"type": "string"
},
"assetId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"version": {
"enum": [
1
]
},
"artistId": {
"type": "string"
},
"fontHash": {
"type": "string"
},
"intensity": {
"enum": [
"subtle",
"standard"
]
},
"alignmentId": {
"type": "string"
},
"lookVersion": {
"enum": [
1
]
},
"artistDigest": {
"type": "string"
},
"alignmentHash": {
"type": "string"
},
"featureDigest": {
"type": "string"
},
"artistRevision": {
"type": "number"
},
"featureVersion": {
"enum": [
"audio-window.v1"
]
}
},
"additionalProperties": true
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"enum": [
2
]
},
"background": {
"type": "string"
},
"durationFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
},
"revision": {
"type": "number"
},
"projectId": {
"type": "string"
},
"documentId": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"sceneDigest": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read Motion scene",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Saves typed MotionSceneV1 with exact words, cue frame ranges and owned asset IDs. Accepts typed layers and approved fonts; HTML, JS, CSS and URLs are not scene inputs. First save creates an opaque documentId with expectedRevision 0; edits bind the current expectedRevision. Conflicts preserve the newer saved version. No Brix36 language model is called.
| Parameter | Type | Description |
|---|---|---|
| scene * | object | |
| projectId * | string | |
| documentId | string | |
| expectedRevision | integer |
{
"name": "studio_motion_update",
"title": "Save Motion scene",
"description": "Saves typed MotionSceneV1 with exact words, cue frame ranges and owned asset IDs. Accepts typed layers and approved fonts; HTML, JS, CSS and URLs are not scene inputs. First save creates an opaque documentId with expectedRevision 0; edits bind the current expectedRevision. Conflicts preserve the newer saved version. No Brix36 language model is called.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"scene"
],
"properties": {
"scene": {
"type": "object"
},
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"documentId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"documentId",
"projectId",
"revisionId",
"revision",
"sceneDigest",
"scene"
],
"properties": {
"scene": {
"anyOf": [
{
"type": "object",
"required": [
"version",
"family",
"fps",
"durationFrames",
"output",
"background",
"palette",
"layers"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"audio": {
"type": "object",
"required": [
"assetId",
"sourceStartFrame",
"volume"
],
"properties": {
"volume": {
"type": "number"
},
"assetId": {
"type": "string"
},
"sourceStartFrame": {
"type": "number"
}
},
"additionalProperties": true
},
"family": {
"enum": [
"lyric_video",
"beat_visualiser",
"photo_poster",
"promo_cards",
"titles",
"kinetic_text",
"captions",
"logo_animation",
"charts",
"slides",
"lower_thirds"
]
},
"layers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"text"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"role": {
"enum": [
"title",
"credit",
"endcard",
"kinetic",
"lower_third"
]
},
"text": {
"type": "string"
},
"type": {
"enum": [
"text"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"cues"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"cues": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"role": {
"enum": [
"lyrics",
"captions"
]
},
"type": {
"enum": [
"cues"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"role",
"assetId",
"sourceStartFrame",
"fit"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"fit": {
"enum": [
"contain",
"cover"
]
},
"role": {
"enum": [
"logo",
"image",
"clip"
]
},
"type": {
"enum": [
"media"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"assetId": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"sourceStartFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"chart",
"title",
"series"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"chart"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"chart": {
"enum": [
"bar",
"line",
"pie"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"series": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value",
"color"
],
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"title",
"body",
"accent"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"body": {
"type": "string"
},
"type": {
"enum": [
"slide"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"accent": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"style",
"color"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"visualiser"
]
},
"color": {
"type": "string"
},
"style": {
"enum": [
"bars",
"waves",
"particles",
"ring"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"enum": [
1
]
},
"background": {
"type": "string"
},
"durationFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"version",
"family",
"fps",
"durationFrames",
"output",
"background",
"palette",
"layers",
"recipe"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"audio": {
"type": "object",
"required": [
"assetId",
"sourceStartFrame",
"volume"
],
"properties": {
"volume": {
"type": "number"
},
"assetId": {
"type": "string"
},
"sourceStartFrame": {
"type": "number"
}
},
"additionalProperties": true
},
"family": {
"enum": [
"lyric_video",
"beat_visualiser",
"photo_poster",
"promo_cards",
"titles",
"kinetic_text",
"captions",
"logo_animation",
"charts",
"slides",
"lower_thirds"
]
},
"layers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"text"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"role": {
"enum": [
"title",
"credit",
"endcard",
"kinetic",
"lower_third"
]
},
"text": {
"type": "string"
},
"type": {
"enum": [
"text"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"cues"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"cues": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"role": {
"enum": [
"lyrics",
"captions"
]
},
"type": {
"enum": [
"cues"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"role",
"assetId",
"sourceStartFrame",
"fit"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"fit": {
"enum": [
"contain",
"cover"
]
},
"role": {
"enum": [
"logo",
"image",
"clip"
]
},
"type": {
"enum": [
"media"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"assetId": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"sourceStartFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"chart",
"title",
"series"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"chart"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"chart": {
"enum": [
"bar",
"line",
"pie"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"series": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value",
"color"
],
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"title",
"body",
"accent"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"body": {
"type": "string"
},
"type": {
"enum": [
"slide"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"accent": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"style",
"color"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"visualiser"
]
},
"color": {
"type": "string"
},
"style": {
"enum": [
"bars",
"waves",
"particles",
"ring"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"recipe": {
"type": "object",
"required": [
"id",
"version",
"lookId",
"lookVersion",
"engine",
"fontId",
"fontHash",
"artistId",
"artistRevision",
"artistDigest",
"featureDigest",
"featureVersion",
"sources",
"intensity"
],
"properties": {
"id": {
"enum": [
"lyric_video",
"audio_visualiser",
"living_cover",
"kinetic_type",
"club_tunnel",
"organic_landscape"
]
},
"engine": {
"enum": [
"ffmpeg-templates.v1"
]
},
"fontId": {
"type": "string"
},
"lookId": {
"enum": [
"pop",
"hiphop_drill",
"rnb",
"house_edm",
"rock",
"country_acoustic",
"afrobeats"
]
},
"sources": {
"type": "array",
"items": {
"type": "object",
"required": [
"assetId",
"hash"
],
"properties": {
"hash": {
"type": "string"
},
"assetId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"version": {
"enum": [
1
]
},
"artistId": {
"type": "string"
},
"fontHash": {
"type": "string"
},
"intensity": {
"enum": [
"subtle",
"standard"
]
},
"alignmentId": {
"type": "string"
},
"lookVersion": {
"enum": [
1
]
},
"artistDigest": {
"type": "string"
},
"alignmentHash": {
"type": "string"
},
"featureDigest": {
"type": "string"
},
"artistRevision": {
"type": "number"
},
"featureVersion": {
"enum": [
"audio-window.v1"
]
}
},
"additionalProperties": true
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"enum": [
2
]
},
"background": {
"type": "string"
},
"durationFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
},
"revision": {
"type": "number"
},
"projectId": {
"type": "string"
},
"documentId": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"sceneDigest": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Save Motion scene",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Generate a free bounded first-frame image of this exact saved revision, maximum 640px long side. No LLM, render debit or full free movie. Preview is not an approval or a priced render.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| revisionId * | string |
{
"name": "studio_motion_preview",
"title": "Preview Motion first frame",
"description": "Generate a free bounded first-frame image of this exact saved revision, maximum 640px long side. No LLM, render debit or full free movie. Preview is not an approval or a priced render.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"revisionId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"revisionId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"revisionId",
"inputDigest",
"frame",
"width",
"height",
"assetUrl",
"expiresAt"
],
"properties": {
"frame": {
"enum": [
0
]
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"assetUrl": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"inputDigest": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Preview Motion first frame",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read the original durable operation after pending, timeout or unknown outcome. Successful work includes playback and download links. Reconcile means the existing effect is being checked; no replacement render is started.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| operationId * | string |
{
"name": "studio_motion_status",
"title": "Read Motion render status",
"description": "Read the original durable operation after pending, timeout or unknown outcome. Successful work includes playback and download links. Reconcile means the existing effect is being checked; no replacement render is started.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"operationId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 8
}
},
"additionalProperties": false
},
"outputSchema": {
"truncated": true,
"chars": 45364
},
"annotations": {
"title": "Read Motion render status",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read the finished owned asset with video.url and authenticated playback/download links. Source media remain preserved. Pending work is not a completed result.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| operationId * | string |
{
"name": "studio_motion_result",
"title": "Get Motion result",
"description": "Read the finished owned asset with video.url and authenticated playback/download links. Source media remain preserved. Pending work is not a completed result.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"operationId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 8
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operation",
"assetId",
"mimeType",
"playbackUrl",
"downloadUrl",
"originalAssetIds"
],
"properties": {
"image": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string"
}
},
"additionalProperties": true
},
"video": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string"
}
},
"additionalProperties": true
},
"assetId": {
"type": "string"
},
"mimeType": {
"enum": [
"image/png",
"video/mp4"
]
},
"operation": {
"type": "object",
"required": [
"operationId",
"state",
"revisionId",
"inputDigest",
"credits",
"settlement",
"outputAssetId",
"statusUrl"
],
"properties": {
"state": {
"enum": [
"pending",
"running",
"reconcile",
"succeeded",
"failed",
"canceled"
]
},
"credits": {
"type": "number"
},
"authored": {
"type": "object",
"required": [
"scene",
"preview"
],
"properties": {
"scene": {
"anyOf": [
{
"type": "object",
"required": [
"version",
"family",
"fps",
"durationFrames",
"output",
"background",
"palette",
"layers"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"audio": {
"type": "object",
"required": [
"assetId",
"sourceStartFrame",
"volume"
],
"properties": {
"volume": {
"type": "number"
},
"assetId": {
"type": "string"
},
"sourceStartFrame": {
"type": "number"
}
},
"additionalProperties": true
},
"family": {
"enum": [
"lyric_video",
"beat_visualiser",
"photo_poster",
"promo_cards",
"titles",
"kinetic_text",
"captions",
"logo_animation",
"charts",
"slides",
"lower_thirds"
]
},
"layers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"text"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"role": {
"enum": [
"title",
"credit",
"endcard",
"kinetic",
"lower_third"
]
},
"text": {
"type": "string"
},
"type": {
"enum": [
"text"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"cues"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"cues": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"role": {
"enum": [
"lyrics",
"captions"
]
},
"type": {
"enum": [
"cues"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"role",
"assetId",
"sourceStartFrame",
"fit"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"fit": {
"enum": [
"contain",
"cover"
]
},
"role": {
"enum": [
"logo",
"image",
"clip"
]
},
"type": {
"enum": [
"media"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"assetId": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"sourceStartFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"chart",
"title",
"series"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"chart"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"chart": {
"enum": [
"bar",
"line",
"pie"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"series": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value",
"color"
],
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"title",
"body",
"accent"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"body": {
"type": "string"
},
"type": {
"enum": [
"slide"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"accent": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"style",
"color"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"visualiser"
]
},
"color": {
"type": "string"
},
"style": {
"enum": [
"bars",
"waves",
"particles",
"ring"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"enum": [
1
]
},
"background": {
"type": "string"
},
"durationFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"version",
"family",
"fps",
"durationFrames",
"output",
"background",
"palette",
"layers",
"recipe"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"audio": {
"type": "object",
"required": [
"assetId",
"sourceStartFrame",
"volume"
],
"properties": {
"volume": {
"type": "number"
},
"assetId": {
"type": "string"
},
"sourceStartFrame": {
"type": "number"
}
},
"additionalProperties": true
},
"family": {
"enum": [
"lyric_video",
"beat_visualiser",
"photo_poster",
"promo_cards",
"titles",
"kinetic_text",
"captions",
"logo_animation",
"charts",
"slides",
"lower_thirds"
]
},
"layers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"text"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"role": {
"enum": [
"title",
"credit",
"endcard",
"kinetic",
"lower_third"
]
},
"text": {
"type": "string"
},
"type": {
"enum": [
"text"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"cues"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"cues": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"role": {
"enum": [
"lyrics",
"captions"
]
},
"type": {
"enum": [
"cues"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"role",
"assetId",
"sourceStartFrame",
"fit"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"fit": {
"enum": [
"contain",
"cover"
]
},
"role": {
"enum": [
"logo",
"image",
"clip"
]
},
"type": {
"enum": [
"media"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"assetId": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"sourceStartFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"chart",
"title",
"series"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"chart"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"chart": {
"enum": [
"bar",
"line",
"pie"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"series": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value",
"color"
],
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"title",
"body",
"accent"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"body": {
"type": "string"
},
"type": {
"enum": [
"slide"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"accent": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"style",
"color"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"visualiser"
]
},
"color": {
"type": "string"
},
"style": {
"enum": [
"bars",
"waves",
"particles",
"ring"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"recipe": {
"type": "object",
"required": [
"id",
"version",
"lookId",
"lookVersion",
"engine",
"fontId",
"fontHash",
"artistId",
"artistRevision",
"artistDigest",
"featureDigest",
"featureVersion",
"sources",
"intensity"
],
"properties": {
"id": {
"enum": [
"lyric_video",
"audio_visualiser",
"living_cover",
"kinetic_type",
"club_tunnel",
"organic_landscape"
]
},
"engine": {
"enum": [
"ffmpeg-templates.v1"
]
},
"fontId": {
"type": "string"
},
"lookId": {
"enum": [
"pop",
"hiphop_drill",
"rnb",
"house_edm",
"rock",
"country_acoustic",
"afrobeats"
]
},
"sources": {
"type": "array",
"items": {
"type": "object",
"required": [
"assetId",
"hash"
],
"properties": {
"hash": {
"type": "string"
},
"assetId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"version": {
"enum": [
1
]
},
"artistId": {
"type": "string"
},
"fontHash": {
"type": "string"
},
"intensity": {
"enum": [
"subtle",
"standard"
]
},
"alignmentId": {
"type": "string"
},
"lookVersion": {
"enum": [
1
]
},
"artistDigest": {
"type": "string"
},
"alignmentHash": {
"type": "string"
},
"featureDigest": {
"type": "string"
},
"artistRevision": {
"type": "number"
},
"featureVersion": {
"enum": [
"audio-window.v1"
]
}
},
"additionalProperties": true
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"enum": [
2
]
},
"background": {
"type": "string"
},
"durationFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
},
"preview": {
"anyOf": [
{
"type": "object",
"required": [
"revisionId",
"inputDigest",
"frame",
"width",
"height",
"assetUrl",
"expiresAt"
],
"properties": {
"frame": {
"enum": [
0
]
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"assetUrl": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"inputDigest": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
}
},
"additionalProperties": true
},
"resultId": {
"type": "string"
},
"statusUrl": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"settlement": {
"enum": [
"paid",
"fulfilled",
"refunded"
]
},
"inputDigest": {
"type": "string"
},
"operationId": {
"type": "string"
},
"outputAssetId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"downloadUrl": {
"type": "string"
},
"playbackUrl": {
"type": "string"
},
"originalAssetIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Get Motion result",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Add the exact finished Motion result to project media through normal attachment screening, preserving original assets, movie orders and expected project revision. This does not replace or regenerate a paid movie.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| operationId * | string | |
| expectedRevision * | integer |
{
"name": "studio_motion_use",
"title": "Use Motion result",
"description": "Add the exact finished Motion result to project media through normal attachment screening, preserving original assets, movie orders and expected project revision. This does not replace or regenerate a paid movie.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"operationId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 8
},
"expectedRevision": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"used"
],
"properties": {
"used": {
"const": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Use Motion result",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Restores a saved scene as a new revision with optimistic version checking. Original versions and media remain intact. Prior quotes become stale; further paid rendering requires a quote for the restored revision.
| Parameter | Type | Description |
|---|---|---|
| projectId * | string | |
| documentId * | string | |
| revisionId * | string | |
| expectedRevision * | integer |
{
"name": "studio_motion_restore",
"title": "Restore a Motion version",
"description": "Restores a saved scene as a new revision with optimistic version checking. Original versions and media remain intact. Prior quotes become stale; further paid rendering requires a quote for the restored revision.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"documentId",
"revisionId",
"expectedRevision"
],
"properties": {
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"documentId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1
},
"revisionId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"documentId",
"projectId",
"revisionId",
"revision",
"sceneDigest",
"scene"
],
"properties": {
"scene": {
"anyOf": [
{
"type": "object",
"required": [
"version",
"family",
"fps",
"durationFrames",
"output",
"background",
"palette",
"layers"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"audio": {
"type": "object",
"required": [
"assetId",
"sourceStartFrame",
"volume"
],
"properties": {
"volume": {
"type": "number"
},
"assetId": {
"type": "string"
},
"sourceStartFrame": {
"type": "number"
}
},
"additionalProperties": true
},
"family": {
"enum": [
"lyric_video",
"beat_visualiser",
"photo_poster",
"promo_cards",
"titles",
"kinetic_text",
"captions",
"logo_animation",
"charts",
"slides",
"lower_thirds"
]
},
"layers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"text"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"role": {
"enum": [
"title",
"credit",
"endcard",
"kinetic",
"lower_third"
]
},
"text": {
"type": "string"
},
"type": {
"enum": [
"text"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"cues"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"cues": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"role": {
"enum": [
"lyrics",
"captions"
]
},
"type": {
"enum": [
"cues"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"role",
"assetId",
"sourceStartFrame",
"fit"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"fit": {
"enum": [
"contain",
"cover"
]
},
"role": {
"enum": [
"logo",
"image",
"clip"
]
},
"type": {
"enum": [
"media"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"assetId": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"sourceStartFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"chart",
"title",
"series"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"chart"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"chart": {
"enum": [
"bar",
"line",
"pie"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"series": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value",
"color"
],
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"title",
"body",
"accent"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"body": {
"type": "string"
},
"type": {
"enum": [
"slide"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"accent": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"style",
"color"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"visualiser"
]
},
"color": {
"type": "string"
},
"style": {
"enum": [
"bars",
"waves",
"particles",
"ring"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"enum": [
1
]
},
"background": {
"type": "string"
},
"durationFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"version",
"family",
"fps",
"durationFrames",
"output",
"background",
"palette",
"layers",
"recipe"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"audio": {
"type": "object",
"required": [
"assetId",
"sourceStartFrame",
"volume"
],
"properties": {
"volume": {
"type": "number"
},
"assetId": {
"type": "string"
},
"sourceStartFrame": {
"type": "number"
}
},
"additionalProperties": true
},
"family": {
"enum": [
"lyric_video",
"beat_visualiser",
"photo_poster",
"promo_cards",
"titles",
"kinetic_text",
"captions",
"logo_animation",
"charts",
"slides",
"lower_thirds"
]
},
"layers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"text"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"role": {
"enum": [
"title",
"credit",
"endcard",
"kinetic",
"lower_third"
]
},
"text": {
"type": "string"
},
"type": {
"enum": [
"text"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"cues"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"cues": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"role": {
"enum": [
"lyrics",
"captions"
]
},
"type": {
"enum": [
"cues"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"role",
"assetId",
"sourceStartFrame",
"fit"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"fit": {
"enum": [
"contain",
"cover"
]
},
"role": {
"enum": [
"logo",
"image",
"clip"
]
},
"type": {
"enum": [
"media"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"assetId": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"sourceStartFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"chart",
"title",
"series"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"chart"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"chart": {
"enum": [
"bar",
"line",
"pie"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"series": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value",
"color"
],
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"title",
"body",
"accent"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"body": {
"type": "string"
},
"type": {
"enum": [
"slide"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"accent": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"style",
"color"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"visualiser"
]
},
"color": {
"type": "string"
},
"style": {
"enum": [
"bars",
"waves",
"particles",
"ring"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"recipe": {
"type": "object",
"required": [
"id",
"version",
"lookId",
"lookVersion",
"engine",
"fontId",
"fontHash",
"artistId",
"artistRevision",
"artistDigest",
"featureDigest",
"featureVersion",
"sources",
"intensity"
],
"properties": {
"id": {
"enum": [
"lyric_video",
"audio_visualiser",
"living_cover",
"kinetic_type",
"club_tunnel",
"organic_landscape"
]
},
"engine": {
"enum": [
"ffmpeg-templates.v1"
]
},
"fontId": {
"type": "string"
},
"lookId": {
"enum": [
"pop",
"hiphop_drill",
"rnb",
"house_edm",
"rock",
"country_acoustic",
"afrobeats"
]
},
"sources": {
"type": "array",
"items": {
"type": "object",
"required": [
"assetId",
"hash"
],
"properties": {
"hash": {
"type": "string"
},
"assetId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"version": {
"enum": [
1
]
},
"artistId": {
"type": "string"
},
"fontHash": {
"type": "string"
},
"intensity": {
"enum": [
"subtle",
"standard"
]
},
"alignmentId": {
"type": "string"
},
"lookVersion": {
"enum": [
1
]
},
"artistDigest": {
"type": "string"
},
"alignmentHash": {
"type": "string"
},
"featureDigest": {
"type": "string"
},
"artistRevision": {
"type": "number"
},
"featureVersion": {
"enum": [
"audio-window.v1"
]
}
},
"additionalProperties": true
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"enum": [
2
]
},
"background": {
"type": "string"
},
"durationFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
},
"revision": {
"type": "number"
},
"projectId": {
"type": "string"
},
"documentId": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"sceneDigest": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Restore a Motion version",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Plans a sentence-end rough cut and beat-aligned timeline from clip transcripts, word timestamps, caption segments, silence windows and beat markers. Prevents mid-sentence cuts, adds natural breathing room at sentence boundaries, and returns an audio mix plan targeting -16 LUFS with ducking. Free deterministic planning; no credits are charged.
| Parameter | Type | Description |
|---|---|---|
| fps | integer | one of [24,25,30,60] |
| beats | array | |
| clips * | array | |
| title | string | |
| preset | string | one of ["short","social","teaser","trailer","full_edit"] |
| beatsMs | array | |
| projectId | string | |
| timelineId | string | |
| aspectRatio | string | one of ["16:9","9:16","1:1"] |
| musicDuckDb | number | |
| pauseFloorMs | number |
Exports a sentence-end rough-cut timeline to Final Cut Pro XML (fcpxml), Premiere Pro XML (premiere_xml), CMX 3600 EDL (edl) or structured JSON (json) for non-linear editing. Free deterministic export; no credits are charged.
| Parameter | Type | Description |
|---|---|---|
| fps | integer | one of [24,25,30,60] |
| beats | array | |
| clips * | array | |
| title | string | |
| format * | string | one of ["fcpxml","premiere_xml","edl","json"] |
| preset | string | one of ["short","social","teaser","trailer","full_edit"] |
| beatsMs | array | |
| projectId | string | |
| timelineId | string | |
| aspectRatio | string | one of ["16:9","9:16","1:1"] |
| musicDuckDb | number | |
Reads a saved AI Editor rough-cut timeline by timelineId so edits made on the Brix36 Web Studio (/edit?timeline=...) or inside ChatGPT stay in sync.
| Parameter | Type | Description |
|---|---|---|
| timelineId * | string |
{
"name": "studio_ai_editor_timeline_read",
"title": "Read AI Editor timeline",
"description": "Reads a saved AI Editor rough-cut timeline by timelineId so edits made on the Brix36 Web Studio (/edit?timeline=...) or inside ChatGPT stay in sync.",
"inputSchema": {
"type": "object",
"required": [
"timelineId"
],
"properties": {
"timelineId": {
"type": "string",
"maxLength": 128,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"timelineId",
"webUrl",
"title",
"preset",
"totalDurationMs",
"sentenceBoundaryPolicy",
"cuts"
],
"properties": {
"cuts": {
"type": "array",
"items": {
"type": "object",
"required": [
"cutIndex",
"clipId",
"sourceInMs",
"sourceOutMs",
"durationMs",
"timelineStartMs",
"timelineEndMs",
"cutBoundary",
"endsOnSentenceBoundary",
"endsMidSentence"
],
"properties": {
"label": {
"type": "string"
},
"clipId": {
"type": "string"
},
"cutIndex": {
"type": "number"
},
"durationMs": {
"type": "number"
},
"sourceInMs": {
"type": "number"
},
"cutBoundary": {
"enum": [
"sentence_end",
"beat_snap"
]
},
"sourceOutMs": {
"type": "number"
},
"sentenceText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"timelineEndMs": {
"type": "number"
},
"endsMidSentence": {
"type": "boolean"
},
"timelineStartMs": {
"type": "number"
},
"endsOnSentenceBoundary": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"title": {
"type": "string"
},
"preset": {
"enum": [
"short",
"social",
"teaser",
"trailer",
"full_edit"
]
},
"webUrl": {
"type": "string"
},
"timelineId": {
"type": "string"
},
"totalDurationMs": {
"type": "number"
},
"sentenceBoundaryPolicy": {
"type": "object",
"required": [
"rule",
"midSentenceCutsAllowed",
"pauseSettleMs",
"verifiedZeroMidSentenceCuts"
],
"properties": {
"rule": {
"enum": [
"strict_sentence_end"
]
},
"pauseSettleMs": {
"type": "number"
},
"midSentenceCutsAllowed": {
"type": "boolean"
},
"verifiedZeroMidSentenceCuts": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read AI Editor timeline",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Saves or updates an AI Editor rough-cut timeline and returns timelineId and a Web Studio link so the customer can open and trim the exact timeline in the Brix36 Web Studio.
| Parameter | Type | Description |
|---|---|---|
| fps | integer | one of [24,25,30,60] |
| beats | array | |
| clips * | array | |
| title | string | |
| preset | string | one of ["short","social","teaser","trailer","full_edit"] |
| beatsMs | array | |
| projectId | string | |
| timelineId | string | |
| aspectRatio | string | one of ["16:9","9:16","1:1"] |
| musicDuckDb | number | |
| pauseFloorMs | number | |
| pauseSettleMs | number |
Makes the customer's finished video from one saved AI Editor timeline in the background, or returns its existing usable render when operationId is omitted. Returns renderId, its state and a plain sentence naming that renderId. When operationId is given it identifies this exact request, so an identical retry returns the same render and starts nothing new. Making the video is free: no credits are charged.
| Parameter | Type | Description |
|---|---|---|
| timelineId * | string | |
| operationId | string |
{
"name": "studio_ai_editor_render",
"title": "Make the AI Editor video",
"description": "Makes the customer's finished video from one saved AI Editor timeline in the background, or returns its existing usable render when operationId is omitted. Returns renderId, its state and a plain sentence naming that renderId. When operationId is given it identifies this exact request, so an identical retry returns the same render and starts nothing new. Making the video is free: no credits are charged.",
"inputSchema": {
"type": "object",
"required": [
"timelineId"
],
"properties": {
"timelineId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"operationId": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"renderId",
"state",
"next"
],
"properties": {
"next": {
"type": "string"
},
"state": {
"enum": [
"queued",
"rendering",
"succeeded",
"failed"
]
},
"renderId": {
"type": "string"
},
"timelineId": {
"type": "string"
},
"planFingerprint": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Make the AI Editor video",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Reads one background AI Editor video by renderId, with its state, progress and, once it is finished, the Library item plus the customer's private signed video and download links. The same renderId keeps reporting the same render until it changes. Reading it is free: no credits are charged.
| Parameter | Type | Description |
|---|---|---|
| renderId * | string |
{
"name": "studio_ai_editor_render_status",
"title": "Read the AI Editor video",
"description": "Reads one background AI Editor video by renderId, with its state, progress and, once it is finished, the Library item plus the customer's private signed video and download links. The same renderId keeps reporting the same render until it changes. Reading it is free: no credits are charged.",
"inputSchema": {
"type": "object",
"required": [
"renderId"
],
"properties": {
"renderId": {
"type": "string",
"maxLength": 128,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"state",
"progress",
"next"
],
"properties": {
"next": {
"type": "string"
},
"state": {
"enum": [
"queued",
"rendering",
"succeeded",
"failed"
]
},
"assetId": {
"type": "string"
},
"message": {
"type": "string"
},
"progress": {
"type": "number"
},
"creationId": {
"type": "string"
},
"previewUrl": {
"type": "string"
},
"timelineId": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"libraryItemId": {
"type": "string"
},
"planFingerprint": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Read the AI Editor video",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Use the focused tools for changes: studio_storyboard_likeness_record records one customer likeness verdict; studio_storyboard_look_accept records acceptance of the saved look set; studio_project_dna_pin pins current Artist DNA; studio_project_artist_presence_set chooses artist presence. Film edits each have their own studio_film_* tool. studio_storyboard_picture_changes_prepare prepares a price for requested picture changes; historical approved requests retain their original behavior. PRICE THE WORK REQUESTED NOW: show only the exact price for the current requested pictures and/or video. Do not display prices, budgets or allowances for future retries. A later customer-requested change has its own clear price; never imply that technical recovery requires a new purchase. Preserve existing paid identities and do not add a charge for an uncertain retry. CUSTOMER EXPERIENCE FIRST: guide a simple creative journey: describe the idea, show a visual storyboard, accept optional natural-language changes such as make it warmer, show one exact total price, create after one financial approval, then show the finished video to watch or download. This is not a mandatory wizard: use facts already supplied, make competent creative choices, ask only for essential missing creative inputs and never add a review gate. Do not force model, profile or operation choices; advanced settings remain available when explicitly requested. Ordinary customer replies show the pictures or storyboard and finished video, a concise creative description and one clear next action. Keep operation IDs, revision IDs, hashes, tokens, provider names, routing and gate jargon in tool data, not customer prose; surface technical detail only for an explicitly technical request. If the native widget is unavailable, render returned picture links as images and returned video through the supported host media path or a useful playback link. Never substitute a text-only storyboard when images exist. Do not claim a picture or video exists until returned by a tool. INTERNAL QUOTE IDENTITY: every engine/profile selection returns an updated quote. Preserve operationId, quoteToken, revisionId, priceVersion and totalCredits together from that same final result and use its totalCredits as quotedCredits when confirming. Never pair the initial operationId with a final quoteToken. Reconcile uncertain effects by the original paid identity before any retry; do not create a replacement paid operation. An already-approved motion needs no second customer financial approval. These instructions do not change API money rules. Brix36 connects the customer’s existing studio account. The connector validates and saves finished lyrics, song understanding, storyboard direction, visualWorld, Film scenes and dialogue without invoking Brix36 planning models. Creative skills, style cards and writing schemas are available through the skill tools, resources and prompts. Upload widgets and app upload pages transfer customer media directly to Brix36. Song timing and voice ownership come from supplied evidence and saved customer decisions. studio_sections_read returns Music storyboards with server-owned shot timing. Film uses the same artist IDs for cast members. Finished boards require visualWorld before quoting. Revision-bound writes preserve prior versions and reject stale input. Engine options include availability, server merit ranking, current selection, supported profiles and quoted prices. Section allocated_final_total shares sum to finalVideoCredits; alternative option prices are whole-video totals excluding pictures. Engine/profile changes produce a new signed quote. The final output fits the project canvas without cropping. Set the film’s shape from what the customer asked for or from the pictures they supplied, before any pictures are made or attached and before giving a price; phones and social feeds are upright. Changing the shape later means the pictures must be made or attached again, so tell the custo
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
| durationMs | integer | The song length in milliseconds, if the customer's AI knows it. |
| createArtist | boolean | True creates a new fictional_character under an unmatched artistName. Fictional characters need no photo or likeness consent. Real-person creation uses the existing app consent flow. Existing names are reused either way; identical retries retain the original flag. |
{
"name": "studio_video_start",
"title": "Start a music video or film for this customer",
"description": "Creates a Music or Film project in the customer's catalogue. Accepts an existing artist name or a new fictional name with createArtist:true. Fictional characters require no photo or likeness consent; real-person creation retains the app consent flow. Music requires songTitle; Film requires title or songTitle and no song. Identical retries return the same project. Returns project identifiers for song upload or Film script import. No generation or charge.",
"inputSchema": {
"type": "object",
"required": [
"kind",
"artistName"
],
"properties": {
"kind": {
"enum": [
"music",
"film"
],
"type": "string",
"description": "The requested video kind: music is a music video for a song; film is a short film with scenes, dialogue and optional music."
},
"title": {
"type": "string",
"maxLength": 160,
"description": "What to call the video. Defaults to the song title. A film without a songTitle needs this."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact artist ID from studio_artists_list, disambiguating artists with the same name. ID and artistName must match."
},
"boosters": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string",
"description": "One of: \"caption\", \"zoom\", \"transition\", \"flash\", \"title\", \"callout\", \"productCard\", \"priceCard\", \"lowerThird\", \"endCard\", \"background\", \"visualiser\", \"lyric\"."
},
"maxItems": 13,
"description": "Overlay layers to include on the video.",
"uniqueItems": true
},
"mode": {
"enum": [
"auto",
"off",
"custom"
],
"type": "string",
"description": "'auto' for automatic motion graphics, 'off' for none, or 'custom' (default when styleId, add or remove are given)."
},
"remove": {
"type": "array",
"items": {
"type": "string",
"description": "One of: \"caption\", \"zoom\", \"transition\", \"flash\", \"title\", \"callout\", \"productCard\", \"priceCard\", \"lowerThird\", \"endCard\", \"background\", \"visualiser\", \"lyric\"."
},
"maxItems": 13,
"description": "Overlay layers to exclude from the chosen style.",
"uniqueItems": true
},
"styleId": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{0,63}$",
"maxLength": 64,
"minLength": 1,
"description": "Motion style identifier (for example glass-keynote, product-drop, bold-hook, data-and-map, kinetic-lyric)."
}
},
"description": "Optional motion-graphics overlay pack for the finished video, film or advert: mode 'auto' (automatic captions, titles and end card), 'off' (no motion overlay), or 'custom' with optional styleId (for example glass-keynote, product-drop, bold-hook, data-and-map, kinetic-lyric) and optional add or remove overlay kinds.",
"additionalProperties": false
},
"songTitle": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"description": "The song this video is for. Required for a music video; optional for a film, which needs no song. Shown to the customer and used for the catalogue entry."
},
"artistName": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "The existing artist or invented character starring in it. Required: an existing name from studio_artists_list (case and spacing do not matter), or the customer's chosen new fictional name with createArtist: true."
},
"durationMs": {
"type": "integer",
"maximum": 3600000,
"minimum": 1000,
"description": "The song length in milliseconds, if the customer's AI knows it."
},
"createArtist": {
"type": "boolean",
"description": "True creates a new fictional_character under an unmatched artistName. Fictional characters need no photo or likeness consent. Real-person creation uses the existing app consent flow. Existing names are reused either way; identical retries retain the original flag."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"kind",
"title",
"songTitle",
"artist",
"artistNeedsPhoto",
"outcome",
"next",
"note"
],
"properties": {
"kind": {
"enum": [
"music",
"film"
]
},
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"title": {
"type": "string"
},
"artist": {
"type": "object",
"required": [
"id",
"name",
"coverUrl"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"coverUrl": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"outcome": {
"enum": [
"created",
"replayed"
]
},
"projectId": {
"type": "string"
},
"songTitle": {
"type": "string"
},
"artistNeedsPhoto": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Start a music video or film for this customer",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "studio_film_script_write",
"title": "Import a finished Film script",
"description": "Imports finished screenplay-style Film text, with SCENE headings, NAME: dialogue and optional visualWorld. Preserves scenes, dialogue and speaker names, caps Film at five minutes and reports uncast speakers. Identical retries return the same plan. A visualWorld is required for quoting. No Brix36 planning model or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"script",
"expectedRevisionId",
"language"
],
"properties": {
"cast": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"maxItems": 6,
"description": "Optional: artist names to cast, in slot order. Names must be the customer's own artists."
},
"script": {
"type": "string",
"maxLength": 100000,
"minLength": 1,
"description": "The finished script, exactly as written. Its language is preserved as-is."
},
"language": {
"type": "string",
"maxLength": 35,
"minLength": 2,
"description": "The selected Film language. The host validates its actual model capability; text is not translated."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "From studio_video_start with kind 'film'."
},
"visualWorld": {
"type": "object",
"required": [
"timeOfDay",
"light",
"setting"
],
"properties": {
"light": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"never": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"props": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"artist": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"palette": {
"type": "array",
"items": {
"type": "string",
"pattern": "^#[0-9A-F]{6}$"
},
"maxItems": 5,
"description": "Optional creator-selected palette: 0–5 unique uppercase #RRGGBB colours.",
"uniqueItems": true
},
"setting": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"vehicles": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"locations": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"timeOfDay": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"characters": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
}
},
"description": "Board-wide visual facts. Optional characters, vehicles, locations, props and never are arrays of up to 12 non-empty strings, each at most 300 characters. Combined rendered fields are limited to 2,400 characters including labels, separators and newlines after trimming. Scene-specific costume and visual direction belong to scene text.",
"additionalProperties": false
},
"expectedRevisionId": {
"type": [
"string",
"null"
],
"maxLength": 64,
"minLength": 1,
"description": "The revisionId from studio_sections_read, or null only when no storyboard exists."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"outcome",
"revision",
"revisionId",
"language",
"sceneCount",
"totalMs",
"uncastLineIds",
"next",
"note"
],
"properties": {
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"outcome": {
"enum": [
"created",
"replayed"
]
},
"totalMs": {
"type": "number"
},
"language": {
"type": "string"
},
"revision": {
"type": "number"
},
"projectId": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"sceneCount": {
"type": "number"
},
"uncastLineIds": {
"type": "array",
"items": {
"type": "string"
}
},
"uncastSpeakers": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Import a finished Film script",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "studio_generation_quote",
"title": "Price a generation (nothing is charged)",
"description": "Prices missing storyboard pictures plus the exact video price for one run without spending credits. Returns totalCredits, totalGbpInclVat, balance, shortfall, signed quoteToken, operationId, revisionId and priceVersion. engineRecommendations contains server-ranked choices, current selections and quoted alternatives; section engine selection returns a revised quote. Film filmScenes can quote one scene preview at a time (renderOnly:true), or remake named/missing scenes and assemble all saved clips (renderOnly:false). After each preview confirm, check the result, and quote the next scene. Film quotes include per-character, per-scene speech, motion and lip-sync routes, or historical_unavailable when prior evidence is absent. Chat-mode confirmation uses these exact quote fields. The saved financial approval covers pictures and video; requested picture changes have separate quotes. No checkout or approval-page URL is created. Existing app approvals and issued codes remain supported.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"scope"
],
"properties": {
"scope": {
"enum": [
"whole",
"ticked"
],
"type": "string",
"description": "'whole' for the whole song, 'ticked' for the sections currently ticked on the board."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"filmScenes": {
"type": "object",
"properties": {
"sceneIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 240,
"minItems": 1,
"description": "Saved stableSceneId values from studio_film_read. Named scenes are remade; other good clips are reused.",
"uniqueItems": true
},
"renderOnly": {
"type": "boolean",
"description": "True quotes only these scenes for a scene preview. Confirm, check the result, then quote the next scene. False assembles the complete Film, making only named or missing scenes."
}
},
"additionalProperties": false
},
"operationId": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 128,
"minLength": 8,
"description": "Stable operation identifier shared by this quote and its confirmation."
},
"stillQuality": {
"enum": [
"medium",
"high"
],
"type": "string",
"description": "Picture quality for the pictures. Default high."
},
"stillShotIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"maxItems": 200,
"minItems": 1,
"description": "Optional customer-selected stableShotIds from studio_sections_read. Absence selects every shot without a picture. Other shots may have separate later quotes and financial approvals.",
"uniqueItems": true
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"quoteToken",
"scope",
"sectionCount",
"tickedCount",
"models",
"balance",
"expiresAt",
"note"
],
"properties": {
"note": {
"type": "string"
},
"redos": {
"type": "object",
"required": [
"allowance",
"creditCap",
"used",
"usedCredits"
],
"properties": {
"used": {
"type": "number"
},
"allowance": {
"type": "number"
},
"creditCap": {
"type": "number"
},
"usedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"scope": {
"enum": [
"whole",
"ticked"
]
},
"video": {
"type": "object",
"required": [
"capCredits"
],
"properties": {
"capCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"models": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"recommended",
"credits"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"note": {
"type": "string"
},
"credits": {
"type": [
"number",
"null"
]
},
"recommended": {
"type": "boolean"
},
"needsFaceCheck": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"stills": {
"type": "object",
"required": [
"shotCount",
"credits"
],
"properties": {
"credits": {
"type": "number"
},
"shotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"filmSpeech": {
"anyOf": [
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"characters"
],
"properties": {
"state": {
"enum": [
"quoted"
]
},
"characters": {
"type": "array",
"items": {
"type": "object",
"required": [
"artistId",
"characterName",
"sceneIndex",
"voiceSource",
"speech",
"motion",
"lipSync"
],
"properties": {
"motion": {
"type": "object",
"required": [
"providerId",
"modelId"
],
"properties": {
"modelId": {
"type": "string"
},
"providerId": {
"type": "string"
}
},
"additionalProperties": true
},
"speech": {
"type": "object",
"required": [
"providerId",
"modelId"
],
"properties": {
"modelId": {
"type": "string"
},
"providerId": {
"type": "string"
}
},
"additionalProperties": true
},
"lipSync": {
"enum": [
"native",
"separate",
"not_requested"
]
},
"artistId": {
"type": "string"
},
"sceneIndex": {
"type": "number"
},
"voiceSource": {
"enum": [
"native_generated",
"saved_character",
"character_voice_setup"
]
},
"lipSyncRoute": {
"type": "object",
"required": [
"providerId",
"modelId"
],
"properties": {
"modelId": {
"type": "string"
},
"providerId": {
"type": "string"
}
},
"additionalProperties": true
},
"characterName": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"reason"
],
"properties": {
"state": {
"enum": [
"historical_unavailable"
]
},
"reason": {
"enum": [
"original_route_evidence_not_persisted"
]
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
"outputNote": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"consentMode": {
"enum": [
"chat"
]
},
"repeatReuse": {
"type": "object",
"required": [
"reusedSeconds",
"freshSeconds",
"reusedShotCount",
"text"
],
"properties": {
"text": {
"type": "string"
},
"freshSeconds": {
"type": "number"
},
"reusedSeconds": {
"type": "number"
},
"reusedShotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"tickedCount": {
"type": "number"
},
"priceVersion": {
"type": "string"
},
"sectionCount": {
"type": "number"
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"approvalState": {
"type": "string"
},
"costEstimateId": {
"type": "string"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"approvalExpiresAt": {
"type": "string"
},
"topUpGbpInclVatNow": {
"type": "string"
},
"creditsInformationUrl": {
"type": "string"
},
"engineRecommendations": {
"anyOf": [
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"reason"
],
"properties": {
"state": {
"enum": [
"unavailable"
]
},
"reason": {
"enum": [
"original_quote_replayed"
]
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"shots"
],
"properties": {
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"sectionIndex",
"label",
"selectedModelName",
"recommendedModelName",
"options"
],
"properties": {
"label": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"modelName",
"available",
"explanation"
],
"properties": {
"available": {
"type": "boolean"
},
"modelName": {
"type": "string"
},
"explanation": {
"type": [
"string",
"null"
]
},
"deltaVideoCredits": {
"type": "number"
},
"totalVideoCredits": {
"type": "number"
}
},
"additionalProperties": true
}
},
"sectionIndex": {
"type": "number"
},
"stableShotId": {
"type": "string"
},
"selectedModelName": {
"type": [
"string",
"null"
]
},
"recommendedModelName": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"state": {
"enum": [
"quoted"
]
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"sectionIndex",
"sectionId",
"stableShotIds",
"delivery",
"availableProfiles",
"pricing"
],
"properties": {
"pricing": {
"type": "object",
"required": [
"basis",
"credits"
],
"properties": {
"basis": {
"enum": [
"allocated_final_total"
]
},
"credits": {
"type": "number"
}
},
"additionalProperties": true
},
"delivery": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"sectionId": {
"type": [
"string",
"null"
]
},
"sectionIndex": {
"type": "number"
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"availableProfiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"finalVideoCredits": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Price a generation (nothing is charged)",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| operationId * | string | The same id used for this operation at quote time. |
| priceVersion | string | Exact version of the combined quote the customer approved. |
| quotedCredits | integer | Exact totalCredits approved by the customer; bound to the quoted price. |
| confirmationToken | string | Brix36-issued code for an existing app-approved operation. New chat approvals are bound by the chat-stage quote fields. |
{
"name": "studio_generation_confirm",
"title": "Start a generation the customer approved",
"description": "Spends Brix36 credits and starts the quoted work under the customer's financial approval. In chat mode, stage:pictures records one approval for pictures and video using the original operationId, quoteToken, priceVersion, quotedCredits and revisionId. Insufficient balance returns balance, shortfall and creditsInformationUrl without a checkout. Stage:video uses the current picture revision and the same financial approval, subject to the existing readiness gates. Identical stage and argument retries reconcile the same operation. New authorizations retain pause/cap, OAuth studio.spend, account and exact-quote checks. The response waits up to 45 seconds for the started stage and includes current progress, a finished video link when available, or the free status-call arguments for work still rendering. Existing page-approved operations and confirmationToken codes remain supported.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"quoteToken"
],
"properties": {
"stage": {
"enum": [
"pictures",
"video"
],
"type": "string",
"description": "Chat mode: pictures records one financial approval and starts pictures; video starts video under that same approval and the current readiness gates. Each retry retains its original stage."
},
"modelId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Optional with an approved quote (the approved model is used). Otherwise the id of the model the customer chose, from that quote's models list."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"quoteToken": {
"type": "string",
"maxLength": 80000,
"minLength": 16,
"description": "The exact opaque quoteToken returned by studio_generation_quote."
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "For pictures, the quoted revisionId; for video, the current picture revision with applicable readiness checks satisfied."
},
"operationId": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 128,
"minLength": 8,
"description": "The same id used for this operation at quote time."
},
"priceVersion": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "Exact version of the combined quote the customer approved."
},
"quotedCredits": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Exact totalCredits approved by the customer; bound to the quoted price."
},
"confirmationToken": {
"type": "string",
"maxLength": 80000,
"minLength": 16,
"description": "Brix36-issued code for an existing app-approved operation. New chat approvals are bound by the chat-stage quote fields."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"operationId",
"outcome",
"jobId",
"confirmationId",
"replayed",
"next"
],
"properties": {
"next": {
"type": "string"
},
"jobId": {
"type": [
"string",
"null"
]
},
"outcome": {
"enum": [
"queued",
"replayed"
]
},
"replayed": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"operationId": {
"type": "string"
},
"creditBalance": {
"type": "number"
},
"confirmationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"outcome",
"operationId",
"balance",
"shortfall",
"totalCredits",
"priceVersion",
"creditsInformationUrl",
"note",
"progress",
"next"
],
"properties": {
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"stage": {
"enum": [
"pictures",
"video"
]
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"outcome": {
"enum": [
"credits_required"
]
},
"progress": {
"type": "object",
"required": [
"projectId",
"operationId",
"creditsInformationUrl",
"stage",
"next",
"state",
"totalCredits",
"totalGbpInclVat",
"allowance",
"videoCapCredits",
"balance",
"shortfallNow",
"shortfall",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage"
],
"properties": {
"next": {
"type": "string"
},
"issue": {
"type": "string"
},
"stage": {
"enum": [
"waiting_for_chat_approval_or_top_up",
"waiting_for_approval",
"making_pictures",
"pictures_ready",
"video_waiting_for_payment",
"starting_video",
"making_video",
"failed",
"ready"
]
},
"state": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"pictures": {
"type": "object",
"required": [
"making",
"failed",
"missing"
],
"properties": {
"failed": {
"type": "number"
},
"making": {
"type": "number"
},
"missing": {
"type": "number"
}
},
"additionalProperties": true
},
"allowance": {
"type": "object",
"required": [
"picturesLeft",
"creditsLeft"
],
"properties": {
"creditsLeft": {
"type": "number"
},
"picturesLeft": {
"type": "number"
}
},
"additionalProperties": true
},
"completed": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"freshQuote": {
"type": "object",
"required": [
"revisionId",
"priceVersion",
"approvalId",
"approvalExpiresAt",
"state",
"quoteToken",
"modelId",
"totalCredits",
"totalGbpInclVat",
"stills",
"redos",
"video",
"balance",
"shortfallNow",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage",
"shortfall",
"operationId"
],
"properties": {
"redos": {
"type": "object",
"required": [
"allowance",
"creditCap",
"used",
"usedCredits"
],
"properties": {
"used": {
"type": "number"
},
"allowance": {
"type": "number"
},
"creditCap": {
"type": "number"
},
"usedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"state": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"video": {
"type": "object",
"required": [
"capCredits"
],
"properties": {
"capCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"stills": {
"type": "object",
"required": [
"shotCount",
"credits"
],
"properties": {
"credits": {
"type": "number"
},
"shotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"approvalId": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"consentMode": {
"enum": [
"chat"
]
},
"operationId": {
"type": "string"
},
"priceVersion": {
"type": "string"
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"approvalExpiresAt": {
"type": "string"
},
"topUpGbpInclVatNow": {
"type": "string"
}
},
"additionalProperties": true
},
"failureCode": {
"type": "string"
},
"operationId": {
"type": "string"
},
"continuation": {
"type": "object",
"required": [
"tool",
"arguments",
"waitSeconds"
],
"properties": {
"tool": {
"enum": [
"studio_generation_wait"
]
},
"arguments": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
"waitSeconds": {
"type": "number"
}
},
"additionalProperties": true
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"videoCapCredits": {
"type": "number"
},
"topUpGbpInclVatNow": {
"type": "string"
},
"creditsInformationUrl": {
"type": "string"
},
"customerActionRequired": {
"type": "boolean"
}
},
"additionalProperties": true
},
"shortfall": {
"type": "number"
},
"operationId": {
"type": "string"
},
"continuation": {
"type": "object",
"required": [
"tool",
"arguments",
"waitSeconds"
],
"properties": {
"tool": {
"enum": [
"studio_generation_wait"
]
},
"arguments": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
"waitSeconds": {
"type": "number"
}
},
"additionalProperties": true
},
"priceVersion": {
"type": "string"
},
"totalCredits": {
"type": "number"
},
"creditsInformationUrl": {
"type": "string"
},
"customerActionRequired": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"revisionId",
"priceVersion",
"approvalId",
"approvalExpiresAt",
"state",
"quoteToken",
"modelId",
"totalCredits",
"totalGbpInclVat",
"stills",
"redos",
"video",
"balance",
"shortfallNow",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage",
"shortfall",
"outcome",
"stage",
"operationId",
"replayed",
"jobIds",
"note",
"progress",
"next"
],
"properties": {
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"redos": {
"type": "object",
"required": [
"allowance",
"creditCap",
"used",
"usedCredits"
],
"properties": {
"used": {
"type": "number"
},
"allowance": {
"type": "number"
},
"creditCap": {
"type": "number"
},
"usedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"stage": {
"enum": [
"pictures"
]
},
"state": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"video": {
"anyOf": [
{
"type": "object",
"required": [
"capCredits"
],
"properties": {
"capCredits": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
"jobIds": {
"type": "array",
"items": {
"type": "string"
}
},
"stills": {
"type": "object",
"required": [
"shotCount",
"credits"
],
"properties": {
"credits": {
"type": "number"
},
"shotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"outcome": {
"enum": [
"failed",
"pictures_approved"
]
},
"progress": {
"type": "object",
"required": [
"projectId",
"operationId",
"creditsInformationUrl",
"stage",
"next",
"state",
"totalCredits",
"totalGbpInclVat",
"allowance",
"videoCapCredits",
"balance",
"shortfallNow",
"shortfall",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage"
],
"properties": {
"next": {
"type": "string"
},
"issue": {
"type": "string"
},
"stage": {
"enum": [
"waiting_for_chat_approval_or_top_up",
"waiting_for_approval",
"making_pictures",
"pictures_ready",
"video_waiting_for_payment",
"starting_video",
"making_video",
"failed",
"ready"
]
},
"state": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"pictures": {
"type": "object",
"required": [
"making",
"failed",
"missing"
],
"properties": {
"failed": {
"type": "number"
},
"making": {
"type": "number"
},
"missing": {
"type": "number"
}
},
"additionalProperties": true
},
"allowance": {
"type": "object",
"required": [
"picturesLeft",
"creditsLeft"
],
"properties": {
"creditsLeft": {
"type": "number"
},
"picturesLeft": {
"type": "number"
}
},
"additionalProperties": true
},
"completed": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"freshQuote": {
"type": "object",
"required": [
"revisionId",
"priceVersion",
"approvalId",
"approvalExpiresAt",
"state",
"quoteToken",
"modelId",
"totalCredits",
"totalGbpInclVat",
"stills",
"redos",
"video",
"balance",
"shortfallNow",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage",
"shortfall",
"operationId"
],
"properties": {
"redos": {
"type": "object",
"required": [
"allowance",
"creditCap",
"used",
"usedCredits"
],
"properties": {
"used": {
"type": "number"
},
"allowance": {
"type": "number"
},
"creditCap": {
"type": "number"
},
"usedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"state": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"video": {
"type": "object",
"required": [
"capCredits"
],
"properties": {
"capCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"stills": {
"type": "object",
"required": [
"shotCount",
"credits"
],
"properties": {
"credits": {
"type": "number"
},
"shotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"approvalId": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"consentMode": {
"enum": [
"chat"
]
},
"operationId": {
"type": "string"
},
"priceVersion": {
"type": "string"
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"approvalExpiresAt": {
"type": "string"
},
"topUpGbpInclVatNow": {
"type": "string"
}
},
"additionalProperties": true
},
"failureCode": {
"type": "string"
},
"operationId": {
"type": "string"
},
"continuation": {
"type": "object",
"required": [
"tool",
"arguments",
"waitSeconds"
],
"properties": {
"tool": {
"enum": [
"studio_generation_wait"
]
},
"arguments": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
"waitSeconds": {
"type": "number"
}
},
"additionalProperties": true
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"videoCapCredits": {
"type": "number"
},
"topUpGbpInclVatNow": {
"type": "string"
},
"creditsInformationUrl": {
"type": "string"
},
"customerActionRequired": {
"type": "boolean"
}
},
"additionalProperties": true
},
"replayed": {
"type": "boolean"
},
"shortfall": {
"type": "number"
},
"approvalId": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"consentMode": {
"enum": [
"chat"
]
},
"operationId": {
"type": "string"
},
"continuation": {
"type": "object",
"required": [
"tool",
"arguments",
"waitSeconds"
],
"properties": {
"tool": {
"enum": [
"studio_generation_wait"
]
},
"arguments": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
"waitSeconds": {
"type": "number"
}
},
"additionalProperties": true
},
"priceVersion": {
"type": "string"
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"approvalExpiresAt": {
"type": "string"
},
"topUpGbpInclVatNow": {
"type": "string"
},
"customerActionRequired": {
"type": "boolean"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"outcome",
"creditBalance",
"stage",
"operationId",
"note",
"progress",
"next"
],
"properties": {
"next": {
"type": "string"
},
"note": {
"type": "string"
},
"stage": {
"enum": [
"video"
]
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
},
"additionalProperties": true
},
"outcome": {
"enum": [
"queued",
"replayed"
]
},
"progress": {
"type": "object",
"required": [
"projectId",
"operationId",
"creditsInformationUrl",
"stage",
"next",
"state",
"totalCredits",
"totalGbpInclVat",
"allowance",
"videoCapCredits",
"balance",
"shortfallNow",
"shortfall",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage"
],
"properties": {
"next": {
"type": "string"
},
"issue": {
"type": "string"
},
"stage": {
"enum": [
"waiting_for_chat_approval_or_top_up",
"waiting_for_approval",
"making_pictures",
"pictures_ready",
"video_waiting_for_payment",
"starting_video",
"making_video",
"failed",
"ready"
]
},
"state": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"video": {
"type": "object",
"required": [
"url",
"mimeType"
],
"properties": {
"url": {
"type": "string"
},
"byteSize": {
"type": "number"
},
"mimeType": {
"type": "string"
},
"assembledAt": {
"type": "string"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"pictures": {
"type": "object",
"required": [
"making",
"failed",
"missing"
],
"properties": {
"failed": {
"type": "number"
},
"making": {
"type": "number"
},
"missing": {
"type": "number"
}
},
"additionalProperties": true
},
"allowance": {
"type": "object",
"required": [
"picturesLeft",
"creditsLeft"
],
"properties": {
"creditsLeft": {
"type": "number"
},
"picturesLeft": {
"type": "number"
}
},
"additionalProperties": true
},
"completed": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"freshQuote": {
"type": "object",
"required": [
"revisionId",
"priceVersion",
"approvalId",
"approvalExpiresAt",
"state",
"quoteToken",
"modelId",
"totalCredits",
"totalGbpInclVat",
"stills",
"redos",
"video",
"balance",
"shortfallNow",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage",
"shortfall",
"operationId"
],
"properties": {
"redos": {
"type": "object",
"required": [
"allowance",
"creditCap",
"used",
"usedCredits"
],
"properties": {
"used": {
"type": "number"
},
"allowance": {
"type": "number"
},
"creditCap": {
"type": "number"
},
"usedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"state": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"video": {
"type": "object",
"required": [
"capCredits"
],
"properties": {
"capCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"stills": {
"type": "object",
"required": [
"shotCount",
"credits"
],
"properties": {
"credits": {
"type": "number"
},
"shotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"approvalId": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"consentMode": {
"enum": [
"chat"
]
},
"operationId": {
"type": "string"
},
"priceVersion": {
"type": "string"
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"approvalExpiresAt": {
"type": "string"
},
"topUpGbpInclVatNow": {
"type": "string"
}
},
"additionalProperties": true
},
"failureCode": {
"type": "string"
},
"operationId": {
"type": "string"
},
"continuation": {
"type": "object",
"required": [
"tool",
"arguments",
"waitSeconds"
],
"properties": {
"tool": {
"enum": [
"studio_generation_wait"
]
},
"arguments": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
"waitSeconds": {
"type": "number"
}
},
"additionalProperties": true
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"videoCapCredits": {
"type": "number"
},
"topUpGbpInclVatNow": {
"type": "string"
},
"creditsInformationUrl": {
"type": "string"
},
"customerActionRequired": {
"type": "boolean"
}
},
"additionalProperties": true
},
"operationId": {
"type": "string"
},
"continuation": {
"type": "object",
"required": [
"tool",
"arguments",
"waitSeconds"
],
"properties": {
"tool": {
"enum": [
"studio_generation_wait"
]
},
"arguments": {
"type": "object",
"required": [
"projectId",
"operationId"
],
"properties": {
"projectId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
"waitSeconds": {
"type": "number"
}
},
"additionalProperties": true
},
"creditBalance": {
"type": "number"
},
"customerActionRequired": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Start a generation the customer approved",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}| stableShotIds | array |
{
"name": "studio_storyboard_stills_quote",
"title": "Price the storyboard pictures",
"description": "Prices selected storyboard pictures without spending. Supports missing pictures or new_version for exactly one existing picture, bound to the current revision, quality and stableShotIds. lookTest:true selects the saved bounded key-look set. Returns a signed picture-only quote and exact confirmation fields. Missing operationId is derived by the server; new_version uses a stable op_ ID. Chat approval and existing issued confirmation codes are supported. Short balance returns credit information only. This quote covers no video or planning model.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"revisionId",
"mode",
"quality"
],
"properties": {
"mode": {
"enum": [
"missing",
"new_version"
],
"type": "string",
"description": "missing prepares selected shots without pictures; new_version buys another picture for exactly one shot that already has one."
},
"quality": {
"enum": [
"medium",
"high"
],
"type": "string",
"description": "The customer’s explicit picture quality; high is the app’s best-picture option."
},
"lookTest": {
"type": "boolean",
"const": true,
"description": "For missing mode, true selects the approved storyboard’s saved key-look set. In this mode stableShotIds and operationId are absent."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The music-video or Film project id."
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision."
},
"operationId": {
"type": "string",
"pattern": "^op_[A-Za-z0-9_-]{10,120}$",
"maxLength": 130,
"minLength": 1,
"description": "Stable operationId from the picture quote. A new_version operation uses op_ followed by 10–120 letters, digits, underscores or dashes."
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "A stableShotId on this exact storyboard."
},
"maxItems": 200,
"minItems": 1,
"uniqueItems": true
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"quoteToken",
"quality",
"expiresAt",
"creditAmount",
"creditBalance",
"canAfford",
"shots",
"mode",
"operationId",
"modelId",
"requestDigest",
"stableShotIds",
"totalCredits",
"totalGbpInclVat",
"balance",
"shortfall",
"outcome",
"note"
],
"properties": {
"mode": {
"enum": [
"missing",
"new_version"
]
},
"note": {
"type": "string"
},
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"credits",
"alreadyPreparing"
],
"properties": {
"credits": {
"type": "number"
},
"stableShotId": {
"type": "string"
},
"alreadyPreparing": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"outcome": {
"enum": [
"nothing_to_buy"
]
},
"quality": {
"enum": [
"medium",
"high"
]
},
"canAfford": {
"type": "boolean"
},
"expiresAt": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"quoteToken": {
"type": "string"
},
"operationId": {
"type": "string"
},
"creditAmount": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"creditBalance": {
"type": "number"
},
"requestDigest": {
"type": "string"
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"totalGbpInclVat": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"quoteToken",
"quality",
"expiresAt",
"creditAmount",
"creditBalance",
"canAfford",
"shots",
"mode",
"operationId",
"modelId",
"requestDigest",
"stableShotIds",
"totalCredits",
"totalGbpInclVat",
"balance",
"shortfall",
"revisionId",
"priceVersion",
"consentMode",
"shortfallNow",
"topUpCreditsNow",
"topUpGbpInclVatNow",
"fundingMessage",
"approvalState",
"approvalExpiresAt",
"quoteKind",
"note"
],
"properties": {
"mode": {
"enum": [
"missing",
"new_version"
]
},
"note": {
"type": "string"
},
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"credits",
"alreadyPreparing"
],
"properties": {
"credits": {
"type": "number"
},
"stableShotId": {
"type": "string"
},
"alreadyPreparing": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"quality": {
"enum": [
"medium",
"high"
]
},
"canAfford": {
"type": "boolean"
},
"expiresAt": {
"type": "string"
},
"quoteKind": {
"enum": [
"storyboard_stills"
]
},
"shortfall": {
"type": "number"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"consentMode": {
"enum": [
"chat"
]
},
"operationId": {
"type": "string"
},
"creditAmount": {
"type": "number"
},
"priceVersion": {
"type": "string"
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"approvalState": {
"enum": [
"quoted",
"approved",
"video_placing",
"video_awaiting_payment",
"video_placed",
"failed"
]
},
"creditBalance": {
"type": "number"
},
"requestDigest": {
"type": "string"
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"approvalExpiresAt": {
"type": "string"
},
"topUpGbpInclVatNow": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"quoteToken",
"quality",
"expiresAt",
"creditAmount",
"creditBalance",
"canAfford",
"shots",
"mode",
"operationId",
"modelId",
"requestDigest",
"stableShotIds",
"totalCredits",
"totalGbpInclVat",
"balance",
"shortfall",
"quoteKind",
"creditsInformationUrl",
"models",
"note"
],
"properties": {
"mode": {
"enum": [
"missing",
"new_version"
]
},
"note": {
"type": "string"
},
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"credits",
"alreadyPreparing"
],
"properties": {
"credits": {
"type": "number"
},
"stableShotId": {
"type": "string"
},
"alreadyPreparing": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"models": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"credits",
"recommended"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"credits": {
"type": "number"
},
"recommended": {
"const": false
}
},
"additionalProperties": true
}
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"quality": {
"enum": [
"medium",
"high"
]
},
"canAfford": {
"type": "boolean"
},
"expiresAt": {
"type": "string"
},
"quoteKind": {
"enum": [
"storyboard_stills"
]
},
"shortfall": {
"type": "number"
},
"quoteToken": {
"type": "string"
},
"operationId": {
"type": "string"
},
"creditAmount": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"creditBalance": {
"type": "number"
},
"requestDigest": {
"type": "string"
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"totalGbpInclVat": {
"type": "string"
},
"creditsInformationUrl": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Price the storyboard pictures",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| priceVersion | string | Chat mode: exact priceVersion from the picture quote the customer approved. |
| quotedCredits | integer | Chat mode: exact creditAmount shown to and approved by the customer. |
| confirmationToken | string | Brix36-issued confirmation code for these pictures and credits. |
{
"name": "studio_storyboard_stills_confirm",
"title": "Make the confirmed storyboard pictures",
"description": "Spends Brix36 credits for exactly the approved quoted pictures. Chat mode requires the quote's unchanged projectId, revisionId, mode, operationId, quoteToken, modelId, priceVersion and quotedCredits. Insufficient balance returns balance, shortfall and creditsInformationUrl without a checkout. Durable purchase/job reconciliation makes identical retries safe, including after expiry. Legacy confirmationToken remains supported. No video authorization or planning-model call.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"revisionId",
"mode",
"operationId",
"quoteToken",
"modelId"
],
"properties": {
"mode": {
"enum": [
"missing",
"new_version"
],
"type": "string",
"description": "missing prepares selected shots without pictures; new_version buys another picture for exactly one shot that already has one."
},
"modelId": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "The exact modelId label returned with that still quote."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The music-video or Film project id."
},
"quoteToken": {
"type": "string",
"maxLength": 80000,
"minLength": 1,
"description": "The exact opaque quoteToken returned by studio_storyboard_stills_quote."
},
"revisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact storyboard revisionId from studio_sections_read. Identical retries retain the originally quoted revision."
},
"operationId": {
"type": "string",
"pattern": "^op_[A-Za-z0-9_-]{10,120}$",
"maxLength": 130,
"minLength": 1,
"description": "Stable operationId from the picture quote. A new_version operation uses op_ followed by 10–120 letters, digits, underscores or dashes."
},
"priceVersion": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "Chat mode: exact priceVersion from the picture quote the customer approved."
},
"quotedCredits": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Chat mode: exact creditAmount shown to and approved by the customer."
},
"confirmationToken": {
"type": "string",
"maxLength": 80000,
"minLength": 1,
"description": "Brix36-issued confirmation code for these pictures and credits."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"outcome",
"operationId",
"balance",
"shortfall",
"totalCredits",
"priceVersion",
"creditsInformationUrl",
"note"
],
"properties": {
"note": {
"type": "string"
},
"balance": {
"type": "number"
},
"outcome": {
"enum": [
"credits_required"
]
},
"shortfall": {
"type": "number"
},
"operationId": {
"type": "string"
},
"priceVersion": {
"type": "string"
},
"totalCredits": {
"type": "number"
},
"creditsInformationUrl": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"operationId",
"mode",
"note",
"outcome",
"replayed",
"jobIds",
"revisionId",
"failure"
],
"properties": {
"mode": {
"enum": [
"missing",
"new_version"
]
},
"note": {
"type": "string"
},
"jobIds": {
"type": "array",
"items": {
"type": "string"
}
},
"failure": {
"anyOf": [
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"outcome": {
"enum": [
"failed",
"pictures_approved"
]
},
"replayed": {
"type": "boolean"
},
"revisionId": {
"type": [
"string",
"null"
]
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"operationId",
"mode",
"note",
"jobIds",
"queued",
"stableShotIds",
"creditsCharged"
],
"properties": {
"mode": {
"enum": [
"missing",
"new_version"
]
},
"note": {
"type": "string"
},
"jobIds": {
"type": "array",
"items": {
"type": "string"
}
},
"queued": {
"type": "number"
},
"status": {
"enum": [
"committed"
]
},
"replayed": {
"type": "boolean"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"creditsCharged": {
"type": "number"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Make the confirmed storyboard pictures",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}| string |
| Customer-approved song meaning/description. Absence retains the existing value; an empty string clears it. |
| voiceAnswer | object | The customer’s voice-answer decision. Absence leaves ownership unconfirmed. Shape: {answer: "all_me"} | {answer: "skipped"} | {answer: "other_voices", spans: list of {startMs: integer, endMs: integer, label?: string, role?: "feature"|"dj"|"adlib"|"unknown", overlapsArtist?: boolean}} |
| expectedAssetId * | string | Current assetId from studio_song_status analysis: the existing uploaded master, not a new or remote audio source. |
| expectedAnalysisId * | string | Current analysisId from studio_song_status. |
| expectedUnderstandingRevision * | string | Opaque current understandingRevision from studio_song_status. |
{
"name": "studio_song_understanding_write",
"title": "Save customer-authored song understanding",
"description": "Saves finished song understanding against the current analysisId, assetId and understandingRevision. Accepts lyrics/description, language, themes and required words/lines arrays in the timed-transcription shape; empty arrays represent unavailable genuine timing. Source text alone supplies no lip-sync timing or voice ownership. voiceAnswer represents the customer's all_me, other_voices or skipped decision. Preserves measured audio facts and returns canonical understanding with a new revision. Stale input is refused. No transcription/planning model or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"expectedAnalysisId",
"expectedAssetId",
"expectedUnderstandingRevision",
"words",
"lines"
],
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"text",
"startMs",
"endMs"
],
"properties": {
"text": {
"type": "string",
"maxLength": 1000,
"minLength": 1,
"description": "The customer-supplied word or line at this measured timestamp."
},
"endMs": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Actual timestamp on the uploaded master song in whole milliseconds, from supplied timing data."
},
"startMs": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Actual timestamp on the uploaded master song in whole milliseconds, from supplied timing data."
}
},
"additionalProperties": false
},
"maxItems": 600,
"description": "TimedLine text/startMs/endMs, requiring supplied timed words. An empty array leaves section line-sync empty; prose alone supplies no timing."
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"text",
"startMs",
"endMs"
],
"properties": {
"text": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "The customer-supplied word or line at this measured timestamp."
},
"endMs": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Actual timestamp on the uploaded master song in whole milliseconds, from supplied timing data."
},
"startMs": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Actual timestamp on the uploaded master song in whole milliseconds, from supplied timing data."
}
},
"additionalProperties": false
},
"maxItems": 4000,
"description": "Existing TimedWord shape: text/startMs/endMs. Genuine customer-supplied master timing only; [] when unknown. IDs are assigned by the canonical app normalizer."
},
"lyrics": {
"type": "string",
"maxLength": 24000,
"description": "Customer-supplied source lyrics with original line breaks. Absence retains existing lyrics; an empty string clears them."
},
"themes": {
"type": "array",
"items": {
"type": "string",
"maxLength": 180,
"minLength": 1,
"description": "One non-lyrical customer-approved song theme."
},
"maxItems": 8,
"description": "Optional song themes. Absence retains existing themes; [] clears them."
},
"language": {
"type": [
"string",
"null"
],
"maxLength": 35,
"minLength": 1,
"description": "Customer-supplied language, null when unknown. Absence retains the existing language."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project whose currently uploaded master song is being described."
},
"description": {
"type": "string",
"maxLength": 4000,
"description": "Customer-approved song meaning/description. Absence retains the existing value; an empty string clears it."
},
"voiceAnswer": {
"type": "object",
"required": [
"answer"
],
"properties": {
"answer": {
"enum": [
"all_me",
"skipped",
"other_voices"
],
"type": "string"
}
},
"description": "The customer’s voice-answer decision. Absence leaves ownership unconfirmed. Shape: {answer: \"all_me\"} | {answer: \"skipped\"} | {answer: \"other_voices\", spans: list of {startMs: integer, endMs: integer, label?: string, role?: \"feature\"|\"dj\"|\"adlib\"|\"unknown\", overlapsArtist?: boolean}}"
},
"expectedAssetId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Current assetId from studio_song_status analysis: the existing uploaded master, not a new or remote audio source."
},
"expectedAnalysisId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Current analysisId from studio_song_status."
},
"expectedUnderstandingRevision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"maxLength": 64,
"minLength": 64,
"description": "Opaque current understandingRevision from studio_song_status."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"analysisId",
"assetId",
"understandingRevision",
"understanding"
],
"properties": {
"assetId": {
"type": "string"
},
"analysisId": {
"type": "string"
},
"understanding": {
"type": "object",
"required": [
"version",
"sourceAssetId",
"analysisId",
"masterDurationMs",
"language",
"transcription",
"timing",
"attribution",
"words",
"lines",
"speakers",
"segments"
],
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs",
"wordIds"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"wordIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"startMs",
"endMs"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
}
},
"additionalProperties": true
}
},
"lyrics": {
"type": "string"
},
"timing": {
"type": "object",
"required": [
"status",
"model",
"note"
],
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unavailable",
"ready",
"failed",
"instrumental"
]
}
},
"additionalProperties": true
},
"version": {
"enum": [
1
]
},
"language": {
"type": [
"string",
"null"
]
},
"segments": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"speakerId",
"startMs",
"endMs",
"text",
"wordIds",
"role",
"roleSource",
"overlappingSegmentIds"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"lead",
"feature",
"dj",
"adlib",
"unknown"
]
},
"text": {
"type": "string"
},
"endMs": {
"type": "number"
},
"startMs": {
"type": "number"
},
"wordIds": {
"type": "array",
"items": {
"type": "string"
}
},
"speakerId": {
"type": [
"string",
"null"
]
},
"roleSource": {
"enum": [
"engine",
"user",
"unresolved"
]
},
"overlappingSegmentIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"speakers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"label",
"identity",
"evidence"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"evidence": {
"enum": [
"reference_match",
"user_confirmed",
"none"
]
},
"identity": {
"enum": [
"artist",
"unconfirmed"
]
}
},
"additionalProperties": true
}
},
"analysisId": {
"type": "string"
},
"attribution": {
"type": "object",
"required": [
"status",
"model",
"note"
],
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unavailable",
"ready",
"failed",
"instrumental"
]
}
},
"additionalProperties": true
},
"description": {
"type": "string"
},
"sourceAssetId": {
"type": "string"
},
"transcription": {
"type": "object",
"required": [
"status",
"model",
"note"
],
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unavailable",
"ready",
"failed",
"instrumental"
]
}
},
"additionalProperties": true
},
"masterDurationMs": {
"type": "number"
}
},
"additionalProperties": true
},
"understandingRevision": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Save customer-authored song understanding",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}| artistId | string |
| intensity | string | one of ["subtle","normal","high","standard"] |
| projectId * | string |
| requestId * | string |
| artistName | string |
| templateId | string | one of ["lyric_video","audio_visualiser","living_cover","kinetic_type","club_tunnel","organic_landscape"] |
| audioAssetId | string |
| imageAssetId | string |
| durationSeconds * | number |
| trimStartSeconds | number |
| approvedAlignmentId | string |
| expectedArtistRevision | integer |
{
"name": "studio_motion_create",
"title": "Create Motion Graphics",
"description": "Saves a ready server-rendered Motion scene and returns its exact paid-render quote plus an optional free first-frame preview. Supports lyric video, beat-reactive visualiser, kinetic titles, photo-motion poster, promo cards, the 6 music/lyric/visualiser templates (lyric_video, audio_visualiser, living_cover, kinetic_type, club_tunnel, organic_landscape) across 7 genre looks (pop, hiphop_drill, rnb, house_edm, rock, country_acoustic, afrobeats), and all 24 popular motion styles (styleId). Uses owned audio and picture asset IDs; saved song timing supplies lyric cues and the saved scene can be edited. No AI video model or paid render is called. requestId identifies the saved document across retries. Each returned quote has its own identity; rendering requires explicit customer approval bound to that quote.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"requestId",
"family",
"durationSeconds",
"aspect"
],
"properties": {
"style": {
"enum": [
"bars",
"waves",
"particles"
],
"type": "string"
},
"title": {
"type": "string",
"maxLength": 2000
},
"aspect": {
"enum": [
"16:9",
"9:16"
],
"type": "string"
},
"family": {
"enum": [
"lyric_video",
"beat_visualiser",
"kinetic_text",
"photo_poster",
"promo_cards"
],
"type": "string"
},
"lookId": {
"enum": [
"pop",
"hiphop_drill",
"rnb",
"house_edm",
"rock",
"country_acoustic",
"afrobeats"
],
"type": "string"
},
"lyrics": {
"type": "string",
"maxLength": 100000
},
"styleId": {
"enum": [
"3d-text-flight",
"album-teaser",
"audio-visualiser",
"bold-hook",
"cast-billing",
"chapter-cards",
"chat-story",
"clean-creator",
"colour-pop",
"data-and-map",
"data-map-charts",
"festival-lineup",
"genre-title-cards",
"glass-keynote",
"grunge-rock",
"hype-countdown",
"karaoke-lyrics",
"kinetic-lyric",
"kinetic-typography",
"liquid-shaders",
"lower-thirds",
"neon-club",
"newsroom",
"opening-credits",
"paper-and-ink",
"parallax-25d",
"particle-text",
"product-drop",
"sing-along-karaoke",
"social-proof",
"street-grit",
"trailer-slam",
"velvet-cinematic",
"vinyl-spin",
"vox-collage",
"vox-collage-explainer"
],
"type": "string"
},
"artistId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1
},
"intensity": {
"enum": [
"subtle",
"normal",
"high",
"standard"
],
"type": "string"
},
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"requestId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 8
},
"artistName": {
"type": "string",
"maxLength": 160
},
"templateId": {
"enum": [
"lyric_video",
"audio_visualiser",
"living_cover",
"kinetic_type",
"club_tunnel",
"organic_landscape"
],
"type": "string"
},
"audioAssetId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1
},
"imageAssetId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1
},
"durationSeconds": {
"type": "number",
"maximum": 180,
"minimum": 1
},
"trimStartSeconds": {
"type": "number",
"maximum": 7200,
"minimum": 0
},
"approvedAlignmentId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1
},
"expectedArtistRevision": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"revision",
"preview",
"quote"
],
"properties": {
"quote": {
"type": "object",
"required": [
"operationId",
"quoteToken",
"estimateId",
"revisionId",
"inputDigest",
"credits",
"expiresAt",
"output",
"durationFrames",
"fps"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"credits": {
"type": "number"
},
"currency": {
"enum": [
"GBP"
]
},
"expiresAt": {
"type": "string"
},
"estimateId": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"inputDigest": {
"type": "string"
},
"operationId": {
"type": "string"
},
"vatIncluded": {
"const": true
},
"approvalScope": {
"enum": [
"writing_preview_render"
]
},
"durationFrames": {
"type": "number"
},
"pricingVersion": {
"type": "string"
},
"customerDueMinor": {
"type": "number"
}
},
"additionalProperties": true
},
"preview": {
"anyOf": [
{
"type": "object",
"required": [
"revisionId",
"inputDigest",
"frame",
"width",
"height",
"assetUrl",
"expiresAt"
],
"properties": {
"frame": {
"enum": [
0
]
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"assetUrl": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"inputDigest": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"revision": {
"type": "object",
"required": [
"documentId",
"projectId",
"revisionId",
"revision",
"sceneDigest",
"scene"
],
"properties": {
"scene": {
"anyOf": [
{
"type": "object",
"required": [
"version",
"family",
"fps",
"durationFrames",
"output",
"background",
"palette",
"layers"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"audio": {
"type": "object",
"required": [
"assetId",
"sourceStartFrame",
"volume"
],
"properties": {
"volume": {
"type": "number"
},
"assetId": {
"type": "string"
},
"sourceStartFrame": {
"type": "number"
}
},
"additionalProperties": true
},
"family": {
"enum": [
"lyric_video",
"beat_visualiser",
"photo_poster",
"promo_cards",
"titles",
"kinetic_text",
"captions",
"logo_animation",
"charts",
"slides",
"lower_thirds"
]
},
"layers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"text"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"role": {
"enum": [
"title",
"credit",
"endcard",
"kinetic",
"lower_third"
]
},
"text": {
"type": "string"
},
"type": {
"enum": [
"text"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"cues"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"cues": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"role": {
"enum": [
"lyrics",
"captions"
]
},
"type": {
"enum": [
"cues"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"role",
"assetId",
"sourceStartFrame",
"fit"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"fit": {
"enum": [
"contain",
"cover"
]
},
"role": {
"enum": [
"logo",
"image",
"clip"
]
},
"type": {
"enum": [
"media"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"assetId": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"sourceStartFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"chart",
"title",
"series"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"chart"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"chart": {
"enum": [
"bar",
"line",
"pie"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"series": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value",
"color"
],
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"title",
"body",
"accent"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"body": {
"type": "string"
},
"type": {
"enum": [
"slide"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"accent": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"style",
"color"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"visualiser"
]
},
"color": {
"type": "string"
},
"style": {
"enum": [
"bars",
"waves",
"particles",
"ring"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"enum": [
1
]
},
"background": {
"type": "string"
},
"durationFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"version",
"family",
"fps",
"durationFrames",
"output",
"background",
"palette",
"layers",
"recipe"
],
"properties": {
"fps": {
"enum": [
24,
25,
30
]
},
"audio": {
"type": "object",
"required": [
"assetId",
"sourceStartFrame",
"volume"
],
"properties": {
"volume": {
"type": "number"
},
"assetId": {
"type": "string"
},
"sourceStartFrame": {
"type": "number"
}
},
"additionalProperties": true
},
"family": {
"enum": [
"lyric_video",
"beat_visualiser",
"photo_poster",
"promo_cards",
"titles",
"kinetic_text",
"captions",
"logo_animation",
"charts",
"slides",
"lower_thirds"
]
},
"layers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"text"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"role": {
"enum": [
"title",
"credit",
"endcard",
"kinetic",
"lower_third"
]
},
"text": {
"type": "string"
},
"type": {
"enum": [
"text"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"role",
"cues"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"cues": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"type": "object",
"required": [
"startFrame",
"endFrame",
"text"
],
"properties": {
"text": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
}
},
"additionalProperties": true
}
},
"role": {
"enum": [
"lyrics",
"captions"
]
},
"type": {
"enum": [
"cues"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"role",
"assetId",
"sourceStartFrame",
"fit"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"fit": {
"enum": [
"contain",
"cover"
]
},
"role": {
"enum": [
"logo",
"image",
"clip"
]
},
"type": {
"enum": [
"media"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"assetId": {
"type": "string"
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"sourceStartFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"chart",
"title",
"series"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"chart"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"chart": {
"enum": [
"bar",
"line",
"pie"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"series": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value",
"color"
],
"properties": {
"color": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"additionalProperties": true
}
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"fontId",
"fontSize",
"color",
"align",
"type",
"title",
"body",
"accent"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"body": {
"type": "string"
},
"type": {
"enum": [
"slide"
]
},
"align": {
"enum": [
"left",
"center",
"right"
]
},
"color": {
"type": "string"
},
"title": {
"type": "string"
},
"accent": {
"type": "string"
},
"fontId": {
"type": "string"
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"fontSize": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"id",
"startFrame",
"endFrame",
"box",
"motion",
"transitionFrames",
"type",
"style",
"color"
],
"properties": {
"id": {
"type": "string"
},
"box": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": true
},
"type": {
"enum": [
"visualiser"
]
},
"color": {
"type": "string"
},
"style": {
"enum": [
"bars",
"waves",
"particles",
"ring"
]
},
"motion": {
"enum": [
"none",
"fade",
"rise",
"slide_left",
"scale"
]
},
"endFrame": {
"type": "number"
},
"startFrame": {
"type": "number"
},
"transitionFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"output": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"format": {
"enum": [
"png"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"recipe": {
"type": "object",
"required": [
"id",
"version",
"lookId",
"lookVersion",
"engine",
"fontId",
"fontHash",
"artistId",
"artistRevision",
"artistDigest",
"featureDigest",
"featureVersion",
"sources",
"intensity"
],
"properties": {
"id": {
"enum": [
"lyric_video",
"audio_visualiser",
"living_cover",
"kinetic_type",
"club_tunnel",
"organic_landscape"
]
},
"engine": {
"enum": [
"ffmpeg-templates.v1"
]
},
"fontId": {
"type": "string"
},
"lookId": {
"enum": [
"pop",
"hiphop_drill",
"rnb",
"house_edm",
"rock",
"country_acoustic",
"afrobeats"
]
},
"sources": {
"type": "array",
"items": {
"type": "object",
"required": [
"assetId",
"hash"
],
"properties": {
"hash": {
"type": "string"
},
"assetId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"version": {
"enum": [
1
]
},
"artistId": {
"type": "string"
},
"fontHash": {
"type": "string"
},
"intensity": {
"enum": [
"subtle",
"standard"
]
},
"alignmentId": {
"type": "string"
},
"lookVersion": {
"enum": [
1
]
},
"artistDigest": {
"type": "string"
},
"alignmentHash": {
"type": "string"
},
"featureDigest": {
"type": "string"
},
"artistRevision": {
"type": "number"
},
"featureVersion": {
"enum": [
"audio-window.v1"
]
}
},
"additionalProperties": true
},
"palette": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"enum": [
2
]
},
"background": {
"type": "string"
},
"durationFrames": {
"type": "number"
}
},
"additionalProperties": true
}
]
},
"revision": {
"type": "number"
},
"projectId": {
"type": "string"
},
"documentId": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"sceneDigest": {
"type": "string"
}
},
"additionalProperties": true
},
"previewUnavailable": {
"const": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Create Motion Graphics",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}| catalogueArtistId | string | Optional existing artist identifying the catalogue for creation. Not needed for a single-catalogue account. |
{
"name": "studio_artist_create",
"title": "Create Brix36 artist",
"description": "Creates an artist through the app service and returns profile and revision. Name is required; photos use dedicated upload/reference tools. catalogueArtistId optionally selects a manageable catalogue through an existing artist. Creation has no replay receipt; the artist list exposes persisted results after an uncertain response. No generation or charge.",
"inputSchema": {
"type": "object",
"required": [
"name"
],
"properties": {
"bio": {
"type": "string",
"maxLength": 4000,
"description": "Artist biography; an empty string clears it."
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "New artist name."
},
"genres": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "One value."
},
"maxItems": 24,
"description": "Artist genres. An empty array clears the list."
},
"location": {
"type": "string",
"maxLength": 120,
"description": "Artist location; an empty string clears it."
},
"influences": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "One value."
},
"maxItems": 24,
"description": "Artist influences. An empty array clears the list."
},
"identityKind": {
"enum": [
"real_person",
"fictional_character"
],
"type": "string",
"description": "Factual identity of the new artist. Real person by default. Adding a real face photo follows the app real-person rules."
},
"visualKeywords": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "One value."
},
"maxItems": 24,
"description": "Artist visual keywords. An empty array clears the list."
},
"primaryLanguage": {
"type": "string",
"maxLength": 60,
"description": "Artist primary language; an empty string clears it."
},
"recurringThemes": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "One value."
},
"maxItems": 24,
"description": "Artist recurring themes. An empty array clears the list."
},
"catalogueArtistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Optional existing artist identifying the catalogue for creation. Not needed for a single-catalogue account."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"workspaceId",
"name",
"genres",
"identityPackStatus",
"identityReferenceCount",
"activeProjectCount",
"updatedAt",
"revision"
],
"properties": {
"id": {
"type": "string"
},
"bio": {
"type": "string"
},
"name": {
"type": "string"
},
"avatar": {
"type": "object",
"required": [
"kind",
"value",
"alt"
],
"properties": {
"alt": {
"type": "string"
},
"kind": {
"enum": [
"gradient",
"upload"
]
},
"value": {
"type": "string"
}
},
"additionalProperties": true
},
"genres": {
"type": "array",
"items": {
"type": "string"
}
},
"voiceId": {
"type": [
"string",
"null"
]
},
"location": {
"type": "string"
},
"revision": {
"type": "number"
},
"updatedAt": {
"type": "string"
},
"influences": {
"type": "array",
"items": {
"type": "string"
}
},
"faceCovered": {
"type": "boolean"
},
"workspaceId": {
"type": "string"
},
"activeTakeId": {
"type": [
"string",
"null"
]
},
"identityKind": {
"enum": [
"real_person",
"fictional_character"
]
},
"packCoverage": {
"enum": [
3,
5,
null
]
},
"characterSpec": {
"anyOf": [
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": true
},
{
"type": "null"
}
]
},
"latestProject": {
"type": "object",
"required": [
"id",
"title",
"status",
"progress",
"updatedAt"
],
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"enum": [
"brief",
"storyboard",
"generating",
"review",
"complete"
]
},
"progress": {
"type": "number"
},
"songTitle": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"releaseTitle": {
"type": "string"
}
},
"additionalProperties": true
},
"visualKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"primaryLanguage": {
"type": "string"
},
"recurringThemes": {
"type": "array",
"items": {
"type": "string"
}
},
"preferredPalette": {
"type": "array",
"items": {
"type": "string"
}
},
"profileCompletion": {
"type": "number"
},
"activeProjectCount": {
"type": "number"
},
"identityPackStatus": {
"enum": [
"empty",
"draft",
"ready",
"needs_attention"
]
},
"identityPackVersion": {
"type": "number"
},
"identityReferenceCount": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Create Brix36 artist",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}{
"name": "studio_library_list",
"title": "List unified Brix36 Hub Library creations",
"description": "Lists the customer unified Hub Library across Web QuickCreate/DirectCreate, Mobile and ChatGPT (videos, images, audio and edits), with signed preview URLs, webUrl links to open in the Brix36 Web Studio or NLE Editor, and nextCursor. Free and read-only. A finished item also carries a watch link that opens it full size to watch, share or download, a remake link that opens where it is made again (the storyboard for a video), and the finished actions watch, share and remake. The preview is the video or picture itself, so a finished item is shown from its preview first, and the remake link is for a customer who wants it made again or changed. A to-finish item carries none of these finished links.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"kind": {
"enum": [
"video",
"image",
"audio",
"edit"
],
"type": "string",
"description": "Optional media kind filter."
},
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum items to return, 1–50. Default 20."
},
"cursor": {
"type": "string",
"maxLength": 512,
"minLength": 1,
"description": "Opaque previous-page nextCursor; absent for the first page."
},
"status": {
"enum": [
"draft",
"accepted",
"queued",
"submitting",
"running",
"reconciling",
"succeeded",
"failed",
"cancelled"
],
"type": "string",
"description": "Optional creation status filter."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Optional artist ID filter."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Optional project ID filter."
},
"libraryBucket": {
"enum": [
"finished",
"to_finish"
],
"type": "string",
"description": "Optional tab bucket filter: 'finished' or 'to_finish'."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"kind",
"title",
"state",
"createdAt",
"canReuse",
"canDelete"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"image",
"video",
"audio",
"edit"
]
},
"state": {
"enum": [
"draft",
"storyboard",
"making",
"ready",
"needs_attention",
"accepted",
"queued",
"submitting",
"running",
"reconciling",
"succeeded",
"failed",
"cancelled",
"saved",
"timed_out",
"refunded"
]
},
"title": {
"type": "string"
},
"webUrl": {
"type": "string"
},
"assetId": {
"type": "string"
},
"editUrl": {
"type": "string"
},
"artistId": {
"type": [
"string",
"null"
]
},
"canReuse": {
"type": "boolean"
},
"watchUrl": {
"type": "string"
},
"canDelete": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"projectId": {
"type": "string"
},
"remakeUrl": {
"type": "string"
},
"artistName": {
"type": [
"string",
"null"
]
},
"creationId": {
"type": "string"
},
"modelLabel": {
"type": "string"
},
"previewUrl": {
"type": "string"
},
"displayName": {
"type": "string"
},
"operationId": {
"type": "string"
},
"creationMode": {
"enum": [
"motion"
]
},
"libraryGroup": {
"enum": [
"finished",
"in_progress",
"carry_on",
"needs_attention"
]
},
"libraryAction": {
"enum": [
"open",
"carry_on",
"none"
]
},
"libraryBucket": {
"enum": [
"finished",
"to_finish"
]
},
"sectionsReady": {
"type": "number"
},
"sectionsTotal": {
"type": "number"
},
"previewIsInput": {
"type": "boolean"
},
"finishedActions": {
"type": "array",
"items": {
"enum": [
"watch",
"share",
"remake"
]
}
},
"libraryInFlight": {
"type": "boolean"
},
"motionDocumentId": {
"type": "string"
},
"libraryStatusLabel": {
"type": "string"
}
},
"additionalProperties": true
}
},
"counts": {
"type": "object",
"required": [
"finished",
"toFinish",
"inProgress",
"carryOn",
"needsAttention"
],
"properties": {
"carryOn": {
"type": "number"
},
"finished": {
"type": "number"
},
"toFinish": {
"type": "number"
},
"inProgress": {
"type": "number"
},
"needsAttention": {
"type": "number"
}
},
"additionalProperties": true
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "List unified Brix36 Hub Library creations",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "studio_reference_add",
"title": "Add customer reference file",
"description": "Stores and screens an image/video reference through the app attachment service. Inline files are limited to 512 KiB; larger files have an app upload-link path. Returns attachment and signed preview. scope:project applies to the project; scope:shot supports later shot binding. The reference list exposes persisted results after uncertain replies. No language model or generation-credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"kind",
"name",
"mimeType",
"bytesBase64"
],
"properties": {
"kind": {
"enum": [
"reference_image",
"reference_video"
],
"type": "string",
"description": "Existing reference media kind."
},
"name": {
"type": "string",
"maxLength": 260,
"minLength": 1,
"description": "File display name, for example wardrobe.webp."
},
"scope": {
"enum": [
"project",
"shot"
],
"type": "string",
"description": "Whole project by default; shot is supported only for an image."
},
"mimeType": {
"enum": [
"image/png",
"image/jpeg",
"image/webp",
"image/avif",
"video/mp4",
"video/quicktime",
"video/webm"
],
"type": "string",
"description": "Actual MIME type. It must match the kind and file bytes."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
},
"bytesBase64": {
"type": "string",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"maxLength": 699052,
"minLength": 4,
"description": "Canonical base64 file bytes without a data URL prefix, up to 512 KiB decoded. Larger files have an app upload-link path."
},
"intendedAtMs": {
"type": "integer",
"minimum": 0,
"description": "Optional song position for a shot-scoped image; this records intent and does not bind a shot."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"assetId",
"contentHash",
"kind",
"name",
"scope",
"contentUrl",
"size",
"screeningVerdict",
"pictureUsage",
"usageMessage",
"analysisStarted"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"reference_image",
"reference_video",
"audio"
]
},
"name": {
"type": "string"
},
"size": {
"type": "number"
},
"scope": {
"enum": [
"project",
"shot"
]
},
"assetId": {
"type": "string"
},
"contentUrl": {
"type": "string"
},
"contentHash": {
"type": "string"
},
"intendedAtMs": {
"type": "number"
},
"pictureUsage": {
"enum": [
"image",
"clip_frame",
"not_used"
]
},
"usageMessage": {
"type": "string"
},
"smallPhotoNote": {
"type": "string"
},
"analysisStarted": {
"const": false
},
"screeningReason": {
"type": "string"
},
"pictureReference": {
"type": "object",
"required": [
"attachmentId",
"assetId",
"contentUrl"
],
"properties": {
"assetId": {
"type": "string"
},
"contentUrl": {
"type": "string"
},
"attachmentId": {
"type": "string"
}
},
"additionalProperties": true
},
"screeningVerdict": {
"enum": [
"passed",
"failed",
"manual_review"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Add customer reference file",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}{
"name": "studio_project_output_set",
"title": "Choose a Film or music video shape and quality",
"description": "Saves the project's film shape and quality through the same app service as Brix36. aspect is required (16:9 widescreen, 9:16 upright, 1:1 square); resolution keeps the saved choice when omitted. expectedRevision is optional: when present it is the project revision returned by an earlier answer of this tool and a stale one is refused; when absent the current project is used. A change starts a new version of the storyboard the same way the app does. Pictures already on the storyboard belong to the earlier shape and quality: they stay on the earlier version and are not carried onto the new one, where pictures are made or attached again. With such pictures present and without confirmPicturesRemade:true, nothing is changed and the result is changed:false with picturesAffected and an explanatory note. Returns the saved outputIntent, a customer-words shape and quality, the project revision and every available aspect/resolution. No generation or charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"aspect"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
],
"type": "string",
"description": "The shape the customer wants. Phones and social feeds are upright (9:16); widescreen is 16:9; square is 1:1."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project ID returned by studio_projects_list or studio_video_start."
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
],
"type": "string",
"description": "Optional quality. Absent keeps the saved one, else the project default (720p standard for Film; 1080p for music videos or Film HD upgrade)."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "Current revision from the latest read. Stale revisions are refused."
},
"confirmPicturesRemade": {
"type": "boolean",
"description": "True records that the customer was told the pictures already on this storyboard are not carried onto the new shape, and agreed. The customer’s own agreement is its only valid source."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"revision",
"outputIntent",
"shape",
"quality",
"available",
"note"
],
"properties": {
"note": {
"type": "string"
},
"shape": {
"type": "string"
},
"changed": {
"type": "boolean"
},
"quality": {
"type": "string"
},
"revision": {
"type": "number"
},
"available": {
"type": "array",
"items": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
}
},
"projectId": {
"type": "string"
},
"outputIntent": {
"type": "object",
"required": [
"version",
"aspect",
"resolution",
"modelPreference"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"version": {
"enum": [
1
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
},
"modelPreference": {
"anyOf": [
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"enum": [
"auto"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"kind",
"modelKey"
],
"properties": {
"kind": {
"enum": [
"model"
]
},
"modelKey": {
"type": "string"
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
"picturesAffected": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Choose a Film or music video shape and quality",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}| confirmationToken | string | Optional: an existing Brix36 approval code instead of in-chat consent. |
| inspirationAssetIds | array | Look only, optional: up to four owned inspiration photos. Send the same list to quote and confirm. |
{
"name": "studio_artist_reference_pack_confirm",
"title": "Buy the approved artist reference pack",
"description": "Places the one quoted reference-pack purchase only after the customer has explicitly approved the exact credits in this chat. Takes the exact operationId, quoteToken, quotedCredits and priceVersion from the quote (and the same look inputs); an existing Brix36 approval code is accepted as confirmationToken instead. Identical retries return the first outcome and never charge twice. status still_checking keeps the original operation; an identical later call returns its outcome without a new price.",
"inputSchema": {
"type": "object",
"required": [
"artistId",
"kind",
"operationId",
"quoteToken"
],
"properties": {
"kind": {
"enum": [
"photo_pack",
"look"
],
"type": "string",
"description": "photo_pack: missing views from their existing photo. look: an invented look for an artist with no customer photo."
},
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The artist, from studio_artists_list or studio_artist_create."
},
"quoteToken": {
"type": "string",
"maxLength": 8192,
"minLength": 1,
"description": "Exact signed quote."
},
"operationId": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Exact quoted operation ID."
},
"priceVersion": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The priceVersion returned by the quote."
},
"quotedCredits": {
"type": "integer",
"maximum": 1000000,
"minimum": 1,
"description": "The exact credits the customer approved in chat."
},
"lookDescription": {
"type": "string",
"maxLength": 1000,
"minLength": 1,
"description": "Look only: the look to make, up to 1000 characters. Send the same text to quote and confirm."
},
"confirmationToken": {
"type": "string",
"maxLength": 4096,
"minLength": 1,
"description": "Optional: an existing Brix36 approval code instead of in-chat consent."
},
"inspirationAssetIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Owned inspiration photo asset."
},
"maxItems": 4,
"description": "Look only, optional: up to four owned inspiration photos. Send the same list to quote and confirm.",
"uniqueItems": true
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"anyOf": [
{
"type": "object",
"required": [
"artistId",
"kind",
"operationId",
"status",
"pack",
"note"
],
"properties": {
"kind": {
"enum": [
"photo_pack",
"look"
]
},
"note": {
"type": "string"
},
"pack": {
"type": "object",
"required": [
"id",
"version",
"status",
"references",
"blockers",
"missingAngles",
"weakPhotos",
"authorizationStatus",
"publishable"
],
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"draft",
"published",
"superseded",
"needs_attention"
]
},
"version": {
"type": "number"
},
"blockers": {
"type": "array",
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"angle",
"contentUrl",
"screeningVerdict",
"createdAt",
"origin",
"confirmedAt"
],
"properties": {
"id": {
"type": "string"
},
"angle": {
"type": "string"
},
"origin": {
"enum": [
"photograph",
"generated"
]
},
"createdAt": {
"type": "string"
},
"contentUrl": {
"type": "string"
},
"confirmedAt": {
"type": [
"string",
"null"
]
},
"screeningVerdict": {
"type": "string"
}
},
"additionalProperties": true
}
},
"weakPhotos": {
"type": "boolean"
},
"publishable": {
"type": "boolean"
},
"missingAngles": {
"type": "array",
"items": {
"type": "string"
}
},
"authorizationStatus": {
"type": "string"
}
},
"additionalProperties": true
},
"status": {
"enum": [
"settled"
]
},
"artistId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"artistId",
"kind",
"operationId",
"quoteToken",
"status",
"outcomeUnknown",
"note"
],
"properties": {
"kind": {
"enum": [
"photo_pack",
"look"
]
},
"note": {
"type": "string"
},
"status": {
"enum": [
"still_checking"
]
},
"artistId": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"operationId": {
"type": "string"
},
"outcomeUnknown": {
"const": true
},
"earlierOperationId": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Buy the approved artist reference pack",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}| ["string","null"] |
| The exact revisionId from studio_sections_read; null only for a Film with no storyboard. |
{
"name": "studio_film_scenes_write",
"title": "Save finished Film scenes",
"description": "Saves finished Film scenes, visualWorld, camera directions and dialogue against the current revision. Scenes form 30-second cards, with at most six spoken lines per card and five minutes per Film. Identical operationId/input retries return the saved result. visualWorld is required for quoting. No Brix36 planning model, media generation or credit charge. Each scene's sound comes from the scene's text unless stated. Music is included only when sound.music is true.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevisionId",
"language",
"castIds",
"scenes"
],
"properties": {
"scenes": {
"type": "array",
"items": {
"type": "object",
"description": "Shape: {what: string, camera: string, lines?: list of {speakerId: string, parenthetical: string, text: string, onCamera: boolean, useCharacterVoice?: boolean, voiceDescription?: string}, sound?: {music?: boolean, effects?: boolean, background?: boolean}}"
},
"maxItems": 240,
"minItems": 1
},
"castIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "An available artist/actor in this Film’s workspace, in cast-slot order."
},
"maxItems": 6,
"uniqueItems": true
},
"language": {
"type": "string",
"maxLength": 35,
"minLength": 1,
"description": "The selected supported Film language; studio_film_read with include:['languages'] lists them. Text is preserved, never translated."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "A project created by studio_video_start with kind film."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"visualWorld": {
"type": "object",
"required": [
"timeOfDay",
"light",
"setting"
],
"properties": {
"light": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"never": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"props": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"artist": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"palette": {
"type": "array",
"items": {
"type": "string",
"pattern": "^#[0-9A-F]{6}$"
},
"maxItems": 5,
"description": "Optional creator-selected palette: 0–5 unique uppercase #RRGGBB colours.",
"uniqueItems": true
},
"setting": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"vehicles": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"locations": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"timeOfDay": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"characters": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
}
},
"description": "Board-wide visual facts. Optional characters, vehicles, locations, props and never are arrays of up to 12 non-empty strings, each at most 300 characters. Combined rendered fields are limited to 2,400 characters including labels, separators and newlines after trimming. Scene-specific costume and visual direction belong to scene text.",
"additionalProperties": false
},
"expectedRevisionId": {
"type": [
"string",
"null"
],
"maxLength": 64,
"minLength": 1,
"description": "The exact revisionId from studio_sections_read; null only for a Film with no storyboard."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"projectId",
"outcome",
"revisionId",
"revision",
"language",
"sceneCount",
"totalMs",
"note"
],
"properties": {
"note": {
"type": "string"
},
"outcome": {
"enum": [
"created",
"replayed"
]
},
"totalMs": {
"type": "number"
},
"language": {
"type": "string"
},
"revision": {
"type": "number"
},
"projectId": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"sceneCount": {
"type": "number"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Save finished Film scenes",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "studio_storyboard_submit",
"title": "Save a finished storyboard",
"description": "Validates and saves a finished Music storyboard with one DirectedShot per fixed shot order, exact expectedRevisionId/audioAnalysisId, optional treatment and visualWorld. Creates an immutable revision while preserving server-owned timing. visualWorld is required for quoting. No model, queue, provider or credit use.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"expectedRevisionId",
"audioAnalysisId",
"shots"
],
"properties": {
"shots": {
"type": "array",
"items": {
"type": "object",
"description": "Shape: {order: integer, label: string, description: string, visual: string, setup: string, role: \"hook-anchor\"|\"verse\"|\"insert\"|\"payoff\", performance: boolean, motion: string, camera: string, references: list of {evidenceId: string, useMode: \"style_reference\"|\"generation_input\", reason: string}, identityTarget?: \"artist\"|\"none\", sectionDirection?: string or null, referenceAttachmentIds?: list of string}"
},
"maxItems": 240,
"minItems": 1,
"description": "Finished direction, exactly one entry per server-owned shot order."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Existing music-video project id."
},
"treatment": {
"type": "object",
"required": [
"family",
"title",
"summary",
"visualDirection",
"storyApproach"
],
"properties": {
"title": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Treatment title."
},
"family": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "The app treatment family, or an open/custom family."
},
"summary": {
"type": "string",
"maxLength": 800,
"minLength": 1,
"description": "Customer-readable treatment."
},
"storyApproach": {
"type": "string",
"maxLength": 1200,
"minLength": 1,
"description": "How the story is told."
},
"artistCoverage": {
"type": "string",
"maxLength": 1000,
"minLength": 1,
"description": "Where the artist appears."
},
"setupContinuity": {
"type": "string",
"maxLength": 1000,
"minLength": 1,
"description": "Continuity across setups."
},
"visualDirection": {
"type": "string",
"maxLength": 1200,
"minLength": 1,
"description": "The visual treatment."
},
"customFamilyLabel": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "Name for a custom treatment family."
},
"performanceApproach": {
"type": "string",
"maxLength": 1000,
"minLength": 1,
"description": "How delivery to camera is used."
}
},
"additionalProperties": false
},
"visualWorld": {
"type": "object",
"required": [
"timeOfDay",
"light",
"setting"
],
"properties": {
"light": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"never": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"props": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"artist": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"palette": {
"type": "array",
"items": {
"type": "string",
"pattern": "^#[0-9A-F]{6}$"
},
"maxItems": 5,
"description": "Optional creator-selected palette: 0–5 unique uppercase #RRGGBB colours.",
"uniqueItems": true
},
"setting": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"vehicles": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"locations": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
},
"timeOfDay": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"characters": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 300,
"minLength": 1,
"description": "A non-empty concrete visual fact; 300 characters at most."
},
"maxItems": 12
}
},
"description": "Board-wide visual facts. Optional characters, vehicles, locations, props and never are arrays of up to 12 non-empty strings, each at most 300 characters. Combined rendered fields are limited to 2,400 characters including labels, separators and newlines after trimming. Scene-specific costume and visual direction belong to scene text.",
"additionalProperties": false
},
"audioAnalysisId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact current song analysis id returned by the context."
},
"targetShotCount": {
"type": "integer",
"maximum": 240,
"minimum": 1,
"description": "Optional first-board shot count used when reading the context. Existing timing is preserved."
},
"expectedRevisionId": {
"type": [
"string",
"null"
],
"maxLength": 64,
"minLength": 1,
"description": "Exact current revision id, or null only for the first storyboard."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"revisionId",
"revision",
"shotCount",
"directionStatus",
"authoredBy",
"treatmentVersionId",
"note"
],
"properties": {
"note": {
"type": "string"
},
"revision": {
"type": "number"
},
"projectId": {
"type": "string"
},
"shotCount": {
"type": "number"
},
"authoredBy": {
"enum": [
"customer_ai"
]
},
"revisionId": {
"type": "string"
},
"directionStatus": {
"type": "string"
},
"treatmentVersionId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Save a finished storyboard",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}| Whose face the targeted shot(s) carry: "artist" when the featured artist is visibly shown, or "none" for person-free shots (scenery, vehicles, objects, detail inserts, obscured figures, or other people). |
| expectedRevisionId * | string | Exact current storyboard revision from studio_storyboard_context. |
| referenceAttachmentIds | array | Replacement reference bindings for the targeted shots. [] clears; omitted inherits. |
{
"name": "studio_storyboard_edit_prompt",
"title": "Save a finished video, section or still prompt",
"description": "Saves finished prompt text, identityTarget ('artist' or 'none') and existing uploaded references as an immutable storyboard revision. Whole/section scope writes shared sectionDirection; shot/still scope writes frame description and optional motion/camera. Set identityTarget='none' for person-free shots so pictures skip artist photos, face swap and likeness checks while unchanged stills carry forward. References replace targeted bindings; [] clears and omission inherits. Requires the current revision. No pictures, video, planning model or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"expectedRevisionId",
"scope"
],
"properties": {
"scope": {
"enum": [
"whole",
"section",
"shot",
"still"
],
"type": "string",
"description": "Whole/section saves a shared sectionDirection; shot/still edits the visible frame prompt."
},
"camera": {
"type": "string",
"maxLength": 4000,
"minLength": 1,
"description": "Finished camera movement for a shot/still."
},
"motion": {
"type": "string",
"maxLength": 4000,
"minLength": 1,
"description": "Finished subject movement for a shot/still."
},
"prompt": {
"type": "string",
"maxLength": 4000,
"minLength": 1,
"description": "Finished prompt, at most 4,000 characters for shot/still or 2,000 for whole/section. The server fits saved direction to the selected engine."
},
"shotId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Current stable shot id, required for shot or still scope."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project identified by the current storyboard read."
},
"sectionIndex": {
"type": "integer",
"maximum": 239,
"minimum": 0,
"description": "Current section index, required for section scope."
},
"identityTarget": {
"enum": [
"artist",
"none"
],
"type": "string",
"description": "Whose face the targeted shot(s) carry: \"artist\" when the featured artist is visibly shown, or \"none\" for person-free shots (scenery, vehicles, objects, detail inserts, obscured figures, or other people)."
},
"expectedRevisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact current storyboard revision from studio_storyboard_context."
},
"referenceAttachmentIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Existing shot-scoped reference attachment in this project."
},
"maxItems": 8,
"description": "Replacement reference bindings for the targeted shots. [] clears; omitted inherits.",
"uniqueItems": true
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"projectId",
"revisionId",
"revision",
"editedShotIds",
"authoredBy",
"note"
],
"properties": {
"note": {
"type": "string"
},
"revision": {
"type": "number"
},
"projectId": {
"type": "string"
},
"authoredBy": {
"enum": [
"customer_ai"
]
},
"revisionId": {
"type": "string"
},
"editedShotIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Save a finished video, section or still prompt",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}| expectedRevisionId * |
| string |
| Exact current storyboard revision from studio_storyboard_context. |
{
"name": "studio_section_engine_select",
"title": "Choose one section’s engine or generation profile and receive its quote",
"description": "Selects an available modelName or generation profile for one quoted section and returns a revised signed quote with costEstimateId. Film uses saved scene.index. modelName:null restores the server-ranked Recommended choice; omitted modelName preserves explicit selections. profile {aspect,resolution} is constrained to availableProfiles. Other sections retain their choices; outputs fit the project canvas without cropping. The revised quote has its own price and approval binding. operationId identifies identical selection retries. Film speech data reports the actual per-scene routes or historical_unavailable. No credits are spent and no generation starts.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"expectedRevisionId",
"costEstimateId",
"sectionIndex",
"operationId"
],
"properties": {
"profile": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
],
"type": "string"
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
],
"type": "string"
}
},
"additionalProperties": false
},
"modelName": {
"type": [
"string",
"null"
],
"maxLength": 120,
"minLength": 1,
"description": "Available modelName from studio_section_engines; null restores Recommended and absence retains explicit selections during a profile change. Profiles are constrained to returned availableProfiles."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Project identified by the quote."
},
"operationId": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]+$",
"maxLength": 128,
"minLength": 8,
"description": "Client-generated identity for a selection quote. Identical retries share the identity; different selections have distinct identities."
},
"sectionIndex": {
"type": "integer",
"maximum": 239,
"minimum": 0,
"description": "Music section index, or the exact saved Film scene.index, whose new generation uses this engine."
},
"costEstimateId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact estimate returned by the preceding quote."
},
"expectedRevisionId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Exact current storyboard revision from studio_storyboard_context."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"quoteToken",
"scope",
"sectionCount",
"tickedCount",
"models",
"balance",
"expiresAt",
"note"
],
"properties": {
"note": {
"type": "string"
},
"redos": {
"type": "object",
"required": [
"allowance",
"creditCap",
"used",
"usedCredits"
],
"properties": {
"used": {
"type": "number"
},
"allowance": {
"type": "number"
},
"creditCap": {
"type": "number"
},
"usedCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"scope": {
"enum": [
"whole",
"ticked"
]
},
"video": {
"type": "object",
"required": [
"capCredits"
],
"properties": {
"capCredits": {
"type": "number"
}
},
"additionalProperties": true
},
"models": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"recommended",
"credits"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"note": {
"type": "string"
},
"credits": {
"type": [
"number",
"null"
]
},
"recommended": {
"type": "boolean"
},
"needsFaceCheck": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"stills": {
"type": "object",
"required": [
"shotCount",
"credits"
],
"properties": {
"credits": {
"type": "number"
},
"shotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"balance": {
"type": "number"
},
"modelId": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"shortfall": {
"type": "number"
},
"filmSpeech": {
"anyOf": [
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"characters"
],
"properties": {
"state": {
"enum": [
"quoted"
]
},
"characters": {
"type": "array",
"items": {
"type": "object",
"required": [
"artistId",
"characterName",
"sceneIndex",
"voiceSource",
"speech",
"motion",
"lipSync"
],
"properties": {
"motion": {
"type": "object",
"required": [
"providerId",
"modelId"
],
"properties": {
"modelId": {
"type": "string"
},
"providerId": {
"type": "string"
}
},
"additionalProperties": true
},
"speech": {
"type": "object",
"required": [
"providerId",
"modelId"
],
"properties": {
"modelId": {
"type": "string"
},
"providerId": {
"type": "string"
}
},
"additionalProperties": true
},
"lipSync": {
"enum": [
"native",
"separate",
"not_requested"
]
},
"artistId": {
"type": "string"
},
"sceneIndex": {
"type": "number"
},
"voiceSource": {
"enum": [
"native_generated",
"saved_character",
"character_voice_setup"
]
},
"lipSyncRoute": {
"type": "object",
"required": [
"providerId",
"modelId"
],
"properties": {
"modelId": {
"type": "string"
},
"providerId": {
"type": "string"
}
},
"additionalProperties": true
},
"characterName": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"reason"
],
"properties": {
"state": {
"enum": [
"historical_unavailable"
]
},
"reason": {
"enum": [
"original_route_evidence_not_persisted"
]
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
"outputNote": {
"type": "string"
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"consentMode": {
"enum": [
"chat"
]
},
"repeatReuse": {
"type": "object",
"required": [
"reusedSeconds",
"freshSeconds",
"reusedShotCount",
"text"
],
"properties": {
"text": {
"type": "string"
},
"freshSeconds": {
"type": "number"
},
"reusedSeconds": {
"type": "number"
},
"reusedShotCount": {
"type": "number"
}
},
"additionalProperties": true
},
"tickedCount": {
"type": "number"
},
"priceVersion": {
"type": "string"
},
"sectionCount": {
"type": "number"
},
"shortfallNow": {
"type": "number"
},
"totalCredits": {
"type": "number"
},
"approvalState": {
"type": "string"
},
"costEstimateId": {
"type": "string"
},
"fundingMessage": {
"type": "string"
},
"topUpCreditsNow": {
"type": "number"
},
"totalGbpInclVat": {
"type": "string"
},
"approvalExpiresAt": {
"type": "string"
},
"topUpGbpInclVatNow": {
"type": "string"
},
"creditsInformationUrl": {
"type": "string"
},
"engineRecommendations": {
"anyOf": [
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"reason"
],
"properties": {
"state": {
"enum": [
"unavailable"
]
},
"reason": {
"enum": [
"original_quote_replayed"
]
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"state",
"quoteToken",
"revisionId",
"shots"
],
"properties": {
"shots": {
"type": "array",
"items": {
"type": "object",
"required": [
"stableShotId",
"sectionIndex",
"label",
"selectedModelName",
"recommendedModelName",
"options"
],
"properties": {
"label": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"modelName",
"available",
"explanation"
],
"properties": {
"available": {
"type": "boolean"
},
"modelName": {
"type": "string"
},
"explanation": {
"type": [
"string",
"null"
]
},
"deltaVideoCredits": {
"type": "number"
},
"totalVideoCredits": {
"type": "number"
}
},
"additionalProperties": true
}
},
"sectionIndex": {
"type": "number"
},
"stableShotId": {
"type": "string"
},
"selectedModelName": {
"type": [
"string",
"null"
]
},
"recommendedModelName": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"state": {
"enum": [
"quoted"
]
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"sectionIndex",
"sectionId",
"stableShotIds",
"delivery",
"availableProfiles",
"pricing"
],
"properties": {
"pricing": {
"type": "object",
"required": [
"basis",
"credits"
],
"properties": {
"basis": {
"enum": [
"allocated_final_total"
]
},
"credits": {
"type": "number"
}
},
"additionalProperties": true
},
"delivery": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
},
"sectionId": {
"type": [
"string",
"null"
]
},
"sectionIndex": {
"type": "number"
},
"stableShotIds": {
"type": "array",
"items": {
"type": "string"
}
},
"availableProfiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"aspect",
"resolution"
],
"properties": {
"aspect": {
"enum": [
"16:9",
"9:16",
"1:1"
]
},
"resolution": {
"enum": [
"720p",
"1080p",
"4k"
]
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"quoteToken": {
"type": "string"
},
"revisionId": {
"type": "string"
},
"finalVideoCredits": {
"type": "number"
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Choose one section’s engine or generation profile and receive its quote",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}| modelKey | string | Optional exact video model identifier when a specific engine is requested. |
| profileKey | string | Optional exact video profile identifier when requested. |
| attachmentIds | array | Owned uploads: for a clip, a start picture or references; for talking, the audio plus the picture or video that will speak. |
| lengthSeconds | number | Optional length in seconds when the chosen model offers a length setting. |
{
"name": "studio_custom_video_quote",
"title": "Price a custom video",
"description": "Prices one standalone video clip or talking video from a prompt or script and optional owned uploads, using the same pricing as the Brix36 create box. kind clip is a video clip from the prompt; kind talking is a person speaking that audio, and needs the audio upload plus a picture, a video or an existing artist. Returns the exact credits and price with draftId and quoteId, the model and the shape and length the price includes when those are part of it, and whether a price is available. Nothing is generated or charged. The prompt for a clip reads as a shot and describes its sound: the place's few sounds and their distance, the action's sounds at their beats, music only when asked for or for an advert, trailer or reel, and an ending that settles and holds to the last frame unless the last beat is a deliberate hit.",
"inputSchema": {
"type": "object",
"required": [
"kind",
"prompt"
],
"properties": {
"kind": {
"enum": [
"clip",
"talking"
],
"type": "string",
"description": "clip for a video clip, or talking for a person speaking uploaded audio."
},
"shape": {
"type": "string",
"maxLength": 20,
"minLength": 1,
"description": "Optional shape such as 16:9, 9:16 or 1:1 when the chosen model offers a shape setting."
},
"sound": {
"type": "object",
"required": [
"music",
"effects",
"background"
],
"properties": {
"music": {
"type": "boolean",
"description": "Music is on."
},
"effects": {
"type": "boolean",
"description": "Effects are on."
},
"background": {
"type": "boolean",
"description": "Background sound is on."
}
},
"description": "Optional music, effects and background for this clip.",
"additionalProperties": false
},
"prompt": {
"type": "string",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"maxLength": 100000,
"minLength": 1,
"description": "What the video should show, or the script in the customer's words."
},
"draftId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Stable draft ID for this video. Optional when pricing; the price returns one. Reusing it with changed details reprices the same draft."
},
"artistId": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Optional Artist DNA ID when the video stars an existing artist or character."
},
"modelKey": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Optional exact video model identifier when a specific engine is requested."
},
"profileKey": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Optional exact video profile identifier when requested."
},
"attachmentIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
"maxLength": 128,
"minLength": 1,
"description": "Owned uploaded media ID."
},
"maxItems": 64,
"description": "Owned uploads: for a clip, a start picture or references; for talking, the audio plus the picture or video that will speak.",
"uniqueItems": true
},
"lengthSeconds": {
"type": "number",
"maximum": 300,
"minimum": 0.5,
"description": "Optional length in seconds when the chosen model offers a length setting."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"draftId",
"quoteId",
"kind",
"available",
"vatInclusive",
"expiresAt",
"what",
"note"
],
"properties": {
"kind": {
"enum": [
"clip",
"video",
"talking"
]
},
"note": {
"type": "string"
},
"what": {
"type": "string"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind",
"label",
"amountMinor"
],
"properties": {
"kind": {
"type": "string"
},
"label": {
"type": "string"
},
"amountMinor": {
"type": "number"
}
},
"additionalProperties": true
}
},
"shape": {
"type": "string"
},
"reason": {
"type": "string"
},
"credits": {
"type": "number"
},
"draftId": {
"type": "string"
},
"quoteId": {
"type": "string"
},
"gbpMinor": {
"type": "number"
},
"available": {
"type": "boolean"
},
"expiresAt": {
"type": "string"
},
"confirmWith": {
"type": "object",
"required": [
"draftId",
"quoteId"
],
"properties": {
"draftId": {
"type": "string"
},
"quoteId": {
"type": "string"
}
},
"additionalProperties": true
},
"vatInclusive": {
"type": "boolean"
},
"lengthSeconds": {
"type": "number"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Price a custom video",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "studio_film_set_speech_voice",
"title": "Set a Film character’s scene voice",
"description": "Set the saved-character or native speech voice choice for one character in one scene. Uses expectedRevision, the current saved Film plan revision, and a stable operationId; identical operationId/input retries reconcile the same edit. No model call or credit charge.",
"inputSchema": {
"type": "object",
"required": [
"projectId",
"operationId",
"expectedRevision",
"sceneIndex",
"artistId",
"useCharacterVoice"
],
"properties": {
"artistId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "A speaking cast character in this Film."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The Film project id."
},
"sceneIndex": {
"type": "integer",
"minimum": 0,
"description": "The saved scene index from studio_film_read."
},
"operationId": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Stable operation identifier. Identical retries retain the original identifier; new work has a distinct identifier."
},
"expectedRevision": {
"type": "integer",
"minimum": 1,
"description": "The savedPlan.revision from studio_film_read."
},
"voiceDescription": {
"type": "string",
"maxLength": 200,
"description": "Optional native voice direction."
},
"useCharacterVoice": {
"type": "boolean",
"description": "The customer’s voice choice for this scene and character: true selects the saved voice; false selects native video-model speech."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"operationId",
"revision",
"revisionId"
],
"properties": {
"lineId": {
"type": "string"
},
"revision": {
"type": "number"
},
"revisionId": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Set a Film character’s scene voice",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}| pauseSettleMs | number |
| targetDurationMs | number |
| maxBeatSnapShiftMs | number |
| targetIntegratedLufs | number |
{
"name": "studio_ai_editor_plan",
"title": "Plan AI Editor rough cut",
"description": "Plans a sentence-end rough cut and beat-aligned timeline from clip transcripts, word timestamps, caption segments, silence windows and beat markers. Prevents mid-sentence cuts, adds natural breathing room at sentence boundaries, and returns an audio mix plan targeting -16 LUFS with ducking. Free deterministic planning; no credits are charged.",
"inputSchema": {
"type": "object",
"required": [
"clips"
],
"properties": {
"fps": {
"enum": [
24,
25,
30,
60
],
"type": "integer"
},
"beats": {
"type": "array",
"items": {
"type": "object",
"required": [
"timeMs"
],
"properties": {
"timeMs": {
"type": "number",
"minimum": 0
},
"strength": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"barBoundary": {
"type": "boolean"
}
},
"additionalProperties": false
},
"maxItems": 2000
},
"clips": {
"type": "array",
"items": {
"type": "object",
"description": "Shape: {clipId: string, label?: string, assetId?: string, role?: \"a_roll\"|\"b_roll\", durationMs: number, text?: string, words?: list of {word: string, startMs: number, endMs: number, confidence?: number}, segments?: list of {text: string, startMs: number, endMs: number}, silences?: list of {startMs: number, endMs: number}}"
},
"maxItems": 64,
"minItems": 1
},
"title": {
"type": "string",
"maxLength": 240,
"minLength": 1
},
"preset": {
"enum": [
"short",
"social",
"teaser",
"trailer",
"full_edit"
],
"type": "string"
},
"beatsMs": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"maxItems": 2000
},
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"timelineId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"aspectRatio": {
"enum": [
"16:9",
"9:16",
"1:1"
],
"type": "string"
},
"musicDuckDb": {
"type": "number",
"maximum": 0,
"minimum": -24
},
"pauseFloorMs": {
"type": "number",
"maximum": 500,
"minimum": 80
},
"pauseSettleMs": {
"type": "number",
"maximum": 600,
"minimum": 0
},
"targetDurationMs": {
"type": "number",
"maximum": 3600000,
"minimum": 1000
},
"maxBeatSnapShiftMs": {
"type": "number",
"maximum": 600,
"minimum": 0
},
"targetIntegratedLufs": {
"type": "number",
"maximum": -9,
"minimum": -24
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"timelineId",
"webUrl",
"title",
"preset",
"totalDurationMs",
"sentenceBoundaryPolicy",
"cuts"
],
"properties": {
"cuts": {
"type": "array",
"items": {
"type": "object",
"required": [
"cutIndex",
"clipId",
"sourceInMs",
"sourceOutMs",
"durationMs",
"timelineStartMs",
"timelineEndMs",
"cutBoundary",
"endsOnSentenceBoundary",
"endsMidSentence"
],
"properties": {
"label": {
"type": "string"
},
"clipId": {
"type": "string"
},
"cutIndex": {
"type": "number"
},
"durationMs": {
"type": "number"
},
"sourceInMs": {
"type": "number"
},
"cutBoundary": {
"enum": [
"sentence_end",
"beat_snap"
]
},
"sourceOutMs": {
"type": "number"
},
"sentenceText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"timelineEndMs": {
"type": "number"
},
"endsMidSentence": {
"type": "boolean"
},
"timelineStartMs": {
"type": "number"
},
"endsOnSentenceBoundary": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"title": {
"type": "string"
},
"preset": {
"enum": [
"short",
"social",
"teaser",
"trailer",
"full_edit"
]
},
"webUrl": {
"type": "string"
},
"timelineId": {
"type": "string"
},
"totalDurationMs": {
"type": "number"
},
"sentenceBoundaryPolicy": {
"type": "object",
"required": [
"rule",
"midSentenceCutsAllowed",
"pauseSettleMs",
"verifiedZeroMidSentenceCuts"
],
"properties": {
"rule": {
"enum": [
"strict_sentence_end"
]
},
"pauseSettleMs": {
"type": "number"
},
"midSentenceCutsAllowed": {
"type": "boolean"
},
"verifiedZeroMidSentenceCuts": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Plan AI Editor rough cut",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| pauseFloorMs |
| number |
| pauseSettleMs | number |
| targetDurationMs | number |
| maxBeatSnapShiftMs | number |
| targetIntegratedLufs | number |
{
"name": "studio_ai_editor_export",
"title": "Export AI Editor timeline",
"description": "Exports a sentence-end rough-cut timeline to Final Cut Pro XML (fcpxml), Premiere Pro XML (premiere_xml), CMX 3600 EDL (edl) or structured JSON (json) for non-linear editing. Free deterministic export; no credits are charged.",
"inputSchema": {
"type": "object",
"required": [
"format",
"clips"
],
"properties": {
"fps": {
"enum": [
24,
25,
30,
60
],
"type": "integer"
},
"beats": {
"type": "array",
"items": {
"type": "object",
"required": [
"timeMs"
],
"properties": {
"timeMs": {
"type": "number",
"minimum": 0
},
"strength": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"barBoundary": {
"type": "boolean"
}
},
"additionalProperties": false
},
"maxItems": 2000
},
"clips": {
"type": "array",
"items": {
"type": "object",
"description": "Shape: {clipId: string, label?: string, assetId?: string, role?: \"a_roll\"|\"b_roll\", durationMs: number, text?: string, words?: list of {word: string, startMs: number, endMs: number, confidence?: number}, segments?: list of {text: string, startMs: number, endMs: number}, silences?: list of {startMs: number, endMs: number}}"
},
"maxItems": 64,
"minItems": 1
},
"title": {
"type": "string",
"maxLength": 240,
"minLength": 1
},
"format": {
"enum": [
"fcpxml",
"premiere_xml",
"edl",
"json"
],
"type": "string"
},
"preset": {
"enum": [
"short",
"social",
"teaser",
"trailer",
"full_edit"
],
"type": "string"
},
"beatsMs": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"maxItems": 2000
},
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"timelineId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"aspectRatio": {
"enum": [
"16:9",
"9:16",
"1:1"
],
"type": "string"
},
"musicDuckDb": {
"type": "number",
"maximum": 0,
"minimum": -24
},
"pauseFloorMs": {
"type": "number",
"maximum": 500,
"minimum": 80
},
"pauseSettleMs": {
"type": "number",
"maximum": 600,
"minimum": 0
},
"targetDurationMs": {
"type": "number",
"maximum": 3600000,
"minimum": 1000
},
"maxBeatSnapShiftMs": {
"type": "number",
"maximum": 600,
"minimum": 0
},
"targetIntegratedLufs": {
"type": "number",
"maximum": -9,
"minimum": -24
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"format",
"mimeType",
"filename",
"content"
],
"properties": {
"format": {
"enum": [
"fcpxml",
"premiere_xml",
"edl",
"json"
]
},
"content": {
"type": "string"
},
"filename": {
"type": "string"
},
"mimeType": {
"type": "string"
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Export AI Editor timeline",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| targetDurationMs | number |
| maxBeatSnapShiftMs | number |
| targetIntegratedLufs | number |
{
"name": "studio_ai_editor_timeline_save",
"title": "Save AI Editor timeline",
"description": "Saves or updates an AI Editor rough-cut timeline and returns timelineId and a Web Studio link so the customer can open and trim the exact timeline in the Brix36 Web Studio.",
"inputSchema": {
"type": "object",
"required": [
"clips"
],
"properties": {
"fps": {
"enum": [
24,
25,
30,
60
],
"type": "integer"
},
"beats": {
"type": "array",
"items": {
"type": "object",
"required": [
"timeMs"
],
"properties": {
"timeMs": {
"type": "number",
"minimum": 0
},
"strength": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"barBoundary": {
"type": "boolean"
}
},
"additionalProperties": false
},
"maxItems": 2000
},
"clips": {
"type": "array",
"items": {
"type": "object",
"description": "Shape: {clipId: string, label?: string, assetId?: string, role?: \"a_roll\"|\"b_roll\", durationMs: number, text?: string, words?: list of {word: string, startMs: number, endMs: number, confidence?: number}, segments?: list of {text: string, startMs: number, endMs: number}, silences?: list of {startMs: number, endMs: number}}"
},
"maxItems": 64,
"minItems": 1
},
"title": {
"type": "string",
"maxLength": 240,
"minLength": 1
},
"preset": {
"enum": [
"short",
"social",
"teaser",
"trailer",
"full_edit"
],
"type": "string"
},
"beatsMs": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"maxItems": 2000
},
"projectId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"timelineId": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"aspectRatio": {
"enum": [
"16:9",
"9:16",
"1:1"
],
"type": "string"
},
"musicDuckDb": {
"type": "number",
"maximum": 0,
"minimum": -24
},
"pauseFloorMs": {
"type": "number",
"maximum": 500,
"minimum": 80
},
"pauseSettleMs": {
"type": "number",
"maximum": 600,
"minimum": 0
},
"targetDurationMs": {
"type": "number",
"maximum": 3600000,
"minimum": 1000
},
"maxBeatSnapShiftMs": {
"type": "number",
"maximum": 600,
"minimum": 0
},
"targetIntegratedLufs": {
"type": "number",
"maximum": -9,
"minimum": -24
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"timelineId",
"webUrl",
"title",
"preset",
"totalDurationMs",
"sentenceBoundaryPolicy",
"cuts"
],
"properties": {
"cuts": {
"type": "array",
"items": {
"type": "object",
"required": [
"cutIndex",
"clipId",
"sourceInMs",
"sourceOutMs",
"durationMs",
"timelineStartMs",
"timelineEndMs",
"cutBoundary",
"endsOnSentenceBoundary",
"endsMidSentence"
],
"properties": {
"label": {
"type": "string"
},
"clipId": {
"type": "string"
},
"cutIndex": {
"type": "number"
},
"durationMs": {
"type": "number"
},
"sourceInMs": {
"type": "number"
},
"cutBoundary": {
"enum": [
"sentence_end",
"beat_snap"
]
},
"sourceOutMs": {
"type": "number"
},
"sentenceText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"timelineEndMs": {
"type": "number"
},
"endsMidSentence": {
"type": "boolean"
},
"timelineStartMs": {
"type": "number"
},
"endsOnSentenceBoundary": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"title": {
"type": "string"
},
"preset": {
"enum": [
"short",
"social",
"teaser",
"trailer",
"full_edit"
]
},
"webUrl": {
"type": "string"
},
"timelineId": {
"type": "string"
},
"totalDurationMs": {
"type": "number"
},
"sentenceBoundaryPolicy": {
"type": "object",
"required": [
"rule",
"midSentenceCutsAllowed",
"pauseSettleMs",
"verifiedZeroMidSentenceCuts"
],
"properties": {
"rule": {
"enum": [
"strict_sentence_end"
]
},
"pauseSettleMs": {
"type": "number"
},
"midSentenceCutsAllowed": {
"type": "boolean"
},
"verifiedZeroMidSentenceCuts": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
},
"message": {
"type": "string"
},
"outcomeUnknown": {
"type": "boolean"
}
},
"additionalProperties": true
}
]
},
"annotations": {
"title": "Save AI Editor timeline",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}