{ "paths": { "/api/v1/capabilities": { "get": { "operationId": "listCapabilities", "summary": "See what you can do right now", "tags": [ "Capabilities" ], "description": "Lists available operations, models, upload formats and production limits for the current API environment.", "x-required-scope": "projects:read", "parameters": [], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicCapabilityPage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works": { "get": { "operationId": "listProjects", "summary": "List your projects", "tags": [ "Projects & resources" ], "description": "Lists accessible projects. Filter by state and use cursor and limit to page through results.", "x-required-scope": "projects:read", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "state", "in": "query", "schema": { "type": "string", "enum": [ "active", "archived" ] } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicProjectPage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "post": { "operationId": "createProject", "summary": "Create a new project", "tags": [ "Projects & resources" ], "description": "Creates a project with the supplied name. Use the returned project ID to add material and start production.", "x-required-scope": "projects:write", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreate" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicProject" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}": { "get": { "operationId": "getProject", "summary": "View a project", "tags": [ "Projects & resources" ], "description": "Returns a project’s name, state and current revision. Read this before submitting changes or production requests.", "x-required-scope": "projects:read", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicProject" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "patch": { "operationId": "updateProject", "summary": "Edit a project", "tags": [ "Projects & resources" ], "description": "Changes a project’s name or switches its state between active and archived. Send the latest ETag in If-Match.", "x-required-scope": "projects:write", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "required": true, "description": "Use the latest ETag, including quotes.", "schema": { "type": "string", "pattern": "^\"[1-9][0-9]*\"$", "example": "\"1\"" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectPatch" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicProject" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/resources": { "get": { "operationId": "listResources", "summary": "List the material you uploaded", "tags": [ "Projects & resources" ], "description": "Lists a project’s script, character, scene, prop, episode and shot records. Use kind to select a resource type.", "x-required-scope": "projects:read", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "script", "character", "scene", "prop", "episode", "shot" ] } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicResourcePage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "post": { "operationId": "createResource", "summary": "Add material such as scripts and images", "tags": [ "Projects & resources" ], "description": "Adds a structured resource to a project using kind and data, such as script text or a shot definition. Upload file bytes through /uploads.", "x-required-scope": "projects:write", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicResource" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/resources/{resource_id}": { "get": { "operationId": "getResource", "summary": "View one piece of material", "tags": [ "Projects & resources" ], "description": "Returns the kind, data and revision of one resource identified by resource_id within the project.", "x-required-scope": "projects:read", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicResource" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "patch": { "operationId": "updateResource", "summary": "Edit material", "tags": [ "Projects & resources" ], "description": "Updates a resource’s kind and data. Send its latest ETag in If-Match to protect against conflicting edits.", "x-required-scope": "projects:write", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "required": true, "description": "Use the latest ETag, including quotes.", "schema": { "type": "string", "pattern": "^\"[1-9][0-9]*\"$", "example": "\"1\"" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicResource" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/uploads": { "post": { "operationId": "createUpload", "summary": "Get an address to upload a file to", "tags": [ "Uploads" ], "description": "Registers file metadata and returns an upload_url. PUT the file bytes there, then call the upload completion endpoint. Supports TXT, Markdown, DOCX, PNG, JPEG, WebP, AVIF, WAV and ZIP. Byte limits share Studio settings: read upload_limits from GET /capabilities. Scripts allow up to 5,000,000 characters. Filenames cannot contain path separators. WAV must use PCM or IEEE float.", "x-required-scope": "assets:write", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadInput" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicUploadTicket" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/uploads/{upload_id}/complete": { "post": { "operationId": "completeUpload", "summary": "Tell us the file is fully uploaded", "tags": [ "Uploads" ], "description": "Validates the uploaded file against its declared metadata and returns the asset that can be used in production.", "x-required-scope": "assets:write", "parameters": [ { "name": "upload_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicAsset" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/assets/{asset_id}": { "get": { "operationId": "getAsset", "summary": "View a result file and its download link", "tags": [ "Assets & results" ], "description": "Returns asset metadata and a signed download_url when available. Use that URL to download the file before it expires.", "x-required-scope": "assets:read", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicAsset" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/plans": { "post": { "operationId": "createPlan", "deprecated": true, "summary": "Check the plan and the credits it will cost", "tags": [ "Projects & resources" ], "description": "Check what will be produced and how many credits it will cost, without starting the actual production.", "x-required-scope": "runs:write", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanInput" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicPlan" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/runs": { "post": { "operationId": "createRun", "deprecated": true, "summary": "Start production", "tags": [ "Projects & resources" ], "description": "Starts production from an existing plan_id and returns a run ID. Use getRun to track its state and results.", "x-required-scope": "runs:write", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunInput" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicRun" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/runs": { "get": { "operationId": "listRuns", "summary": "List your production runs", "tags": [ "Production runs" ], "description": "Lists production runs, with filters for project, state, client_reference and date range.", "x-required-scope": "runs:read", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "project_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "state", "in": "query", "schema": { "type": "string", "enum": [ "queued", "running", "awaiting_review", "stopping", "paused", "needs_attention", "partially_succeeded", "succeeded", "failed", "cancelled" ] } }, { "name": "client_reference", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 128 } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicRunPage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/runs/{run_id}": { "get": { "operationId": "getRun", "summary": "Check how a run is going", "tags": [ "Production runs" ], "description": "Returns the current state, version and available results of a production run. Use its version when submitting a decision.", "x-required-scope": "runs:read", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicRun" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/runs/{run_id}/steps": { "get": { "operationId": "listRunSteps", "summary": "See progress step by step", "tags": [ "Production runs" ], "description": "Lists the individual steps of a run so you can see which stages are waiting, running or finished.", "x-required-scope": "runs:read", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStepPage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/runs/{run_id}/events": { "get": { "operationId": "listRunEvents", "summary": "See what happened during a run", "tags": [ "Production runs" ], "description": "Lists recorded events for a run, such as state changes and review requests, to trace what happened during production.", "x-required-scope": "runs:read", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicRunEventPage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/runs/{run_id}/decisions": { "post": { "operationId": "decideRun", "summary": "Approve or stop a run", "tags": [ "Production runs" ], "description": "Submits a decision for a run: approve, stop, resume, cancel_remaining or retry_result. Send its latest version as expected_version. retry_result resumes result polling for a saved video task. Send the latest expected_version and step_id. It retains the original job and credit hold without generating again. Only recoverable videos within 24 hours of run admission are supported. Other unknown results or usage require operator review.", "x-required-scope": "runs:write", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisionInput" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicRun" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/jobs": { "post": { "operationId": "createJob", "deprecated": true, "summary": "Run a single feature right away", "tags": [ "Workflow functions" ], "description": "Run just one feature instead of the whole production. analyze_script reads the script and creates shots, generate_image makes character, scene, prop and shot images, generate_video makes the video for a shot whose image you picked, and assemble_video joins an episode whose shots all have a video. Always send the project’s latest revision. Live requests reserve credits up front.", "x-required-scope": "jobs:create", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobInput" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/jobs/{job_id}": { "get": { "operationId": "getJob", "summary": "Check a job and its result", "tags": [ "Workflow functions" ], "description": "Returns a job’s current state and output asset IDs. Once complete, use getAsset to retrieve its result files.", "x-required-scope": "jobs:read", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/requests": { "get": { "operationId": "listRequests", "summary": "List the requests you sent", "tags": [ "Request logs" ], "description": "Lists API request logs with HTTP status and duration. Filter by project and date range to investigate calls.", "x-required-scope": "requests:read", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "project_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "run_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "job_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "key_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "status_code", "in": "query", "schema": { "type": "integer", "minimum": 100, "maximum": 599 } }, { "name": "method", "in": "query", "schema": { "type": "string", "enum": [ "GET", "POST", "PATCH", "PUT" ] } }, { "name": "route_template", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 300 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicRequestLogPage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/requests/{request_id}": { "get": { "operationId": "getRequest", "summary": "View one request you sent", "tags": [ "Request logs" ], "description": "Looks up one API call by request_id, including its HTTP status, duration and associated run or job.", "x-required-scope": "requests:read", "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicRequestLog" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/usage": { "get": { "operationId": "getUsage", "summary": "Check your credit usage", "tags": [ "Usage" ], "description": "Returns usage totals for the requested period, including reserved and settled amounts.", "x-required-scope": "usage:read", "parameters": [], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicUsage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/webhook-endpoints": { "get": { "operationId": "listWebhookEndpoints", "summary": "List your webhook addresses", "tags": [ "Webhooks" ], "description": "Lists registered webhook URLs and their event subscriptions and enabled state.", "x-required-scope": "webhooks:read", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicWebhookEndpointPage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "post": { "operationId": "createWebhookEndpoint", "summary": "Add a webhook address", "tags": [ "Webhooks" ], "description": "Registers a webhook URL to receive the selected production events for the specified projects.", "x-required-scope": "webhooks:write", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreate" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicWebhookIssued" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/webhook-endpoints/{endpoint_id}": { "patch": { "operationId": "updateWebhookEndpoint", "summary": "Edit a webhook address", "tags": [ "Webhooks" ], "description": "Enables or disables a webhook endpoint, or changes the events it receives.", "x-required-scope": "webhooks:write", "parameters": [ { "name": "endpoint_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "required": true, "description": "Use the latest ETag, including quotes.", "schema": { "type": "string", "pattern": "^\"[1-9][0-9]*\"$", "example": "\"1\"" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPatch" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicWebhookEndpoint" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/webhook-deliveries": { "get": { "operationId": "listWebhookDeliveries", "summary": "See what was sent to your webhook", "tags": [ "Webhook deliveries" ], "description": "Lists webhook delivery attempts and their status so you can check whether notifications were delivered.", "x-required-scope": "webhooks:read", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicWebhookDeliveryPage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/webhook-deliveries/{delivery_id}/redeliver": { "post": { "operationId": "redeliverWebhook", "summary": "Send a webhook again", "tags": [ "Webhook deliveries" ], "description": "Requests another delivery of an existing webhook notification identified by delivery_id.", "x-required-scope": "webhooks:write", "parameters": [ { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicWebhookDelivery" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/uploads/{upload_id}/content": { "put": { "operationId": "uploadContent", "summary": "Upload the file contents", "tags": [ "Uploads" ], "description": "Sends the raw file bytes for an existing upload ticket as application/octet-stream. Call completeUpload after the transfer succeeds.", "x-required-scope": "assets:write", "parameters": [ { "name": "upload_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicUploaded" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/workflow": { "get": { "operationId": "getStudioWorkflow", "summary": "Read Studio production data", "tags": [ "Projects & resources" ], "description": "Returns the project’s script, episodes, designs, scenes, assets, takes and cut selections together with the latest revision.", "x-required-scope": "projects:read", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioWorkflow" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/workflow/commands": { "post": { "operationId": "executeStudioCommand", "deprecated": true, "summary": "Edit Studio production", "tags": [ "Projects & resources" ], "description": "Edits production data, such as scripts, scenes, designs or selected takes. Choose an operation and send its input with the latest revision.", "x-required-scope": "projects:write", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioCommand" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/script/analyses": { "post": { "operationId": "analyzeStudioScript", "summary": "Analyze the Studio script", "tags": [ "Projects & resources" ], "description": "Analyzes the project script into production structure. Provide script_text to update the script before analysis, or omit it to use the saved script. Track the returned job with getJob.", "x-required-scope": "jobs:create", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioAnalysis" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/cut/exports": { "post": { "operationId": "exportStudioCut", "deprecated": true, "summary": "Export Studio cut", "tags": [ "Projects & resources" ], "description": "Joins selected scene videos in episode and scene order. Use selections to choose takes explicitly and allow_partial to permit missing scenes. Track the export with getJob.", "x-required-scope": "jobs:create", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioCutExport" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/storyboard/videos": { "post": { "operationId": "generateStudioVideo", "deprecated": true, "summary": "Generate storyboard scene video", "tags": [ "Projects & resources" ], "description": "Generates a video take for scene_id using the selected model, duration and resolution. anchor_asset_id can specify the starting image. Track the returned job with getJob.", "x-required-scope": "jobs:create", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioVideo" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/designs/images": { "post": { "operationId": "generateStudioImage", "deprecated": true, "summary": "Generate character, setting, prop or grid images", "tags": [ "Projects & resources" ], "description": "Generates one to four images for design_id, using a prompt and optional reference images. Choose a primary or variant slot and track the job with getJob.", "x-required-scope": "jobs:create", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioImage" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/script/builds": { "post": { "operationId": "buildStudioScript", "summary": "Build production from script", "tags": [ "Projects & resources" ], "description": "Send verified script_asset_ids and revision to build the screenplay, references and storyboard. full_rebuild replaces existing structure. Generate images and videos separately. Charges reported input and output tokens at the same prices as Studio. No per-request credit budget is required. GET /jobs/{job_id} → output_asset_ids.", "x-required-scope": "jobs:create", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioBuild" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/library": { "get": { "operationId": "listStudioLibrary", "summary": "List shared library assets", "tags": [ "Projects & resources" ], "description": "Lists assets available to import into the project. scope=personal lists your own library; scope=studio, the default, lists the shared library.", "x-required-scope": "assets:read", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "schema": { "type": "string" } }, { "name": "scope", "schema": { "type": "string", "enum": [ "studio", "personal" ] } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioLibrary" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/imports": { "post": { "operationId": "importStudioAsset", "summary": "Import an asset into a project", "tags": [ "Projects & resources" ], "description": "Copies the asset identified by asset_id from a personal or shared library into the project. Returns the project-owned copy; later source changes do not affect it.", "x-required-scope": "assets:write", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioImport" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicAsset" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{project_id}/script/drafts": { "post": { "operationId": "draftStudioScript", "summary": "Generate screenplay draft", "tags": [ "Projects & resources" ], "description": "Send instructions, optional source_text, revision and max_output_tokens. Saves a new script asset without replacing the existing screenplay. Charges reported input and output tokens at the same prices as Studio. No per-request credit budget is required. GET /jobs/{job_id} → output_asset_ids.", "x-required-scope": "jobs:create", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioDraft" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/jobs/{job_id}/build": { "get": { "operationId": "getStudioBuildProgress", "summary": "Read build progress and sources", "tags": [ "Workflow functions" ], "description": "Returns a script build job’s stage, progress messages and source documents, including the text prepared for processing.", "x-required-scope": "jobs:read", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioBuildProgress" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/characters": { "get": { "operationId": "listCharacters", "summary": "Character · Read (list)", "tags": [ "Projects & resources" ], "description": "Character · Read (list). GET /api/v1/works/{work_id}/characters. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicReferencePage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "post": { "operationId": "createCharacter", "summary": "Character · Create", "tags": [ "Projects & resources" ], "description": "Character · Create. POST /api/v1/works/{work_id}/characters. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createCharacterInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/characters/{reference_id}": { "get": { "operationId": "getCharacter", "summary": "Character · Read", "tags": [ "Projects & resources" ], "description": "Character · Read. GET /api/v1/works/{work_id}/characters/{reference_id}. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicReference" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "patch": { "operationId": "updateCharacter", "summary": "Character · Update", "tags": [ "Projects & resources" ], "description": "Character · Update. PATCH /api/v1/works/{work_id}/characters/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateCharacterInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "delete": { "operationId": "deleteCharacter", "summary": "Character · Delete", "tags": [ "Projects & resources" ], "description": "Character · Delete. DELETE /api/v1/works/{work_id}/characters/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteCharacterInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/characters/{reference_id}/primary-image": { "put": { "operationId": "setCharacterImage", "summary": "Character · Set reference image", "tags": [ "Projects & resources" ], "description": "Character · Set reference image. PUT /api/v1/works/{work_id}/characters/{reference_id}/primary-image. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setCharacterImageInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/characters/{reference_id}/image-generations": { "post": { "operationId": "generateCharacterImage", "summary": "Character · Generate reference image", "tags": [ "Projects & resources" ], "description": "Character · Generate reference image. POST /api/v1/works/{work_id}/characters/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}", "x-required-scope": "jobs:create", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateCharacterImageInput" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}": { "put": { "operationId": "attachSceneCharacter", "summary": "Character · Attach to scene", "tags": [ "Projects & resources" ], "description": "Character · Attach to scene. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachSceneCharacterInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "delete": { "operationId": "detachSceneCharacter", "summary": "Character · Detach from scene", "tags": [ "Projects & resources" ], "description": "Character · Detach from scene. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/detachSceneCharacterInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/background-scenes": { "get": { "operationId": "listBackgroundScenes", "summary": "Background scene · Read (list)", "tags": [ "Projects & resources" ], "description": "Background scene · Read (list). GET /api/v1/works/{work_id}/background-scenes. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicReferencePage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "post": { "operationId": "createBackgroundScene", "summary": "Background scene · Create", "tags": [ "Projects & resources" ], "description": "Background scene · Create. POST /api/v1/works/{work_id}/background-scenes. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createBackgroundSceneInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/background-scenes/{reference_id}": { "get": { "operationId": "getBackgroundScene", "summary": "Background scene · Read", "tags": [ "Projects & resources" ], "description": "Background scene · Read. GET /api/v1/works/{work_id}/background-scenes/{reference_id}. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicReference" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "patch": { "operationId": "updateBackgroundScene", "summary": "Background scene · Update", "tags": [ "Projects & resources" ], "description": "Background scene · Update. PATCH /api/v1/works/{work_id}/background-scenes/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateBackgroundSceneInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "delete": { "operationId": "deleteBackgroundScene", "summary": "Background scene · Delete", "tags": [ "Projects & resources" ], "description": "Background scene · Delete. DELETE /api/v1/works/{work_id}/background-scenes/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteBackgroundSceneInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/background-scenes/{reference_id}/primary-image": { "put": { "operationId": "setBackgroundSceneImage", "summary": "Background scene · Set reference image", "tags": [ "Projects & resources" ], "description": "Background scene · Set reference image. PUT /api/v1/works/{work_id}/background-scenes/{reference_id}/primary-image. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setBackgroundSceneImageInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/background-scenes/{reference_id}/image-generations": { "post": { "operationId": "generateBackgroundSceneImage", "summary": "Background scene · Generate reference image", "tags": [ "Projects & resources" ], "description": "Background scene · Generate reference image. POST /api/v1/works/{work_id}/background-scenes/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}", "x-required-scope": "jobs:create", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateBackgroundSceneImageInput" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}": { "put": { "operationId": "attachSceneBackgroundScene", "summary": "Background scene · Attach to scene", "tags": [ "Projects & resources" ], "description": "Background scene · Attach to scene. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachSceneBackgroundSceneInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "delete": { "operationId": "detachSceneBackgroundScene", "summary": "Background scene · Detach from scene", "tags": [ "Projects & resources" ], "description": "Background scene · Detach from scene. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/detachSceneBackgroundSceneInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/props": { "get": { "operationId": "listProps", "summary": "Prop · Read (list)", "tags": [ "Projects & resources" ], "description": "Prop · Read (list). GET /api/v1/works/{work_id}/props. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicReferencePage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "post": { "operationId": "createProp", "summary": "Prop · Create", "tags": [ "Projects & resources" ], "description": "Prop · Create. POST /api/v1/works/{work_id}/props. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createPropInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/props/{reference_id}": { "get": { "operationId": "getProp", "summary": "Prop · Read", "tags": [ "Projects & resources" ], "description": "Prop · Read. GET /api/v1/works/{work_id}/props/{reference_id}. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicReference" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "patch": { "operationId": "updateProp", "summary": "Prop · Update", "tags": [ "Projects & resources" ], "description": "Prop · Update. PATCH /api/v1/works/{work_id}/props/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updatePropInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "delete": { "operationId": "deleteProp", "summary": "Prop · Delete", "tags": [ "Projects & resources" ], "description": "Prop · Delete. DELETE /api/v1/works/{work_id}/props/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deletePropInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/props/{reference_id}/primary-image": { "put": { "operationId": "setPropImage", "summary": "Prop · Set reference image", "tags": [ "Projects & resources" ], "description": "Prop · Set reference image. PUT /api/v1/works/{work_id}/props/{reference_id}/primary-image. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setPropImageInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/props/{reference_id}/image-generations": { "post": { "operationId": "generatePropImage", "summary": "Prop · Generate reference image", "tags": [ "Projects & resources" ], "description": "Prop · Generate reference image. POST /api/v1/works/{work_id}/props/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}", "x-required-scope": "jobs:create", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generatePropImageInput" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}": { "put": { "operationId": "attachSceneProp", "summary": "Prop · Attach to scene", "tags": [ "Projects & resources" ], "description": "Prop · Attach to scene. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachScenePropInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "delete": { "operationId": "detachSceneProp", "summary": "Prop · Detach from scene", "tags": [ "Projects & resources" ], "description": "Prop · Detach from scene. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/detachScenePropInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/grids": { "get": { "operationId": "listGrids", "summary": "Grid · Read (list)", "tags": [ "Projects & resources" ], "description": "Grid · Read (list). GET /api/v1/works/{work_id}/grids. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicReferencePage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "post": { "operationId": "createGrid", "summary": "Grid · Create", "tags": [ "Projects & resources" ], "description": "Grid · Create. POST /api/v1/works/{work_id}/grids. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createGridInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/grids/{reference_id}": { "get": { "operationId": "getGrid", "summary": "Grid · Read", "tags": [ "Projects & resources" ], "description": "Grid · Read. GET /api/v1/works/{work_id}/grids/{reference_id}. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicReference" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "patch": { "operationId": "updateGrid", "summary": "Grid · Update", "tags": [ "Projects & resources" ], "description": "Grid · Update. PATCH /api/v1/works/{work_id}/grids/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateGridInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "delete": { "operationId": "deleteGrid", "summary": "Grid · Delete", "tags": [ "Projects & resources" ], "description": "Grid · Delete. DELETE /api/v1/works/{work_id}/grids/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteGridInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/grids/{reference_id}/primary-image": { "put": { "operationId": "setGridImage", "summary": "Grid · Set reference image", "tags": [ "Projects & resources" ], "description": "Grid · Set reference image. PUT /api/v1/works/{work_id}/grids/{reference_id}/primary-image. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setGridImageInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/grids/{reference_id}/image-generations": { "post": { "operationId": "generateGridImage", "summary": "Grid · Generate reference image", "tags": [ "Projects & resources" ], "description": "Grid · Generate reference image. POST /api/v1/works/{work_id}/grids/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}", "x-required-scope": "jobs:create", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateGridImageInput" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}": { "put": { "operationId": "attachSceneGrid", "summary": "Grid · Attach to scene", "tags": [ "Projects & resources" ], "description": "Grid · Attach to scene. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachSceneGridInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "delete": { "operationId": "detachSceneGrid", "summary": "Grid · Detach from scene", "tags": [ "Projects & resources" ], "description": "Grid · Detach from scene. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/detachSceneGridInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/episodes": { "get": { "operationId": "listEpisodes", "summary": "Episode · Read (list)", "tags": [ "Projects & resources" ], "description": "Episode · Read (list). GET /api/v1/works/{work_id}/episodes. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicEpisodePage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "post": { "operationId": "createEpisode", "summary": "Create episode", "tags": [ "Projects & resources" ], "description": "Create episode. POST /api/v1/works/{work_id}/episodes. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createEpisodeInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/episodes/{episode_id}": { "get": { "operationId": "getEpisode", "summary": "Episode · Read", "tags": [ "Projects & resources" ], "description": "Episode · Read. GET /api/v1/works/{work_id}/episodes/{episode_id}. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "episode_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicEpisode" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "patch": { "operationId": "updateEpisode", "summary": "Episode · Update", "tags": [ "Projects & resources" ], "description": "Episode · Update. PATCH /api/v1/works/{work_id}/episodes/{episode_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "episode_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateEpisodeInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "delete": { "operationId": "deleteEpisode", "summary": "Episode · Delete", "tags": [ "Projects & resources" ], "description": "Episode · Delete. DELETE /api/v1/works/{work_id}/episodes/{episode_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "episode_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteEpisodeInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/episodes/{episode_id}/scenes": { "get": { "operationId": "listScenes", "summary": "Scene · Read (list)", "tags": [ "Projects & resources" ], "description": "Scene · Read (list). GET /api/v1/works/{work_id}/episodes/{episode_id}/scenes. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "episode_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicScenePage" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "post": { "operationId": "createScene", "summary": "Create scene", "tags": [ "Projects & resources" ], "description": "Create scene. POST /api/v1/works/{work_id}/episodes/{episode_id}/scenes. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "episode_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSceneInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}": { "get": { "operationId": "getScene", "summary": "Scene · Read", "tags": [ "Projects & resources" ], "description": "Scene · Read. GET /api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}. GET", "x-required-scope": "projects:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "episode_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 500 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicScene" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } }, "patch": { "operationId": "updateScene", "summary": "Scene · Update", "tags": [ "Projects & resources" ], "description": "Scene · Update. PATCH /api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "episode_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateSceneInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/archive-imports": { "post": { "operationId": "createArchiveImport", "summary": "Import ZIP archive", "tags": [ "Projects & resources" ], "description": "Import ZIP archive. POST /api/v1/works/{work_id}/archive-imports. Use a verified ZIP asset_id and current revision. Preserves the archive and uses the same name-based material update rules as Studio. Check imported, failed and asset_ids on completion. Creation requires jobs:create, assets:read, assets:write and projects:write. Idempotency-Key; GET /api/v1/works/{work_id}/archive-imports/{import_id}", "x-required-scope": "jobs:create", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createArchiveImportInput" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicArchiveImport" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/archive-imports/{import_id}": { "get": { "operationId": "getArchiveImport", "summary": "Get archive import", "tags": [ "Projects & resources" ], "description": "Get archive import. GET /api/v1/works/{work_id}/archive-imports/{import_id}. Use a verified ZIP asset_id and current revision. Preserves the archive and uses the same name-based material update rules as Studio. Check imported, failed and asset_ids on completion. Creation requires jobs:create, assets:read, assets:write and projects:write. jobs:read", "x-required-scope": "jobs:read", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "import_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicArchiveImport" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/uploads": { "post": { "operationId": "createWorkUploads", "summary": "Prepare file batch upload", "tags": [ "Projects & resources" ], "description": "Prepare file batch upload. POST /api/v1/works/{work_id}/uploads. Idempotency-Key + files (1–20) → PUT upload_url → POST /api/v1/uploads/{upload_id}/complete", "x-required-scope": "assets:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createWorkUploadsInput" } } } }, "responses": { "201": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicUploadBatch" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/scenes/{scene_id}": { "delete": { "operationId": "deleteScene", "summary": "Scene · Delete", "tags": [ "Projects & resources" ], "description": "Scene · Delete. DELETE /api/v1/works/{work_id}/scenes/{scene_id}. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteSceneInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/episodes/{episode_id}/scene-order": { "put": { "operationId": "reorderScenes", "summary": "Reorder scenes", "tags": [ "Projects & resources" ], "description": "Reorder scenes. PUT /api/v1/works/{work_id}/episodes/{episode_id}/scene-order. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "episode_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reorderScenesInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/script": { "put": { "operationId": "saveScript", "summary": "Save script", "tags": [ "Projects & resources" ], "description": "Save script. PUT /api/v1/works/{work_id}/script. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/saveScriptInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/scenes/{scene_id}/video-generations": { "post": { "operationId": "generateSceneVideo", "summary": "Generate scene video", "tags": [ "Projects & resources" ], "description": "Generate scene video. POST /api/v1/works/{work_id}/scenes/{scene_id}/video-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}", "x-required-scope": "jobs:create", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateSceneVideoInput" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/scenes/{scene_id}/selected-take": { "put": { "operationId": "selectSceneTake", "summary": "Select final take", "tags": [ "Projects & resources" ], "description": "Select final take. PUT /api/v1/works/{work_id}/scenes/{scene_id}/selected-take. revision + Idempotency-Key", "x-required-scope": "projects:write", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/selectSceneTakeInput" } } } }, "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicStudioMutation" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/works/{work_id}/exports": { "post": { "operationId": "exportWork", "summary": "Export final video", "tags": [ "Projects & resources" ], "description": "Export final video. POST /api/v1/works/{work_id}/exports. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}", "x-required-scope": "jobs:create", "parameters": [ { "name": "work_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Retry with the same Idempotency-Key and request body.", "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exportWorkInput" } } } }, "responses": { "202": { "description": "Success", "headers": { "X-Request-Id": { "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Revision of a mutable resource.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" }, "description": "Recommended polling interval in seconds." } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "data" ], "properties": { "request_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/PublicJob" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } }, "/api/v1/openapi.json": { "get": { "operationId": "openapiDocument", "summary": "Download the API specification", "description": "Downloads the OpenAPI specification containing API paths, request fields and response schemas.", "tags": [ "Specification" ], "security": [], "responses": { "200": { "description": "OpenAPI document", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/downloads/{asset_id}": { "get": { "operationId": "downloadAsset", "summary": "Download the finished file", "tags": [ "Assets & results" ], "security": [], "description": "Downloads the file bytes using the complete signed download_url returned by getAsset. The link expires after five minutes.", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "expires", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "signature", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "File bytes", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/ApiError" } } } } }, "openapi": "3.1.0", "info": { "title": "FECINE Open API", "version": "1.1.0", "description": "Public FECINE workflow API. Read without signing in; execute with a FECINE API key. GET /capabilities lists available functions. Live uses credits; sandbox returns fixtures. POST retries must reuse Idempotency-Key. This reference is generated from the deployed request and response contracts." }, "servers": [ { "url": "/", "description": "Current FECINE deployment" } ], "security": [ { "PartnerApiKey": [] } ], "components": { "responses": { "ApiError": { "description": "A 2xx response means the request went through. 201 means something was created; 202 means we accepted it and are still working, so there is no result yet — poll the job state to see when it finishes.\nSuccessful responses contain request_id and data. File downloads and the API specification are the only exceptions.\nWhen something fails, every endpoint returns the same error shape. Branch your code on error.code; message is there to tell a person the cause and what to do.\nUse retryable to decide whether to send the request again. Retry automatically only when it is true, and wait as long as retry_after_seconds or the Retry-After header says. When you retry a POST, send the same Idempotency-Key and the same body so nothing is charged or created twice.\nIf you get an error.code you do not recognise, handle it from the HTTP status and retryable. Include request_id when you contact support. Failures that happen after a job is accepted show up in the job state and its result, not in this response.", "headers": { "X-Request-Id": { "description": "Request identifier for support.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "description": "Optional retry delay in seconds; check error.retryable.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "request_id": "11111111-1111-4111-8111-111111111111", "error": { "code": "INVALID_REQUEST", "message": "Invalid input. Check the required fields, types and values.", "retryable": false } } } }, "x-error-codes": [ { "code": "INVALID_REFERENCE", "status": "422", "description": "A selected reference is unavailable or does not belong to this project. Select a ready image from this project." }, { "code": "MODEL_UNAVAILABLE", "status": "422", "description": "The selected model is unavailable. Refresh the model list and select another model." }, { "code": "MODEL_POLICY_REQUIRED", "status": "503", "description": "No default model policy is configured. Specify a model or ask the administrator to configure the task policy." }, { "code": "BUILD_REPLAY_CONFLICT", "status": "409", "description": "The build inputs changed. Review the saved build before continuing." }, { "code": "INVALID_REQUEST", "status": "400,422", "description": "Invalid input. Check the required fields, types and values." }, { "code": "INVALID_API_KEY", "status": "401", "description": "Invalid credentials or download signature. Check the API key or obtain a new download URL." }, { "code": "INSUFFICIENT_SCOPE", "status": "403", "description": "Permission denied. Check the key scopes and project access." }, { "code": "PARTNER_BLOCKED", "status": "403", "description": "Account blocked. Contact support." }, { "code": "PARTNER_PAUSED", "status": "403", "description": "Account paused. Ask the administrator to resume access." }, { "code": "RESOURCE_NOT_FOUND", "status": "404", "description": "Resource unavailable. Check its ID and access permissions." }, { "code": "METHOD_NOT_ALLOWED", "status": "405", "description": "Unsupported HTTP method. Use the documented method." }, { "code": "REQUEST_TIMEOUT", "status": "408", "description": "Request body timed out. Check the connection and upload size." }, { "code": "IDEMPOTENCY_KEY_REQUIRED", "status": "400", "description": "Provide a valid Idempotency-Key header." }, { "code": "IDEMPOTENCY_CONFLICT", "status": "409", "description": "This Idempotency-Key belongs to a different request. Reuse it only with the original request." }, { "code": "IDEMPOTENCY_KEY_EXPIRED", "status": "409", "description": "Idempotency record expired. Check the original result before starting a new operation." }, { "code": "PRECONDITION_FAILED", "status": "412", "description": "Provide the latest quoted ETag in If-Match." }, { "code": "REVISION_CONFLICT", "status": "409", "description": "Resource changed. Read the latest revision before updating." }, { "code": "RESOURCE_CONFLICT", "status": "409", "description": "Resource conflicts with existing data. Review the current resource." }, { "code": "INVALID_TRANSITION", "status": "409", "description": "Action is unavailable in the current state. Read the latest state." }, { "code": "RUN_IN_PROGRESS", "status": "409", "description": "A run is in progress. Check its status before starting another." }, { "code": "JOB_RUNNING", "status": "409", "description": "A job is running. Wait for completion before editing." }, { "code": "PLAN_EXPIRED", "status": "409", "description": "Plan expired. Create a new plan and review its quote." }, { "code": "INSUFFICIENT_CREDITS", "status": "402", "description": "Insufficient credits. Check the balance and required credits." }, { "code": "BUDGET_EXCEEDED", "status": "409,429", "description": "Budget limit exceeded. Review usage and the configured budget." }, { "code": "RATE_LIMITED", "status": "429", "description": "Request rate exceeded. Follow retryable and Retry-After before retrying." }, { "code": "CAPACITY_EXCEEDED", "status": "429", "description": "Capacity limit exceeded. Reduce the workload or wait for active work to finish." }, { "code": "PAYLOAD_TOO_LARGE", "status": "413", "description": "Request body too large. Reduce it to the documented limit." }, { "code": "UNSUPPORTED_MEDIA_TYPE", "status": "415", "description": "Unsupported content type or encoding. Use the documented Content-Type without Content-Encoding." }, { "code": "UPLOAD_TOO_LARGE", "status": "422", "description": "Uploaded content exceeds its processing limit. Reduce the file size." }, { "code": "UPLOAD_NOT_VERIFIED", "status": "422", "description": "Upload is incomplete, expired or invalid. Check the upload and verification steps." }, { "code": "ASSET_KIND_MISMATCH", "status": "422", "description": "Asset type does not match the operation. Select a compatible asset." }, { "code": "SELECTED_IMAGE_REQUIRED", "status": "422", "description": "Select a valid image before generating video." }, { "code": "SELECTED_VIDEO_REQUIRED", "status": "422", "description": "Select valid videos for the requested shots before assembly." }, { "code": "REFERENCE_LIMIT_EXCEEDED", "status": "422", "description": "Too many reference assets. Reduce them to the model limit." }, { "code": "REFERENCE_IMAGE_REQUIRED", "status": "422", "description": "This model requires a reference image. Add an image or select a text-to-image model." }, { "code": "INVALID_GENERATION_OPTIONS", "status": "422", "description": "Generation options are invalid. Check the model capabilities." }, { "code": "PROMPT_REQUIRED", "status": "422", "description": "Provide a generation prompt." }, { "code": "SCRIPT_TEXT_REQUIRED", "status": "422", "description": "Provide script text before starting this operation." }, { "code": "SCENES_REQUIRED", "status": "422", "description": "Create scenes before starting this operation." }, { "code": "VARIANT_NAME_REQUIRED", "status": "422", "description": "Provide a variant name." }, { "code": "EPISODE_ALREADY_STRUCTURED", "status": "409", "description": "Episode already has shots. Review its existing structure." }, { "code": "ONE_SCRIPT_PER_PROJECT", "status": "409", "description": "This project supports one script. Use the existing script." }, { "code": "MULTIPLE_SCRIPTS_REQUIRE_REVIEW", "status": "409", "description": "Multiple scripts need review before continuing." }, { "code": "NATIVE_CONTENT_ALREADY_EXISTS", "status": "409", "description": "Studio content already exists. Review it before continuing." }, { "code": "LIVE_PROJECT_REQUIRED", "status": "409", "description": "This operation requires a live project." }, { "code": "STUDIO_MIGRATION_REQUIRED", "status": "409", "description": "Project needs Studio migration. Contact support." }, { "code": "UNSUPPORTED_CAPABILITY", "status": "422", "description": "Unsupported operation or profile. Check GET /capabilities." }, { "code": "CAPABILITY_UNAVAILABLE", "status": "503", "description": "Capability currently unavailable. Check GET /capabilities." }, { "code": "API_NOT_ACCEPTING", "status": "503", "description": "New requests are paused. Check service availability." }, { "code": "DEPENDENCY_UNAVAILABLE", "status": "503", "description": "A required service is unavailable. Follow the retry guidance or contact support." }, { "code": "PRICING_UNAVAILABLE", "status": "503", "description": "Pricing unavailable. A valid quote is required to proceed." }, { "code": "MEDIA_TOOLS_UNAVAILABLE", "status": "503", "description": "Media processing unavailable. Contact support." }, { "code": "STORAGE_READ_FAILED", "status": "503", "description": "Could not read the stored asset. Contact support with request_id." }, { "code": "STORAGE_WRITE_FAILED", "status": "503", "description": "Could not save the asset. Check the result before retrying." }, { "code": "INTERNAL_ERROR", "status": "500", "description": "Internal error. Follow retry guidance; include request_id when contacting support." }, { "code": "RESPONSE_CONTRACT_VIOLATION", "status": "500", "description": "Server response validation failed. Contact support with request_id." }, { "code": "INVALID_EXECUTION_CONTEXT", "status": "500", "description": "Execution context is invalid. Contact support." }, { "code": "RETRY_TRANSACTION", "status": "503", "description": "Transaction could not complete. Follow the response retry guidance." }, { "code": "CLAIM_LOST", "status": "409", "description": "Execution ownership changed. Check the current job state." }, { "code": "PROVIDER_TIMEOUT", "status": "504", "description": "Generation service timed out. Check the existing job before submitting again." }, { "code": "PROVIDER_TERMINAL_FAILURE", "status": "422", "description": "Generation failed. Review the job result and inputs." }, { "code": "PROVIDER_RESULT_UNAVAILABLE", "status": "502", "description": "Generation result unavailable. Check the existing job and recovery options." }, { "code": "INVALID_RESULT", "status": "422,503", "description": "Result failed validation. Review the job or contact support." }, { "code": "RESULT_TOO_LARGE", "status": "422", "description": "Result exceeds the processing limit. Reduce the requested output." }, { "code": "EXPORT_TOO_LARGE", "status": "422", "description": "Export exceeds the size limit. Reduce the export selection." }, { "code": "RECOVERY_BACKOFF", "status": "409", "description": "Existing result recovery is delayed. Check again later; do not resubmit generation." }, { "code": "VIDEO_RECOVERY_REVIEW_REQUIRED", "status": "503", "description": "The original video task needs scheduled recovery or operator review. Do not resubmit generation." }, { "code": "RESULT_RECOVERY_REQUIRED", "status": "409,503", "description": "Existing result needs recovery. Check the run recovery options before resubmitting." }, { "code": "RESULT_NOT_RECOVERABLE", "status": "409", "description": "Result cannot be recovered through this action. Review the run or contact support." }, { "code": "RECOVERY_CAPACITY_EXCEEDED", "status": "409", "description": "Recovery limit reached. Contact support before further recovery attempts." }, { "code": "USAGE_RECOVERY_REQUIRED", "status": "503", "description": "Usage needs reconciliation. Contact support; do not resubmit generation blindly." } ] } }, "securitySchemes": { "PartnerApiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "FECINE API Key", "description": "Enter your fec_live_* or fec_test_* FECINE key." } }, "schemas": { "ErrorResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable error identifier. See components.responses.ApiError.x-error-codes; handle unknown codes safely." }, "message": { "type": "string", "description": "Human-readable cause and action. Use code, not message, for program logic." }, "retryable": { "type": "boolean", "description": "Whether automatic retry is allowed. Do not infer this from the HTTP status alone." }, "retry_after_seconds": { "type": "integer", "minimum": 1, "description": "Wait at least this many seconds before an allowed retry." } }, "required": [ "code", "message", "retryable" ], "additionalProperties": false } }, "required": [ "request_id", "error" ], "additionalProperties": false }, "Money": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, "ProjectCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "client_reference": { "type": "string", "maxLength": 128 } }, "required": [ "name" ], "additionalProperties": false }, "ProjectPatch": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "state": { "type": "string", "enum": [ "active", "archived" ] } }, "additionalProperties": false, "description": "At least one field is required." }, "Project": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "revision": { "type": "integer", "minimum": 1 }, "state": { "type": "string", "enum": [ "active", "archived" ] }, "created_at": { "type": "string", "format": "date-time" }, "client_reference": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] } }, "required": [ "id", "name", "revision", "state", "created_at", "client_reference" ], "additionalProperties": false }, "ResourceInput": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "script" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 900000 }, "source_asset_id": { "type": "string", "format": "uuid" }, "language": { "type": "string", "minLength": 2, "maxLength": 16 } }, "required": [ "language" ], "additionalProperties": false, "description": "Provide exactly one of text or source_asset_id." } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "character" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "scene" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "prop" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "episode" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "script_resource_id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer", "minimum": 1, "maximum": 100 }, "raw_content": { "type": "string", "maxLength": 20000 }, "description": { "type": "string", "maxLength": 4000 } }, "required": [ "script_resource_id", "sequence" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "shot" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "episode_id": { "type": "string", "format": "uuid" }, "scene_id": { "type": "string", "format": "uuid" }, "character_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] }, "prop_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] }, "description": { "type": "string", "maxLength": 4000 }, "video_prompt": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ] }, "sequence": { "type": "integer", "minimum": 1, "maximum": 100 }, "duration_seconds": { "type": "integer", "minimum": 1, "maximum": 60 }, "selected_image_asset_id": { "type": "string", "format": "uuid" }, "selected_video_asset_id": { "type": "string", "format": "uuid" } }, "required": [ "episode_id", "description", "duration_seconds" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false } ] }, "Resource": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "minimum": 1 }, "content": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "script" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 900000 }, "source_asset_id": { "type": "string", "format": "uuid" }, "language": { "type": "string", "minLength": 2, "maxLength": 16 } }, "required": [ "language" ], "additionalProperties": false, "description": "Provide exactly one of text or source_asset_id." } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "character" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "scene" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "prop" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "episode" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "script_resource_id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer", "minimum": 1, "maximum": 100 }, "raw_content": { "type": "string", "maxLength": 20000 }, "description": { "type": "string", "maxLength": 4000 } }, "required": [ "script_resource_id", "sequence" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "shot" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "episode_id": { "type": "string", "format": "uuid" }, "scene_id": { "type": "string", "format": "uuid" }, "character_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] }, "prop_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] }, "description": { "type": "string", "maxLength": 4000 }, "video_prompt": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ] }, "sequence": { "type": "integer", "minimum": 1, "maximum": 100 }, "duration_seconds": { "type": "integer", "minimum": 1, "maximum": 60 }, "selected_image_asset_id": { "type": "string", "format": "uuid" }, "selected_video_asset_id": { "type": "string", "format": "uuid" } }, "required": [ "episode_id", "description", "duration_seconds" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "project_id", "revision", "content", "created_at" ], "additionalProperties": false }, "Capability": { "type": "object", "properties": { "studio_workflow": { "type": "object", "properties": { "equivalent": { "type": "boolean" }, "stages": { "type": "array", "items": { "type": "string", "enum": [ "script", "designs", "storyboard", "cut" ] } }, "project_access": { "type": "string", "enum": [ "read_only", "read_write", "mixed" ] }, "gaps": { "type": "array", "items": { "type": "string" } }, "operations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "id", "path", "enabled" ], "additionalProperties": false }, "default": [] }, "commands": { "type": "array", "items": { "type": "string" }, "default": [] }, "image_models": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "enabled": { "type": "boolean" }, "aspect_ratios": { "type": "array", "items": { "type": "string" } }, "image_sizes": { "type": "array", "items": { "type": "string" } }, "max_reference_images": { "type": "integer", "minimum": 0 }, "max_variants": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "enabled", "aspect_ratios", "image_sizes", "max_reference_images", "max_variants" ], "additionalProperties": false }, "default": [] } }, "required": [ "equivalent", "stages", "project_access", "gaps" ], "additionalProperties": false }, "template_id": { "type": "string", "minLength": 1, "maxLength": 100 }, "template_version": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "stages": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "output_profiles": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "unsupported_reasons": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 500 } }, "max_shots": { "type": "integer", "minimum": 1 }, "max_episode_seconds": { "type": "integer", "minimum": 1 }, "upload_mime_types": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "max_upload_bytes": { "type": "integer", "minimum": 1 }, "upload_limits": { "type": "object", "additionalProperties": { "type": "integer", "exclusiveMinimum": 0 } }, "job_types": { "type": "array", "items": { "type": "string", "enum": [ "analyze_script", "generate_image", "generate_video", "assemble_video" ] } }, "operations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "type", "enabled" ], "additionalProperties": false } }, "image_size": { "type": "string" }, "max_reference_images": { "type": "integer" } }, "required": [ "studio_workflow", "template_id", "template_version", "enabled", "stages", "output_profiles", "unsupported_reasons", "max_shots", "max_episode_seconds", "upload_mime_types", "max_upload_bytes" ], "additionalProperties": false }, "PlanInput": { "type": "object", "properties": { "template_id": { "type": "string", "const": "episode-production" }, "template_version": { "type": "number", "const": 1 }, "project_revision": { "type": "integer", "exclusiveMinimum": 0 }, "episode_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 10, "description": "Episode IDs must be unique." }, "mode": { "type": "string", "enum": [ "reviewed", "automatic" ] }, "output_profile": { "type": "string", "enum": [ "sandbox-episode-v1", "episode-standard-v1" ] } }, "required": [ "template_id", "template_version", "project_revision", "episode_ids", "mode", "output_profile" ], "additionalProperties": false }, "PlannedStep": { "type": "object", "properties": { "stage_key": { "type": "string", "minLength": 1, "maxLength": 100 }, "target_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "depends_on": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "requires_review": { "type": "boolean" }, "max_cost": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "stage_key", "target_ids", "depends_on", "requires_review", "max_cost" ], "additionalProperties": false }, "Plan": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "project_revision": { "type": "integer", "minimum": 1 }, "template_id": { "type": "string", "minLength": 1, "maxLength": 100 }, "template_version": { "type": "integer", "minimum": 1 }, "executable": { "type": "boolean" }, "expires_at": { "type": "string", "format": "date-time" }, "budget_ceiling": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "steps": { "type": "array", "items": { "type": "object", "properties": { "stage_key": { "type": "string", "minLength": 1, "maxLength": 100 }, "target_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "depends_on": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "requires_review": { "type": "boolean" }, "max_cost": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "stage_key", "target_ids", "depends_on", "requires_review", "max_cost" ], "additionalProperties": false } }, "unsupported_reasons": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 500 } } }, "required": [ "id", "project_id", "project_revision", "template_id", "template_version", "executable", "expires_at", "budget_ceiling", "steps", "unsupported_reasons" ], "additionalProperties": false }, "RunInput": { "type": "object", "properties": { "plan_id": { "type": "string", "format": "uuid" }, "client_reference": { "type": "string", "maxLength": 128 } }, "required": [ "plan_id" ], "additionalProperties": false }, "Run": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "plan_id": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1 }, "state": { "type": "string", "enum": [ "queued", "running", "awaiting_review", "stopping", "paused", "needs_attention", "partially_succeeded", "succeeded", "failed", "cancelled" ] }, "client_reference": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "budget_remaining": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, "committed_cost": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "unresolved_cost": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "output_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id", "project_id", "plan_id", "version", "state", "client_reference", "created_at", "completed_at", "budget_remaining", "committed_cost", "unresolved_cost", "output_asset_ids" ], "additionalProperties": false }, "Step": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "run_id": { "type": "string", "format": "uuid" }, "stage_key": { "type": "string", "minLength": 1, "maxLength": 100 }, "target_id": { "type": "string", "format": "uuid" }, "job_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "blocked", "ready", "queued", "running", "awaiting_review", "succeeded", "failed", "cancelled", "unknown" ] }, "output_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "error_code": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "ordinal": { "type": "integer" } }, "required": [ "id", "run_id", "stage_key", "target_id", "job_id", "state", "output_asset_ids", "error_code", "ordinal" ], "additionalProperties": false }, "RunEvent": { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid" }, "run_id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer", "minimum": 1 }, "type": { "type": "string", "enum": [ "run.state_changed", "run.review_required", "run.result_ready", "run.needs_attention" ] }, "state": { "type": "string", "enum": [ "queued", "running", "awaiting_review", "stopping", "paused", "needs_attention", "partially_succeeded", "succeeded", "failed", "cancelled" ] }, "step_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "event_id", "run_id", "sequence", "type", "state", "step_id", "created_at" ], "additionalProperties": false }, "DecisionInput": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "approve", "stop", "resume", "cancel_remaining", "retry_result" ], "description": "retry_result resumes result polling for an accepted Studio video on the original reservation; requires step_id and expected_version. It never resubmits generation. Unconfirmed usage without a saved video task requires operator review." }, "expected_version": { "type": "integer", "exclusiveMinimum": 0 }, "step_id": { "type": "string", "format": "uuid" }, "selected_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 10 } }, "required": [ "action", "expected_version" ], "additionalProperties": false }, "JobInput": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "project_revision": { "type": "integer", "exclusiveMinimum": 0 }, "target_id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "analyze_script", "generate_image", "generate_video", "assemble_video" ] }, "profile_id": { "type": "string", "maxLength": 100 }, "client_reference": { "type": "string", "maxLength": 128 } }, "required": [ "project_id", "project_revision", "target_id", "type", "profile_id" ], "additionalProperties": false }, "Job": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "queued", "ready", "blocked", "processing", "awaiting_review", "succeeded", "failed", "cancelled", "needs_review" ] }, "output_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "error_code": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "resource_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "skipped_scene_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id", "project_id", "run_id", "state", "output_asset_ids", "error_code" ], "additionalProperties": false }, "UploadInput": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "filename": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^\\\\/\\x00-\\x1f]+$" }, "mime_type": { "type": "string", "enum": [ "text/plain", "text/markdown", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "image/png", "image/jpeg", "image/webp", "image/avif", "audio/wav", "application/zip" ] }, "size_bytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 1073741824 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "project_id", "filename", "mime_type", "size_bytes", "sha256" ], "additionalProperties": false, "description": "Supports TXT, Markdown, DOCX, PNG, JPEG, WebP, AVIF, WAV and ZIP. Byte limits share Studio settings: read upload_limits from GET /capabilities. Scripts allow up to 5,000,000 characters. Filenames cannot contain path separators. WAV must use PCM or IEEE float." }, "UploadTicket": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" }, "upload_url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "PUT" ] }, "content_type": { "type": "string", "minLength": 1, "maxLength": 100 }, "expires_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "asset_id", "upload_url", "method", "content_type", "expires_at" ], "additionalProperties": false }, "Asset": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "state": { "type": "string", "enum": [ "pending", "verified", "ready", "errored", "expired" ] }, "mime_type": { "type": "string", "minLength": 1, "maxLength": 100 }, "size_bytes": { "type": "integer", "minimum": 0 }, "download_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } }, "required": [ "id", "project_id", "state", "mime_type", "size_bytes", "download_url", "expires_at" ], "additionalProperties": false }, "RequestLog": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "method": { "type": "string", "enum": [ "GET", "POST", "PATCH", "PUT" ] }, "route_template": { "type": "string", "minLength": 1, "maxLength": 300 }, "status_code": { "type": "integer", "minimum": 100, "maximum": 599 }, "duration_ms": { "type": "integer", "minimum": 0 }, "actor_kind": { "type": "string", "enum": [ "api_key", "console" ] }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "replayed": { "type": "boolean" }, "error_code": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] } }, "required": [ "request_id", "created_at", "method", "route_template", "status_code", "duration_ms", "actor_kind", "project_id", "run_id", "job_id", "replayed", "error_code" ], "additionalProperties": false }, "Usage": { "type": "object", "properties": { "period_start": { "type": "string", "format": "date-time" }, "period_end": { "type": "string", "format": "date-time" }, "as_of": { "type": "string", "format": "date-time" }, "http_requests": { "type": "integer", "minimum": 0 }, "runs": { "type": "integer", "minimum": 0 }, "jobs": { "type": "integer", "minimum": 0 }, "reserved": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, "committed": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, "unresolved": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "remaining": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, "amount_basis": { "type": "string", "enum": [ "partner_limit" ] }, "billing_mode": { "type": "string", "enum": [ "pilot", "contract" ] } }, "required": [ "period_start", "period_end", "as_of", "http_requests", "runs", "jobs", "reserved", "committed", "unresolved", "remaining", "amount_basis", "billing_mode" ], "additionalProperties": false }, "WebhookCreate": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000 }, "project_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 100 }, "events": { "type": "array", "items": { "type": "string", "enum": [ "run.state_changed", "run.review_required", "run.result_ready", "run.needs_attention" ] }, "minItems": 1, "maxItems": 4 } }, "required": [ "url", "project_ids", "events" ], "additionalProperties": false }, "WebhookPatch": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "run.state_changed", "run.review_required", "run.result_ready", "run.needs_attention" ] }, "minItems": 1, "maxItems": 4 } }, "additionalProperties": false, "description": "At least one field is required." }, "WebhookEndpoint": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "project_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "events": { "type": "array", "items": { "type": "string", "enum": [ "run.state_changed", "run.review_required", "run.result_ready", "run.needs_attention" ] } }, "enabled": { "type": "boolean" }, "verified": { "type": "boolean" }, "secret_version": { "type": "integer", "minimum": 1 }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "project_ids", "events", "enabled", "verified", "secret_version", "created_at" ], "additionalProperties": false }, "WebhookIssued": { "type": "object", "properties": { "endpoint": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "project_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "events": { "type": "array", "items": { "type": "string", "enum": [ "run.state_changed", "run.review_required", "run.result_ready", "run.needs_attention" ] } }, "enabled": { "type": "boolean" }, "verified": { "type": "boolean" }, "secret_version": { "type": "integer", "minimum": 1 }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "project_ids", "events", "enabled", "verified", "secret_version", "created_at" ], "additionalProperties": false }, "signing_secret": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "endpoint" ], "additionalProperties": false }, "WebhookDelivery": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "endpoint_id": { "type": "string", "format": "uuid" }, "event_id": { "type": "string", "format": "uuid" }, "state": { "type": "string", "enum": [ "pending", "sending", "succeeded", "retrying", "exhausted" ] }, "attempt": { "type": "integer", "minimum": 0 }, "http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "next_attempt_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "endpoint_id", "event_id", "state", "attempt", "http_status", "next_attempt_at", "created_at" ], "additionalProperties": false }, "Empty": { "type": "object", "properties": {}, "additionalProperties": false }, "CapabilityPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "studio_workflow": { "type": "object", "properties": { "equivalent": { "type": "boolean" }, "stages": { "type": "array", "items": { "type": "string", "enum": [ "script", "designs", "storyboard", "cut" ] } }, "project_access": { "type": "string", "enum": [ "read_only", "read_write", "mixed" ] }, "gaps": { "type": "array", "items": { "type": "string" } }, "operations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "id", "path", "enabled" ], "additionalProperties": false }, "default": [] }, "commands": { "type": "array", "items": { "type": "string" }, "default": [] }, "image_models": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "enabled": { "type": "boolean" }, "aspect_ratios": { "type": "array", "items": { "type": "string" } }, "image_sizes": { "type": "array", "items": { "type": "string" } }, "max_reference_images": { "type": "integer", "minimum": 0 }, "max_variants": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "enabled", "aspect_ratios", "image_sizes", "max_reference_images", "max_variants" ], "additionalProperties": false }, "default": [] } }, "required": [ "equivalent", "stages", "project_access", "gaps" ], "additionalProperties": false }, "template_id": { "type": "string", "minLength": 1, "maxLength": 100 }, "template_version": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "stages": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "output_profiles": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "unsupported_reasons": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 500 } }, "max_shots": { "type": "integer", "minimum": 1 }, "max_episode_seconds": { "type": "integer", "minimum": 1 }, "upload_mime_types": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "max_upload_bytes": { "type": "integer", "minimum": 1 }, "upload_limits": { "type": "object", "additionalProperties": { "type": "integer", "exclusiveMinimum": 0 } }, "job_types": { "type": "array", "items": { "type": "string", "enum": [ "analyze_script", "generate_image", "generate_video", "assemble_video" ] } }, "operations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "type", "enabled" ], "additionalProperties": false } }, "image_size": { "type": "string" }, "max_reference_images": { "type": "integer" } }, "required": [ "studio_workflow", "template_id", "template_version", "enabled", "stages", "output_profiles", "unsupported_reasons", "max_shots", "max_episode_seconds", "upload_mime_types", "max_upload_bytes" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "ProjectPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "revision": { "type": "integer", "minimum": 1 }, "state": { "type": "string", "enum": [ "active", "archived" ] }, "created_at": { "type": "string", "format": "date-time" }, "client_reference": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] } }, "required": [ "id", "name", "revision", "state", "created_at", "client_reference" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "ResourcePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "minimum": 1 }, "content": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "script" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 900000 }, "source_asset_id": { "type": "string", "format": "uuid" }, "language": { "type": "string", "minLength": 2, "maxLength": 16 } }, "required": [ "language" ], "additionalProperties": false, "description": "Provide exactly one of text or source_asset_id." } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "character" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "scene" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "prop" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "episode" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "script_resource_id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer", "minimum": 1, "maximum": 100 }, "raw_content": { "type": "string", "maxLength": 20000 }, "description": { "type": "string", "maxLength": 4000 } }, "required": [ "script_resource_id", "sequence" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "shot" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "episode_id": { "type": "string", "format": "uuid" }, "scene_id": { "type": "string", "format": "uuid" }, "character_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] }, "prop_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] }, "description": { "type": "string", "maxLength": 4000 }, "video_prompt": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ] }, "sequence": { "type": "integer", "minimum": 1, "maximum": 100 }, "duration_seconds": { "type": "integer", "minimum": 1, "maximum": 60 }, "selected_image_asset_id": { "type": "string", "format": "uuid" }, "selected_video_asset_id": { "type": "string", "format": "uuid" } }, "required": [ "episode_id", "description", "duration_seconds" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "project_id", "revision", "content", "created_at" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "RunPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "plan_id": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1 }, "state": { "type": "string", "enum": [ "queued", "running", "awaiting_review", "stopping", "paused", "needs_attention", "partially_succeeded", "succeeded", "failed", "cancelled" ] }, "client_reference": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "budget_remaining": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, "committed_cost": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "unresolved_cost": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "output_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id", "project_id", "plan_id", "version", "state", "client_reference", "created_at", "completed_at", "budget_remaining", "committed_cost", "unresolved_cost", "output_asset_ids" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "StepPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "run_id": { "type": "string", "format": "uuid" }, "stage_key": { "type": "string", "minLength": 1, "maxLength": 100 }, "target_id": { "type": "string", "format": "uuid" }, "job_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "blocked", "ready", "queued", "running", "awaiting_review", "succeeded", "failed", "cancelled", "unknown" ] }, "output_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "error_code": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "ordinal": { "type": "integer" } }, "required": [ "id", "run_id", "stage_key", "target_id", "job_id", "state", "output_asset_ids", "error_code", "ordinal" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "RunEventPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid" }, "run_id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer", "minimum": 1 }, "type": { "type": "string", "enum": [ "run.state_changed", "run.review_required", "run.result_ready", "run.needs_attention" ] }, "state": { "type": "string", "enum": [ "queued", "running", "awaiting_review", "stopping", "paused", "needs_attention", "partially_succeeded", "succeeded", "failed", "cancelled" ] }, "step_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "event_id", "run_id", "sequence", "type", "state", "step_id", "created_at" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "RequestLogPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "method": { "type": "string", "enum": [ "GET", "POST", "PATCH", "PUT" ] }, "route_template": { "type": "string", "minLength": 1, "maxLength": 300 }, "status_code": { "type": "integer", "minimum": 100, "maximum": 599 }, "duration_ms": { "type": "integer", "minimum": 0 }, "actor_kind": { "type": "string", "enum": [ "api_key", "console" ] }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "replayed": { "type": "boolean" }, "error_code": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] } }, "required": [ "request_id", "created_at", "method", "route_template", "status_code", "duration_ms", "actor_kind", "project_id", "run_id", "job_id", "replayed", "error_code" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "WebhookEndpointPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "project_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "events": { "type": "array", "items": { "type": "string", "enum": [ "run.state_changed", "run.review_required", "run.result_ready", "run.needs_attention" ] } }, "enabled": { "type": "boolean" }, "verified": { "type": "boolean" }, "secret_version": { "type": "integer", "minimum": 1 }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "project_ids", "events", "enabled", "verified", "secret_version", "created_at" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "WebhookDeliveryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "endpoint_id": { "type": "string", "format": "uuid" }, "event_id": { "type": "string", "format": "uuid" }, "state": { "type": "string", "enum": [ "pending", "sending", "succeeded", "retrying", "exhausted" ] }, "attempt": { "type": "integer", "minimum": 0 }, "http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "next_attempt_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "endpoint_id", "event_id", "state", "attempt", "http_status", "next_attempt_at", "created_at" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "ArchiveImport": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "work_id": { "type": "string", "format": "uuid" }, "state": { "type": "string", "enum": [ "queued", "running", "deferred", "succeeded", "failed", "cancelled" ] }, "progress": { "anyOf": [ { "type": "object", "properties": { "phase": { "type": "string", "enum": [ "extracting", "importing" ] }, "current": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "phase", "current", "total" ], "additionalProperties": false }, { "type": "null" } ] }, "imported": { "type": "integer", "minimum": 0 }, "failed": { "type": "integer", "minimum": 0 }, "asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "error_code": { "type": [ "string", "null" ] } }, "required": [ "id", "work_id", "state", "progress", "imported", "failed", "asset_ids", "error_code" ], "additionalProperties": false }, "Episode": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "title": { "type": "string" }, "raw_content": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "id", "number", "title", "raw_content", "description" ], "additionalProperties": false }, "Scene": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "episode_id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "heading": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "video_prompt": { "type": [ "string", "null" ] } }, "required": [ "id", "episode_id", "number", "heading", "description", "video_prompt" ], "additionalProperties": false }, "EpisodePage": { "type": "object", "properties": { "work_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "title": { "type": "string" }, "raw_content": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "id", "number", "title", "raw_content", "description" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "work_id", "revision", "items", "next_cursor" ], "additionalProperties": false }, "ScenePage": { "type": "object", "properties": { "work_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "episode_id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "heading": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "video_prompt": { "type": [ "string", "null" ] } }, "required": [ "id", "episode_id", "number", "heading", "description", "video_prompt" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "work_id", "revision", "items", "next_cursor" ], "additionalProperties": false }, "Reference": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "character", "scene", "prop", "grid" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "primary_asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "id", "kind", "name", "description", "tags", "primary_asset_id" ], "additionalProperties": false }, "ReferencePage": { "type": "object", "properties": { "work_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "character", "scene", "prop", "grid" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "primary_asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "id", "kind", "name", "description", "tags", "primary_asset_id" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "work_id", "revision", "items", "next_cursor" ], "additionalProperties": false }, "UploadBatch": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "items": { "type": "array", "items": { "type": "object", "properties": { "filename": { "type": "string" }, "ticket": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" }, "upload_url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "PUT" ] }, "content_type": { "type": "string", "minLength": 1, "maxLength": 100 }, "expires_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "asset_id", "upload_url", "method", "content_type", "expires_at" ], "additionalProperties": false } }, "required": [ "filename", "ticket" ], "additionalProperties": false } } }, "required": [ "project_id", "items" ], "additionalProperties": false }, "listCharactersInput": { "type": "object", "properties": {}, "additionalProperties": false }, "getCharacterInput": { "type": "object", "properties": {}, "additionalProperties": false }, "createCharacterInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 4000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 8 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "name", "revision" ], "additionalProperties": false }, "updateCharacterInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 4000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 8 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "name", "revision" ], "additionalProperties": false }, "deleteCharacterInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "setCharacterImageInput": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid" }, "current_asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "asset_id", "current_asset_id", "revision" ], "additionalProperties": false }, "generateCharacterImageInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "variants": { "type": "integer", "minimum": 1, "maximum": 4, "default": 1 }, "model": { "type": "string", "minLength": 1, "maxLength": 200, "default": "image-standard" }, "prompt": { "type": "string", "minLength": 1, "maxLength": 20000 }, "aspect_ratio": { "type": "string", "pattern": "^(auto|[1-9]\\d*:[1-9]\\d*)$" }, "image_size": { "type": "string", "maxLength": 40 }, "quality": { "type": "string", "enum": [ "low", "medium", "high" ] }, "background": { "type": "string", "enum": [ "auto", "opaque", "transparent" ] }, "output_format": { "type": "string", "enum": [ "png", "jpeg" ] }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 16, "default": [] }, "slot": { "type": "string", "enum": [ "primary", "variant" ], "default": "primary" }, "variant_name": { "type": "string", "minLength": 1, "maxLength": 80 }, "current_asset_id": { "type": "string", "format": "uuid" } }, "required": [ "revision" ], "additionalProperties": false }, "attachSceneCharacterInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "detachSceneCharacterInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "listBackgroundScenesInput": { "type": "object", "properties": {}, "additionalProperties": false }, "getBackgroundSceneInput": { "type": "object", "properties": {}, "additionalProperties": false }, "createBackgroundSceneInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 4000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 8 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "name", "revision" ], "additionalProperties": false }, "updateBackgroundSceneInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 4000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 8 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "name", "revision" ], "additionalProperties": false }, "deleteBackgroundSceneInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "setBackgroundSceneImageInput": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid" }, "current_asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "asset_id", "current_asset_id", "revision" ], "additionalProperties": false }, "generateBackgroundSceneImageInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "variants": { "type": "integer", "minimum": 1, "maximum": 4, "default": 1 }, "model": { "type": "string", "minLength": 1, "maxLength": 200, "default": "image-standard" }, "prompt": { "type": "string", "minLength": 1, "maxLength": 20000 }, "aspect_ratio": { "type": "string", "pattern": "^(auto|[1-9]\\d*:[1-9]\\d*)$" }, "image_size": { "type": "string", "maxLength": 40 }, "quality": { "type": "string", "enum": [ "low", "medium", "high" ] }, "background": { "type": "string", "enum": [ "auto", "opaque", "transparent" ] }, "output_format": { "type": "string", "enum": [ "png", "jpeg" ] }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 16, "default": [] }, "slot": { "type": "string", "enum": [ "primary", "variant" ], "default": "primary" }, "variant_name": { "type": "string", "minLength": 1, "maxLength": 80 }, "current_asset_id": { "type": "string", "format": "uuid" } }, "required": [ "revision" ], "additionalProperties": false }, "attachSceneBackgroundSceneInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "detachSceneBackgroundSceneInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "listPropsInput": { "type": "object", "properties": {}, "additionalProperties": false }, "getPropInput": { "type": "object", "properties": {}, "additionalProperties": false }, "createPropInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 4000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 8 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "name", "revision" ], "additionalProperties": false }, "updatePropInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 4000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 8 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "name", "revision" ], "additionalProperties": false }, "deletePropInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "setPropImageInput": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid" }, "current_asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "asset_id", "current_asset_id", "revision" ], "additionalProperties": false }, "generatePropImageInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "variants": { "type": "integer", "minimum": 1, "maximum": 4, "default": 1 }, "model": { "type": "string", "minLength": 1, "maxLength": 200, "default": "image-standard" }, "prompt": { "type": "string", "minLength": 1, "maxLength": 20000 }, "aspect_ratio": { "type": "string", "pattern": "^(auto|[1-9]\\d*:[1-9]\\d*)$" }, "image_size": { "type": "string", "maxLength": 40 }, "quality": { "type": "string", "enum": [ "low", "medium", "high" ] }, "background": { "type": "string", "enum": [ "auto", "opaque", "transparent" ] }, "output_format": { "type": "string", "enum": [ "png", "jpeg" ] }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 16, "default": [] }, "slot": { "type": "string", "enum": [ "primary", "variant" ], "default": "primary" }, "variant_name": { "type": "string", "minLength": 1, "maxLength": 80 }, "current_asset_id": { "type": "string", "format": "uuid" } }, "required": [ "revision" ], "additionalProperties": false }, "attachScenePropInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "detachScenePropInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "listGridsInput": { "type": "object", "properties": {}, "additionalProperties": false }, "getGridInput": { "type": "object", "properties": {}, "additionalProperties": false }, "createGridInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 4000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 8 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "name", "revision" ], "additionalProperties": false }, "updateGridInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 4000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 8 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "name", "revision" ], "additionalProperties": false }, "deleteGridInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "setGridImageInput": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid" }, "current_asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "asset_id", "current_asset_id", "revision" ], "additionalProperties": false }, "generateGridImageInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "variants": { "type": "integer", "minimum": 1, "maximum": 4, "default": 1 }, "model": { "type": "string", "minLength": 1, "maxLength": 200, "default": "image-standard" }, "prompt": { "type": "string", "minLength": 1, "maxLength": 20000 }, "aspect_ratio": { "type": "string", "pattern": "^(auto|[1-9]\\d*:[1-9]\\d*)$" }, "image_size": { "type": "string", "maxLength": 40 }, "quality": { "type": "string", "enum": [ "low", "medium", "high" ] }, "background": { "type": "string", "enum": [ "auto", "opaque", "transparent" ] }, "output_format": { "type": "string", "enum": [ "png", "jpeg" ] }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 16, "default": [] }, "slot": { "type": "string", "enum": [ "primary", "variant" ], "default": "primary" }, "variant_name": { "type": "string", "minLength": 1, "maxLength": 80 }, "current_asset_id": { "type": "string", "format": "uuid" } }, "required": [ "revision" ], "additionalProperties": false }, "attachSceneGridInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "detachSceneGridInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "listEpisodesInput": { "type": "object", "properties": {}, "additionalProperties": false }, "getEpisodeInput": { "type": "object", "properties": {}, "additionalProperties": false }, "listScenesInput": { "type": "object", "properties": {}, "additionalProperties": false }, "getSceneInput": { "type": "object", "properties": {}, "additionalProperties": false }, "createArchiveImportInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "asset_id": { "type": "string", "format": "uuid" } }, "required": [ "revision", "asset_id" ], "additionalProperties": false }, "getArchiveImportInput": { "type": "object", "properties": {}, "additionalProperties": false }, "createWorkUploadsInput": { "type": "object", "properties": { "files": { "type": "array", "items": { "type": "object", "properties": { "filename": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^\\\\/\\x00-\\x1f]+$" }, "mime_type": { "type": "string", "enum": [ "text/plain", "text/markdown", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "image/png", "image/jpeg", "image/webp", "image/avif", "audio/wav", "application/zip" ] }, "size_bytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 1073741824 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "filename", "mime_type", "size_bytes", "sha256" ], "additionalProperties": false }, "minItems": 1, "maxItems": 20 } }, "required": [ "files" ], "additionalProperties": false }, "updateEpisodeInput": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "raw_content": { "type": "string", "maxLength": 20000 }, "description": { "type": "string", "maxLength": 4000 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "title", "revision" ], "additionalProperties": false }, "deleteEpisodeInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "updateSceneInput": { "type": "object", "properties": { "heading": { "type": "string", "minLength": 1, "maxLength": 200 }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "description": { "type": "string", "maxLength": 4000 }, "video_prompt": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ] }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "heading", "revision" ], "additionalProperties": false }, "deleteSceneInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "revision" ], "additionalProperties": false }, "reorderScenesInput": { "type": "object", "properties": { "scene_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "scene_ids", "revision" ], "additionalProperties": false }, "createEpisodeInput": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "raw_content": { "type": "string", "maxLength": 20000 }, "description": { "type": "string", "maxLength": 4000 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "title", "revision" ], "additionalProperties": false }, "createSceneInput": { "type": "object", "properties": { "heading": { "type": "string", "minLength": 1, "maxLength": 200 }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "description": { "type": "string", "maxLength": 4000 }, "video_prompt": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ] }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "heading", "revision" ], "additionalProperties": false }, "saveScriptInput": { "type": "object", "properties": { "text": { "type": "string", "maxLength": 5000000 }, "revision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "text", "revision" ], "additionalProperties": false }, "generateSceneVideoInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "anchor_asset_id": { "type": "string", "format": "uuid" }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 12 }, "model": { "type": "string", "minLength": 1, "maxLength": 200, "default": "video-standard" }, "prompt": { "type": "string", "minLength": 1, "maxLength": 10000 }, "duration_seconds": { "type": "integer", "minimum": 1, "maximum": 60 }, "resolution": { "type": "string", "minLength": 1, "maxLength": 20 }, "aspect_ratio": { "type": "string", "minLength": 1, "maxLength": 20 }, "generate_audio": { "type": "boolean" } }, "required": [ "revision", "duration_seconds", "resolution", "aspect_ratio" ], "additionalProperties": false }, "selectSceneTakeInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "take_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "revision", "take_id" ], "additionalProperties": false }, "exportWorkInput": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "allow_partial": { "type": "boolean", "default": true }, "selections": { "type": "array", "items": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" } }, "required": [ "scene_id", "asset_id" ], "additionalProperties": false }, "maxItems": 200 } }, "required": [ "revision" ], "additionalProperties": false }, "StudioBuildProgress": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "run_id": { "type": "string", "format": "uuid" }, "run_version": { "type": "integer" }, "state": { "type": "string" }, "wait_reason": { "type": [ "string", "null" ] }, "stage": { "type": [ "string", "null" ] }, "messages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "role": { "type": "string", "enum": [ "assistant", "system_note" ] }, "stage": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "status": { "type": "string", "enum": [ "streaming", "final" ] }, "seq": { "type": "number" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "role", "stage", "content", "status", "seq", "created_at", "updated_at" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "filterMode": { "type": "string", "enum": [ "prompt_index", "full_text" ] }, "sourceText": { "type": "string" }, "llmText": { "type": "string" }, "originalChars": { "type": "number" }, "preparedChars": { "type": "number" } }, "required": [ "id", "name", "filterMode", "sourceText", "llmText", "originalChars", "preparedChars" ], "additionalProperties": false } } }, "required": [ "id", "state", "stage", "messages", "sources" ], "additionalProperties": false }, "StudioDraft": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "instructions": { "type": "string", "minLength": 1, "maxLength": 8000 }, "source_text": { "type": "string", "maxLength": 50000 }, "max_output_tokens": { "type": "integer", "minimum": 256, "maximum": 8192, "default": 2048 } }, "required": [ "revision", "instructions" ], "additionalProperties": false }, "StudioImport": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "asset_id": { "type": "string", "format": "uuid" } }, "required": [ "revision", "asset_id" ], "additionalProperties": false }, "StudioLibrary": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "kind": { "type": "string" }, "media_type": { "type": "string" }, "mime": { "type": [ "string", "null" ] }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "is_current_version": { "type": "boolean" } }, "required": [ "id", "name", "kind", "media_type", "mime", "version", "is_current_version" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "StudioCommand": { "anyOf": [ { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "design.asset.set" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "primary", "variant" ] }, "current_asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 80 } }, "required": [ "id", "asset_id", "kind", "current_asset_id" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "asset.delete" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "trash.restore" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "entity_type": { "type": "string", "enum": [ "asset", "design" ] } }, "required": [ "id", "entity_type" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "scene.duplicate" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "project.settings.update" }, "input": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 24 }, "maxItems": 8 }, "cover": { "type": "string", "enum": [ "amber", "indigo", "teal", "rust", "moss", "ink", "sage", "bone", "wine", "wash", "blush", "void" ] }, "aspect": { "type": "string", "enum": [ "16:9", "9:16", "1:1", "4:3", "21:9" ] }, "resolution": { "type": "string", "enum": [ "480p", "720p", "1080p", "2k" ] }, "style": { "type": "string", "enum": [ "realistic_general", "realistic_urban", "realistic_cinematic", "2d_japanese_manga", "2d_korean_urban", "2d_korean", "2d_otome", "2d_chinese_manga", "2d_classical", "3d_chinese", "3d_xianxia", "3d_cartoon", "cg_general", "cg_cyberpunk", "ink_gongbi", "custom" ] }, "style_prompt": { "type": "string", "maxLength": 1000 } }, "required": [ "title", "tags", "cover", "aspect", "resolution", "style", "style_prompt" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "project.rename" }, "input": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "title" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "project.state.set" }, "input": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "active", "archived" ] } }, "required": [ "state" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "script.update" }, "input": { "type": "object", "properties": { "text": { "type": "string", "maxLength": 5000000 } }, "required": [ "text" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "script.bible.update" }, "input": { "type": "object", "properties": { "logline": { "type": "string", "maxLength": 500 }, "synopsis": { "type": "string", "maxLength": 4000 } }, "required": [ "logline", "synopsis" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "episode.save" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "raw_content": { "type": "string", "maxLength": 20000 }, "description": { "type": "string", "maxLength": 4000 } }, "required": [ "title" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "episode.delete" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "scene.save" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "episode_id": { "type": "string", "format": "uuid" }, "heading": { "type": "string", "minLength": 1, "maxLength": 200 }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "description": { "type": "string", "maxLength": 4000 }, "video_prompt": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ] } }, "required": [ "episode_id", "heading" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "scene.delete" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "scene.reorder" }, "input": { "type": "object", "properties": { "episode_id": { "type": "string", "format": "uuid" }, "scene_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 500 } }, "required": [ "episode_id", "scene_ids" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "design.save" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "character", "scene", "prop", "grid" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 4000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 8 } }, "required": [ "kind", "name" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "design.delete" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "design.voice.set" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "id", "asset_id" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "design.asset.detach" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "primary", "variant", "voice" ] } }, "required": [ "id", "asset_id", "kind" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "design.asset.restore" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "current_asset_id": { "type": "string", "format": "uuid" }, "restore_asset_id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "primary", "variant" ] } }, "required": [ "id", "current_asset_id", "restore_asset_id", "kind" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "design.variant.rename" }, "input": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 } }, "required": [ "id", "asset_id", "name" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "scene.design.attach" }, "input": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "design_id": { "type": "string", "format": "uuid" } }, "required": [ "scene_id", "design_id" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "scene.design.detach" }, "input": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "design_id": { "type": "string", "format": "uuid" } }, "required": [ "scene_id", "design_id" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "cut.take.select" }, "input": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "scene_id", "asset_id" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "operation": { "type": "string", "const": "take.delete" }, "input": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" } }, "required": [ "scene_id", "asset_id" ], "additionalProperties": false } }, "required": [ "revision", "operation", "input" ], "additionalProperties": false } ] }, "StudioMutation": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "changed_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "studio_url": { "type": "string" } }, "required": [ "project_id", "changed_id", "revision", "studio_url" ], "additionalProperties": false }, "StudioWorkflow": { "type": "object", "properties": { "api_runs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "type": "string" }, "created_at": { "type": "string" }, "completed_at": { "type": [ "string", "null" ] }, "total_steps": { "type": "integer", "minimum": 0 }, "completed_steps": { "type": "integer", "minimum": 0 }, "error_code": { "type": [ "string", "null" ] } }, "required": [ "id", "state", "created_at", "completed_at", "total_steps", "completed_steps", "error_code" ], "additionalProperties": false } }, "project_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "studio_url": { "type": "string" }, "trash": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "entity_type": { "type": "string", "enum": [ "asset", "design" ] }, "name": { "type": "string" }, "deleted_at": { "type": "string" } }, "required": [ "id", "entity_type", "name", "deleted_at" ], "additionalProperties": false } }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "kind": { "type": "string" }, "media_type": { "type": "string" }, "status": { "type": "string" }, "mime": { "type": [ "string", "null" ] }, "lineage_id": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "is_current_version": { "type": "boolean" } }, "required": [ "id", "name", "kind", "media_type", "status", "mime", "lineage_id", "version", "is_current_version" ], "additionalProperties": false } }, "settings": { "type": "object", "properties": { "title": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover": { "type": "string" }, "aspect": { "type": "string" }, "resolution": { "type": "string" }, "style": { "type": "string" }, "style_prompt": { "type": "string" }, "state": { "type": "string" } }, "required": [ "title", "tags", "cover", "aspect", "resolution", "style", "style_prompt", "state" ], "additionalProperties": false }, "script": { "type": "object", "properties": { "text": { "type": "string" }, "logline": { "type": "string" }, "synopsis": { "type": "string" } }, "required": [ "text", "logline", "synopsis" ], "additionalProperties": false }, "episodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "title": { "type": "string" }, "raw_content": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "id", "number", "title", "raw_content", "description" ], "additionalProperties": false } }, "designs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "character", "scene", "prop", "grid" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "primary_asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "id", "kind", "name", "description", "tags", "primary_asset_id" ], "additionalProperties": false } }, "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "episode_id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "heading": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "video_prompt": { "type": [ "string", "null" ] } }, "required": [ "id", "episode_id", "number", "heading", "description", "video_prompt" ], "additionalProperties": false } }, "scene_designs": { "type": "array", "items": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "design_id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" }, "position": { "type": "integer" } }, "required": [ "scene_id", "design_id", "kind", "position" ], "additionalProperties": false } }, "takes": { "type": "array", "items": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" }, "position": { "type": "integer" } }, "required": [ "scene_id", "asset_id", "position" ], "additionalProperties": false } }, "cut_selections": { "type": "array", "items": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" } }, "required": [ "scene_id", "asset_id" ], "additionalProperties": false } }, "design_assets": { "type": "array", "items": { "type": "object", "properties": { "design_id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "position": { "type": "integer" } }, "required": [ "design_id", "asset_id", "kind", "name", "position" ], "additionalProperties": false } } }, "required": [ "api_runs", "project_id", "revision", "studio_url", "trash", "assets", "settings", "script", "episodes", "designs", "scenes", "scene_designs", "takes", "cut_selections", "design_assets" ], "additionalProperties": false }, "StudioAnalysis": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "script_text": { "type": "string", "minLength": 1, "maxLength": 5000000 } }, "required": [ "revision" ], "additionalProperties": false }, "StudioBuild": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "script_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "default": [] }, "material_scope": { "type": "string", "enum": [ "unclassified", "all" ], "default": "unclassified" }, "preprocess": { "type": "object", "properties": { "ignoreAttachments": { "type": "boolean", "default": true }, "discardKeywords": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 }, "maxItems": 100, "default": [ "提示词", "prompt", "Midjourney", "Stable Diffusion", "DALL-E", "Image1", "Image2", "正向提示词", "负向提示词", "视觉描述", "出图要求", "技术规格", "画面描述", "镜头提示词", "请生成", "角色三视图", "服装本体展示", "局部材质与细节放大" ] }, "keepLabels": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 }, "maxItems": 100, "default": [ "资产名称", "资产ID", "资产版本", "关联角色资产名称", "关联角色资产ID", "关联场景资产名称", "关联场景资产ID", "关联道具资产名称", "关联道具资产ID", "服装变体ID", "服装名称", "道具资产ID", "道具名称", "场景资产ID", "场景名称", "宫格图ID", "集数", "主题", "场景", "角色名称", "用途" ] } }, "additionalProperties": false }, "rebuild_policy": { "type": "string", "const": "full_rebuild" } }, "required": [ "revision", "rebuild_policy" ], "additionalProperties": false }, "StudioCutExport": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "allow_partial": { "type": "boolean", "default": true }, "selections": { "type": "array", "items": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" } }, "required": [ "scene_id", "asset_id" ], "additionalProperties": false }, "maxItems": 200 } }, "required": [ "revision" ], "additionalProperties": false }, "StudioVideo": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "scene_id": { "type": "string", "format": "uuid" }, "anchor_asset_id": { "type": "string", "format": "uuid" }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 12 }, "model": { "type": "string", "minLength": 1, "maxLength": 200, "default": "video-standard" }, "prompt": { "type": "string", "minLength": 1, "maxLength": 10000 }, "duration_seconds": { "type": "integer", "minimum": 1, "maximum": 60 }, "resolution": { "type": "string", "minLength": 1, "maxLength": 20 }, "aspect_ratio": { "type": "string", "minLength": 1, "maxLength": 20 }, "generate_audio": { "type": "boolean" } }, "required": [ "revision", "scene_id", "duration_seconds", "resolution", "aspect_ratio" ], "additionalProperties": false }, "StudioImage": { "type": "object", "properties": { "revision": { "type": "integer", "exclusiveMinimum": 0 }, "design_id": { "type": "string", "format": "uuid" }, "variants": { "type": "integer", "minimum": 1, "maximum": 4, "default": 1 }, "model": { "type": "string", "minLength": 1, "maxLength": 200, "default": "image-standard" }, "prompt": { "type": "string", "minLength": 1, "maxLength": 20000 }, "aspect_ratio": { "type": "string", "pattern": "^(auto|[1-9]\\d*:[1-9]\\d*)$" }, "image_size": { "type": "string", "maxLength": 40 }, "quality": { "type": "string", "enum": [ "low", "medium", "high" ] }, "background": { "type": "string", "enum": [ "auto", "opaque", "transparent" ] }, "output_format": { "type": "string", "enum": [ "png", "jpeg" ] }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 16, "default": [] }, "slot": { "type": "string", "enum": [ "primary", "variant" ], "default": "primary" }, "variant_name": { "type": "string", "minLength": 1, "maxLength": 80 }, "current_asset_id": { "type": "string", "format": "uuid" } }, "required": [ "revision", "design_id" ], "additionalProperties": false }, "Uploaded": { "type": "object", "properties": { "uploaded": { "type": "boolean", "const": true } }, "required": [ "uploaded" ], "additionalProperties": false }, "PublicCapabilityPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "studio_workflow": { "type": "object", "properties": { "equivalent": { "type": "boolean" }, "stages": { "type": "array", "items": { "type": "string", "enum": [ "script", "designs", "storyboard", "cut" ] } }, "project_access": { "type": "string", "enum": [ "read_only", "read_write", "mixed" ] }, "gaps": { "type": "array", "items": { "type": "string" } }, "operations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "id", "path", "enabled" ], "additionalProperties": false }, "default": [] }, "commands": { "type": "array", "items": { "type": "string" }, "default": [] }, "image_models": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "enabled": { "type": "boolean" }, "aspect_ratios": { "type": "array", "items": { "type": "string" } }, "image_sizes": { "type": "array", "items": { "type": "string" } }, "max_reference_images": { "type": "integer", "minimum": 0 }, "max_variants": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "enabled", "aspect_ratios", "image_sizes", "max_reference_images", "max_variants" ], "additionalProperties": false }, "default": [] } }, "required": [ "equivalent", "stages", "project_access", "gaps" ], "additionalProperties": false }, "template_id": { "type": "string", "minLength": 1, "maxLength": 100 }, "template_version": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "stages": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "output_profiles": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "unsupported_reasons": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 500 } }, "max_shots": { "type": "integer", "minimum": 1 }, "max_episode_seconds": { "type": "integer", "minimum": 1 }, "upload_mime_types": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "max_upload_bytes": { "type": "integer", "minimum": 1 }, "upload_limits": { "type": "object", "additionalProperties": { "type": "integer", "exclusiveMinimum": 0 } }, "job_types": { "type": "array", "items": { "type": "string", "enum": [ "analyze_script", "generate_image", "generate_video", "assemble_video" ] } }, "operations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "type", "enabled" ], "additionalProperties": false } }, "image_size": { "type": "string" }, "max_reference_images": { "type": "integer" } }, "required": [ "studio_workflow", "template_id", "template_version", "enabled", "stages", "output_profiles", "unsupported_reasons", "max_shots", "max_episode_seconds", "upload_mime_types", "max_upload_bytes" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "PublicProjectPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "revision": { "type": "integer", "minimum": 1 }, "state": { "type": "string", "enum": [ "active", "archived" ] }, "created_at": { "type": "string", "format": "date-time" }, "client_reference": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] } }, "required": [ "id", "name", "revision", "state", "created_at", "client_reference" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "PublicProject": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "revision": { "type": "integer", "minimum": 1 }, "state": { "type": "string", "enum": [ "active", "archived" ] }, "created_at": { "type": "string", "format": "date-time" }, "client_reference": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] } }, "required": [ "id", "name", "revision", "state", "created_at", "client_reference" ], "additionalProperties": false }, "PublicResourcePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "work_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "minimum": 1 }, "content": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "script" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 900000 }, "source_asset_id": { "type": "string", "format": "uuid" }, "language": { "type": "string", "minLength": 2, "maxLength": 16 } }, "required": [ "language" ], "additionalProperties": false, "description": "Provide exactly one of text or source_asset_id." } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "character" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "scene" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "prop" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "episode" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "script_resource_id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer", "minimum": 1, "maximum": 100 }, "raw_content": { "type": "string", "maxLength": 20000 }, "description": { "type": "string", "maxLength": 4000 } }, "required": [ "script_resource_id", "sequence" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "shot" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "episode_id": { "type": "string", "format": "uuid" }, "scene_id": { "type": "string", "format": "uuid" }, "character_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] }, "prop_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] }, "description": { "type": "string", "maxLength": 4000 }, "video_prompt": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ] }, "sequence": { "type": "integer", "minimum": 1, "maximum": 100 }, "duration_seconds": { "type": "integer", "minimum": 1, "maximum": 60 }, "selected_image_asset_id": { "type": "string", "format": "uuid" }, "selected_video_asset_id": { "type": "string", "format": "uuid" } }, "required": [ "episode_id", "description", "duration_seconds" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "work_id", "revision", "content", "created_at" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "PublicResource": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "work_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "minimum": 1 }, "content": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "script" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 900000 }, "source_asset_id": { "type": "string", "format": "uuid" }, "language": { "type": "string", "minLength": 2, "maxLength": 16 } }, "required": [ "language" ], "additionalProperties": false, "description": "Provide exactly one of text or source_asset_id." } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "character" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "scene" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "prop" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "reference_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] } }, "required": [ "description" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "episode" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "script_resource_id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer", "minimum": 1, "maximum": 100 }, "raw_content": { "type": "string", "maxLength": 20000 }, "description": { "type": "string", "maxLength": 4000 } }, "required": [ "script_resource_id", "sequence" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "shot" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "data": { "type": "object", "properties": { "episode_id": { "type": "string", "format": "uuid" }, "scene_id": { "type": "string", "format": "uuid" }, "character_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] }, "prop_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 8, "default": [] }, "description": { "type": "string", "maxLength": 4000 }, "video_prompt": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ] }, "sequence": { "type": "integer", "minimum": 1, "maximum": 100 }, "duration_seconds": { "type": "integer", "minimum": 1, "maximum": 60 }, "selected_image_asset_id": { "type": "string", "format": "uuid" }, "selected_video_asset_id": { "type": "string", "format": "uuid" } }, "required": [ "episode_id", "description", "duration_seconds" ], "additionalProperties": false } }, "required": [ "kind", "name", "data" ], "additionalProperties": false } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "work_id", "revision", "content", "created_at" ], "additionalProperties": false }, "PublicUploadTicket": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" }, "upload_url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "PUT" ] }, "content_type": { "type": "string", "minLength": 1, "maxLength": 100 }, "expires_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "asset_id", "upload_url", "method", "content_type", "expires_at" ], "additionalProperties": false }, "PublicAsset": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "work_id": { "type": "string", "format": "uuid" }, "state": { "type": "string", "enum": [ "pending", "verified", "ready", "errored", "expired" ] }, "mime_type": { "type": "string", "minLength": 1, "maxLength": 100 }, "size_bytes": { "type": "integer", "minimum": 0 }, "download_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } }, "required": [ "id", "work_id", "state", "mime_type", "size_bytes", "download_url", "expires_at" ], "additionalProperties": false }, "PublicPlan": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "work_id": { "type": "string", "format": "uuid" }, "project_revision": { "type": "integer", "minimum": 1 }, "template_id": { "type": "string", "minLength": 1, "maxLength": 100 }, "template_version": { "type": "integer", "minimum": 1 }, "executable": { "type": "boolean" }, "expires_at": { "type": "string", "format": "date-time" }, "budget_ceiling": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "steps": { "type": "array", "items": { "type": "object", "properties": { "stage_key": { "type": "string", "minLength": 1, "maxLength": 100 }, "target_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "depends_on": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "requires_review": { "type": "boolean" }, "max_cost": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "stage_key", "target_ids", "depends_on", "requires_review", "max_cost" ], "additionalProperties": false } }, "unsupported_reasons": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 500 } } }, "required": [ "id", "work_id", "project_revision", "template_id", "template_version", "executable", "expires_at", "budget_ceiling", "steps", "unsupported_reasons" ], "additionalProperties": false }, "PublicRun": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "work_id": { "type": "string", "format": "uuid" }, "plan_id": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1 }, "state": { "type": "string", "enum": [ "queued", "running", "awaiting_review", "stopping", "paused", "needs_attention", "partially_succeeded", "succeeded", "failed", "cancelled" ] }, "client_reference": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "budget_remaining": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, "committed_cost": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "unresolved_cost": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "output_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id", "work_id", "plan_id", "version", "state", "client_reference", "created_at", "completed_at", "budget_remaining", "committed_cost", "unresolved_cost", "output_asset_ids" ], "additionalProperties": false }, "PublicRunPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "work_id": { "type": "string", "format": "uuid" }, "plan_id": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1 }, "state": { "type": "string", "enum": [ "queued", "running", "awaiting_review", "stopping", "paused", "needs_attention", "partially_succeeded", "succeeded", "failed", "cancelled" ] }, "client_reference": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "budget_remaining": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, "committed_cost": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "unresolved_cost": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "output_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id", "work_id", "plan_id", "version", "state", "client_reference", "created_at", "completed_at", "budget_remaining", "committed_cost", "unresolved_cost", "output_asset_ids" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "PublicStepPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "run_id": { "type": "string", "format": "uuid" }, "stage_key": { "type": "string", "minLength": 1, "maxLength": 100 }, "target_id": { "type": "string", "format": "uuid" }, "job_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "blocked", "ready", "queued", "running", "awaiting_review", "succeeded", "failed", "cancelled", "unknown" ] }, "output_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "error_code": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "ordinal": { "type": "integer" } }, "required": [ "id", "run_id", "stage_key", "target_id", "job_id", "state", "output_asset_ids", "error_code", "ordinal" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "PublicRunEventPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid" }, "run_id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer", "minimum": 1 }, "type": { "type": "string", "enum": [ "run.state_changed", "run.review_required", "run.result_ready", "run.needs_attention" ] }, "state": { "type": "string", "enum": [ "queued", "running", "awaiting_review", "stopping", "paused", "needs_attention", "partially_succeeded", "succeeded", "failed", "cancelled" ] }, "step_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "event_id", "run_id", "sequence", "type", "state", "step_id", "created_at" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "PublicJob": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "work_id": { "type": "string", "format": "uuid" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "queued", "ready", "blocked", "processing", "awaiting_review", "succeeded", "failed", "cancelled", "needs_review" ] }, "output_asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "error_code": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "resource_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "skipped_scene_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id", "work_id", "run_id", "state", "output_asset_ids", "error_code" ], "additionalProperties": false }, "PublicRequestLogPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "method": { "type": "string", "enum": [ "GET", "POST", "PATCH", "PUT" ] }, "route_template": { "type": "string", "minLength": 1, "maxLength": 300 }, "status_code": { "type": "integer", "minimum": 100, "maximum": 599 }, "duration_ms": { "type": "integer", "minimum": 0 }, "actor_kind": { "type": "string", "enum": [ "api_key", "console" ] }, "work_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "replayed": { "type": "boolean" }, "error_code": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] } }, "required": [ "request_id", "created_at", "method", "route_template", "status_code", "duration_ms", "actor_kind", "work_id", "run_id", "job_id", "replayed", "error_code" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "PublicRequestLog": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "method": { "type": "string", "enum": [ "GET", "POST", "PATCH", "PUT" ] }, "route_template": { "type": "string", "minLength": 1, "maxLength": 300 }, "status_code": { "type": "integer", "minimum": 100, "maximum": 599 }, "duration_ms": { "type": "integer", "minimum": 0 }, "actor_kind": { "type": "string", "enum": [ "api_key", "console" ] }, "work_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "replayed": { "type": "boolean" }, "error_code": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] } }, "required": [ "request_id", "created_at", "method", "route_template", "status_code", "duration_ms", "actor_kind", "work_id", "run_id", "job_id", "replayed", "error_code" ], "additionalProperties": false }, "PublicUsage": { "type": "object", "properties": { "period_start": { "type": "string", "format": "date-time" }, "period_end": { "type": "string", "format": "date-time" }, "as_of": { "type": "string", "format": "date-time" }, "http_requests": { "type": "integer", "minimum": 0 }, "runs": { "type": "integer", "minimum": 0 }, "jobs": { "type": "integer", "minimum": 0 }, "reserved": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, "committed": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, "unresolved": { "anyOf": [ { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, { "type": "null" } ] }, "remaining": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "micro_units": { "type": "string", "pattern": "^[0-9]+$" } }, "required": [ "currency", "micro_units" ], "additionalProperties": false }, "amount_basis": { "type": "string", "enum": [ "partner_limit" ] }, "billing_mode": { "type": "string", "enum": [ "pilot", "contract" ] } }, "required": [ "period_start", "period_end", "as_of", "http_requests", "runs", "jobs", "reserved", "committed", "unresolved", "remaining", "amount_basis", "billing_mode" ], "additionalProperties": false }, "PublicWebhookEndpointPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "work_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "events": { "type": "array", "items": { "type": "string", "enum": [ "run.state_changed", "run.review_required", "run.result_ready", "run.needs_attention" ] } }, "enabled": { "type": "boolean" }, "verified": { "type": "boolean" }, "secret_version": { "type": "integer", "minimum": 1 }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "work_ids", "events", "enabled", "verified", "secret_version", "created_at" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "PublicWebhookIssued": { "type": "object", "properties": { "endpoint": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "work_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "events": { "type": "array", "items": { "type": "string", "enum": [ "run.state_changed", "run.review_required", "run.result_ready", "run.needs_attention" ] } }, "enabled": { "type": "boolean" }, "verified": { "type": "boolean" }, "secret_version": { "type": "integer", "minimum": 1 }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "work_ids", "events", "enabled", "verified", "secret_version", "created_at" ], "additionalProperties": false }, "signing_secret": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "endpoint" ], "additionalProperties": false }, "PublicWebhookEndpoint": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "work_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "events": { "type": "array", "items": { "type": "string", "enum": [ "run.state_changed", "run.review_required", "run.result_ready", "run.needs_attention" ] } }, "enabled": { "type": "boolean" }, "verified": { "type": "boolean" }, "secret_version": { "type": "integer", "minimum": 1 }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "work_ids", "events", "enabled", "verified", "secret_version", "created_at" ], "additionalProperties": false }, "PublicWebhookDeliveryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "endpoint_id": { "type": "string", "format": "uuid" }, "event_id": { "type": "string", "format": "uuid" }, "state": { "type": "string", "enum": [ "pending", "sending", "succeeded", "retrying", "exhausted" ] }, "attempt": { "type": "integer", "minimum": 0 }, "http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "next_attempt_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "endpoint_id", "event_id", "state", "attempt", "http_status", "next_attempt_at", "created_at" ], "additionalProperties": false } }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "PublicWebhookDelivery": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "endpoint_id": { "type": "string", "format": "uuid" }, "event_id": { "type": "string", "format": "uuid" }, "state": { "type": "string", "enum": [ "pending", "sending", "succeeded", "retrying", "exhausted" ] }, "attempt": { "type": "integer", "minimum": 0 }, "http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "next_attempt_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "endpoint_id", "event_id", "state", "attempt", "http_status", "next_attempt_at", "created_at" ], "additionalProperties": false }, "PublicUploaded": { "type": "object", "properties": { "uploaded": { "type": "boolean", "const": true } }, "required": [ "uploaded" ], "additionalProperties": false }, "PublicStudioWorkflow": { "type": "object", "properties": { "api_runs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "state": { "type": "string" }, "created_at": { "type": "string" }, "completed_at": { "type": [ "string", "null" ] }, "total_steps": { "type": "integer", "minimum": 0 }, "completed_steps": { "type": "integer", "minimum": 0 }, "error_code": { "type": [ "string", "null" ] } }, "required": [ "id", "state", "created_at", "completed_at", "total_steps", "completed_steps", "error_code" ], "additionalProperties": false } }, "work_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "studio_url": { "type": "string" }, "trash": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "entity_type": { "type": "string", "enum": [ "asset", "design" ] }, "name": { "type": "string" }, "deleted_at": { "type": "string" } }, "required": [ "id", "entity_type", "name", "deleted_at" ], "additionalProperties": false } }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "kind": { "type": "string" }, "media_type": { "type": "string" }, "status": { "type": "string" }, "mime": { "type": [ "string", "null" ] }, "lineage_id": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "is_current_version": { "type": "boolean" } }, "required": [ "id", "name", "kind", "media_type", "status", "mime", "lineage_id", "version", "is_current_version" ], "additionalProperties": false } }, "settings": { "type": "object", "properties": { "title": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "cover": { "type": "string" }, "aspect": { "type": "string" }, "resolution": { "type": "string" }, "style": { "type": "string" }, "style_prompt": { "type": "string" }, "state": { "type": "string" } }, "required": [ "title", "tags", "cover", "aspect", "resolution", "style", "style_prompt", "state" ], "additionalProperties": false }, "script": { "type": "object", "properties": { "text": { "type": "string" }, "logline": { "type": "string" }, "synopsis": { "type": "string" } }, "required": [ "text", "logline", "synopsis" ], "additionalProperties": false }, "episodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "title": { "type": "string" }, "raw_content": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "id", "number", "title", "raw_content", "description" ], "additionalProperties": false } }, "designs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "character", "scene", "prop", "grid" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "primary_asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "id", "kind", "name", "description", "tags", "primary_asset_id" ], "additionalProperties": false } }, "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "episode_id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "heading": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "video_prompt": { "type": [ "string", "null" ] } }, "required": [ "id", "episode_id", "number", "heading", "description", "video_prompt" ], "additionalProperties": false } }, "scene_designs": { "type": "array", "items": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "design_id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" }, "position": { "type": "integer" } }, "required": [ "scene_id", "design_id", "kind", "position" ], "additionalProperties": false } }, "takes": { "type": "array", "items": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" }, "position": { "type": "integer" } }, "required": [ "scene_id", "asset_id", "position" ], "additionalProperties": false } }, "cut_selections": { "type": "array", "items": { "type": "object", "properties": { "scene_id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" } }, "required": [ "scene_id", "asset_id" ], "additionalProperties": false } }, "design_assets": { "type": "array", "items": { "type": "object", "properties": { "design_id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "position": { "type": "integer" } }, "required": [ "design_id", "asset_id", "kind", "name", "position" ], "additionalProperties": false } } }, "required": [ "api_runs", "work_id", "revision", "studio_url", "trash", "assets", "settings", "script", "episodes", "designs", "scenes", "scene_designs", "takes", "cut_selections", "design_assets" ], "additionalProperties": false }, "PublicStudioMutation": { "type": "object", "properties": { "work_id": { "type": "string", "format": "uuid" }, "changed_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "studio_url": { "type": "string" } }, "required": [ "work_id", "changed_id", "revision", "studio_url" ], "additionalProperties": false }, "PublicStudioLibrary": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "kind": { "type": "string" }, "media_type": { "type": "string" }, "mime": { "type": [ "string", "null" ] }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "is_current_version": { "type": "boolean" } }, "required": [ "id", "name", "kind", "media_type", "mime", "version", "is_current_version" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "PublicStudioBuildProgress": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "run_id": { "type": "string", "format": "uuid" }, "run_version": { "type": "integer" }, "state": { "type": "string" }, "wait_reason": { "type": [ "string", "null" ] }, "stage": { "type": [ "string", "null" ] }, "messages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "role": { "type": "string", "enum": [ "assistant", "system_note" ] }, "stage": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "status": { "type": "string", "enum": [ "streaming", "final" ] }, "seq": { "type": "number" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "role", "stage", "content", "status", "seq", "created_at", "updated_at" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "filterMode": { "type": "string", "enum": [ "prompt_index", "full_text" ] }, "sourceText": { "type": "string" }, "llmText": { "type": "string" }, "originalChars": { "type": "number" }, "preparedChars": { "type": "number" } }, "required": [ "id", "name", "filterMode", "sourceText", "llmText", "originalChars", "preparedChars" ], "additionalProperties": false } } }, "required": [ "id", "state", "stage", "messages", "sources" ], "additionalProperties": false }, "PublicReferencePage": { "type": "object", "properties": { "work_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "character", "scene", "prop", "grid" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "primary_asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "id", "kind", "name", "description", "tags", "primary_asset_id" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "work_id", "revision", "items", "next_cursor" ], "additionalProperties": false }, "PublicReference": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "character", "scene", "prop", "grid" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "primary_asset_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "id", "kind", "name", "description", "tags", "primary_asset_id" ], "additionalProperties": false }, "PublicEpisodePage": { "type": "object", "properties": { "work_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "title": { "type": "string" }, "raw_content": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "id", "number", "title", "raw_content", "description" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "work_id", "revision", "items", "next_cursor" ], "additionalProperties": false }, "PublicEpisode": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "title": { "type": "string" }, "raw_content": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "id", "number", "title", "raw_content", "description" ], "additionalProperties": false }, "PublicScenePage": { "type": "object", "properties": { "work_id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "episode_id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "heading": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "video_prompt": { "type": [ "string", "null" ] } }, "required": [ "id", "episode_id", "number", "heading", "description", "video_prompt" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "work_id", "revision", "items", "next_cursor" ], "additionalProperties": false }, "PublicScene": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "episode_id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "exclusiveMinimum": 0 }, "heading": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "video_prompt": { "type": [ "string", "null" ] } }, "required": [ "id", "episode_id", "number", "heading", "description", "video_prompt" ], "additionalProperties": false }, "PublicArchiveImport": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "work_id": { "type": "string", "format": "uuid" }, "state": { "type": "string", "enum": [ "queued", "running", "deferred", "succeeded", "failed", "cancelled" ] }, "progress": { "anyOf": [ { "type": "object", "properties": { "phase": { "type": "string", "enum": [ "extracting", "importing" ] }, "current": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "phase", "current", "total" ], "additionalProperties": false }, { "type": "null" } ] }, "imported": { "type": "integer", "minimum": 0 }, "failed": { "type": "integer", "minimum": 0 }, "asset_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "error_code": { "type": [ "string", "null" ] } }, "required": [ "id", "work_id", "state", "progress", "imported", "failed", "asset_ids", "error_code" ], "additionalProperties": false }, "PublicUploadBatch": { "type": "object", "properties": { "work_id": { "type": "string", "format": "uuid" }, "items": { "type": "array", "items": { "type": "object", "properties": { "filename": { "type": "string" }, "ticket": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "asset_id": { "type": "string", "format": "uuid" }, "upload_url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "PUT" ] }, "content_type": { "type": "string", "minLength": 1, "maxLength": 100 }, "expires_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "asset_id", "upload_url", "method", "content_type", "expires_at" ], "additionalProperties": false } }, "required": [ "filename", "ticket" ], "additionalProperties": false } } }, "required": [ "work_id", "items" ], "additionalProperties": false } } }, "x-documentation-language": "en", "tags": [ { "name": "Capabilities", "description": "Capabilities", "x-tag-id": "capabilities" }, { "name": "Projects & resources", "description": "Projects & resources", "x-tag-id": "projects" }, { "name": "Uploads", "description": "Uploads", "x-tag-id": "uploads" }, { "name": "Assets & results", "description": "Assets & results", "x-tag-id": "assets" }, { "name": "Production runs", "description": "Production runs", "x-tag-id": "runs" }, { "name": "Workflow functions", "description": "Workflow functions", "x-tag-id": "jobs" }, { "name": "Request logs", "description": "Request logs", "x-tag-id": "requests" }, { "name": "Usage", "description": "Usage", "x-tag-id": "usage" }, { "name": "Webhooks", "description": "Webhooks", "x-tag-id": "webhook-endpoints" }, { "name": "Webhook deliveries", "description": "Webhook deliveries", "x-tag-id": "webhook-deliveries" }, { "name": "Specification", "description": "Specification", "x-tag-id": "Documentation" } ] }