FECINE OPEN API v1.1.0

Riferimento API

Dalla sceneggiatura al montaggio finale, collega la produzione con FECINE.

Autenticazione

Usa la chiave FECINE come token Bearer. Non serve un account per leggere la documentazione.

Crea ed esegui

Crea un’opera, carica copioni e materiali, poi aggiungi personaggi, ambienti, oggetti e griglie. Crea episodi e scene, collega i riferimenti e genera i video. Scegli una ripresa per ogni scena ed esporta il montaggio finale. Attendi la fine di ogni generazione e invia la revision più recente per le modifiche. Avvia separatamente la costruzione per strutturare i copioni caricati.

Ottieni i risultati

Controlla lo stato o ricevi un Webhook. Usa gli ID delle risorse per ottenere link di download firmati.

Prima richiesta

curl -X GET 'https://YOUR_FECINE_HOST/api/v1/capabilities' \
  -H 'Authorization: Bearer YOUR_FECINE_API_KEY'

GET /api/v1/capabilities

REFERENCE

Riferimento API

FECINE API Key

Errore FECINE. Fornisci request_id al supporto.

Copia il JSON e sostituisci ID, URL e contenuti con i tuoi valori.

Funzionalità

GET/api/v1/capabilitiesVedi cosa puoi fare adesso

Restituisce funzioni, modelli, formati di caricamento e limiti di produzione disponibili nell’ambiente API corrente.

Permesso richiesto: projects:read

Parametri

Nessun parametro

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "items": [
      {
        "studio_workflow": {
          "equivalent": false,
          "stages": [
            "script"
          ],
          "project_access": "read_only",
          "gaps": [
            "example"
          ]
        },
        "template_id": "example",
        "template_version": 1,
        "enabled": false,
        "stages": [
          "example"
        ],
        "output_profiles": [
          "example"
        ],
        "unsupported_reasons": [
          "example"
        ],
        "max_shots": 1,
        "max_episode_seconds": 1,
        "upload_mime_types": [
          "example"
        ],
        "max_upload_bytes": 1
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

Risposta server

Progetti e risorse

GET/api/v1/worksVedi l’elenco dei tuoi progetti

Elenca i progetti accessibili. Filtra per state e usa cursor e limit per la paginazione.

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100
`state`query	string	—	Allowed values: active, archived

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "example",
        "revision": 1,
        "state": "active",
        "created_at": "2026-09-20T00:00:00Z",
        "client_reference": "example"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

cursor query limit query state query

Risposta server

POST/api/v1/worksCrea un nuovo progetto

Crea un progetto con il name indicato. Usa l’ID restituito per aggiungere materiali e avviare la produzione.

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`name`	string	*	Minimum length: 1 characters Maximum length: 80 characters
`client_reference`	string	—	Maximum length: 128 characters

Prima richiesta · JSON

{
  "name": "example"
}

Risposte

HTTP 201 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "example",
    "revision": 1,
    "state": "active",
    "created_at": "2026-09-20T00:00:00Z",
    "client_reference": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{project_id}Vedi i dati di un progetto

Restituisce nome, stato e revision del progetto da consultare prima di modifiche o richieste di produzione.

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "example",
    "revision": 1,
    "state": "active",
    "created_at": "2026-09-20T00:00:00Z",
    "client_reference": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

project_id path *

Risposta server

PATCH/api/v1/works/{project_id}Modifica i dati di un progetto

Modifica il nome o lo stato active/archived del progetto. Invia l’ultimo ETag in If-Match.

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`If-Match`header	string	*	Usa il più recente ETag, comprese le virgolette.

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`state`	string	—	Allowed values: active, archived

Prima richiesta · JSON

{}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "example",
    "revision": 1,
    "state": "active",
    "created_at": "2026-09-20T00:00:00Z",
    "client_reference": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

project_id path *If-Match header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{project_id}/resourcesVedi i materiali caricati

Elenca sceneggiature, personaggi, scene, oggetti, episodi e inquadrature del progetto. Scegli il tipo con kind.

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100
`kind`query	string	—	Allowed values: script, character, scene, prop, episode, shot

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "work_id": "11111111-1111-4111-8111-111111111111",
        "revision": 1,
        "content": {
          "kind": "script",
          "name": "example",
          "data": {
            "language": "example"
          }
        },
        "created_at": "2026-09-20T00:00:00Z"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

project_id path *cursor query limit query kind query

Risposta server

POST/api/v1/works/{project_id}/resourcesAggiungi materiali come copioni e immagini

Aggiunge una risorsa strutturata con kind e data, come testo del copione o inquadrature. Carica i file tramite /uploads.

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`kind`	string	*	kind = script Fixed value: script
`name`	string	*	kind = script Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = scriptFornisci solo text oppure source_asset_id.
`data.text`	string	—	kind = script Minimum length: 1 characters Maximum length: 900000 characters
`data.source_asset_id`	string	—	kind = script Format: UUID
`data.language`	string	*	kind = script Minimum length: 2 characters Maximum length: 16 characters
`kind`	string	*	kind = character Fixed value: character
`name`	string	*	kind = character Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = character
`data.description`	string	*	kind = character Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = character Default: [] Maximum items: 8 items
`kind`	string	*	kind = scene Fixed value: scene
`name`	string	*	kind = scene Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = scene
`data.description`	string	*	kind = scene Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = scene Default: [] Maximum items: 8 items
`kind`	string	*	kind = prop Fixed value: prop
`name`	string	*	kind = prop Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = prop
`data.description`	string	*	kind = prop Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = prop Default: [] Maximum items: 8 items
`kind`	string	*	kind = episode Fixed value: episode
`name`	string	*	kind = episode Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = episode
`data.script_resource_id`	string	*	kind = episode Format: UUID
`data.sequence`	integer	*	kind = episode Minimum: 1 Maximum: 100
`data.raw_content`	string	—	kind = episode Maximum length: 20000 characters
`data.description`	string	—	kind = episode Maximum length: 4000 characters
`kind`	string	*	kind = shot Fixed value: shot
`name`	string	*	kind = shot Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = shot
`data.episode_id`	string	*	kind = shot Format: UUID
`data.scene_id`	string	—	kind = shot Format: UUID
`data.character_ids`	array	—	kind = shot Default: [] Maximum items: 8 items
`data.prop_ids`	array	—	kind = shot Default: [] Maximum items: 8 items
`data.description`	string	*	kind = shot Maximum length: 4000 characters
`data.video_prompt`	oneOf	—	kind = shot
`data.sequence`	integer	—	kind = shot Minimum: 1 Maximum: 100
`data.duration_seconds`	integer	*	kind = shot Minimum: 1 Maximum: 60
`data.selected_image_asset_id`	string	—	kind = shot Format: UUID
`data.selected_video_asset_id`	string	—	kind = shot Format: UUID

Prima richiesta · JSON

{
  "kind": "script",
  "name": "example",
  "data": {
    "language": "example"
  }
}

Risposte

HTTP 201 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "content": {
      "kind": "script",
      "name": "example",
      "data": {
        "language": "example"
      }
    },
    "created_at": "2026-09-20T00:00:00Z"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

project_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{project_id}/resources/{resource_id}Vedi un singolo materiale

Restituisce tipo, contenuto e revision della risorsa indicata da resource_id nel progetto.

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`resource_id`path	string	*	Format: UUID

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "content": {
      "kind": "script",
      "name": "example",
      "data": {
        "language": "example"
      }
    },
    "created_at": "2026-09-20T00:00:00Z"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

project_id path *resource_id path *

Risposta server

PATCH/api/v1/works/{project_id}/resources/{resource_id}Modifica un materiale

Aggiorna kind e data. Invia l’ultimo ETag in If-Match per evitare conflitti di modifica.

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`resource_id`path	string	*	Format: UUID
`If-Match`header	string	*	Usa il più recente ETag, comprese le virgolette.

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`kind`	string	*	kind = script Fixed value: script
`name`	string	*	kind = script Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = scriptFornisci solo text oppure source_asset_id.
`data.text`	string	—	kind = script Minimum length: 1 characters Maximum length: 900000 characters
`data.source_asset_id`	string	—	kind = script Format: UUID
`data.language`	string	*	kind = script Minimum length: 2 characters Maximum length: 16 characters
`kind`	string	*	kind = character Fixed value: character
`name`	string	*	kind = character Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = character
`data.description`	string	*	kind = character Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = character Default: [] Maximum items: 8 items
`kind`	string	*	kind = scene Fixed value: scene
`name`	string	*	kind = scene Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = scene
`data.description`	string	*	kind = scene Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = scene Default: [] Maximum items: 8 items
`kind`	string	*	kind = prop Fixed value: prop
`name`	string	*	kind = prop Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = prop
`data.description`	string	*	kind = prop Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = prop Default: [] Maximum items: 8 items
`kind`	string	*	kind = episode Fixed value: episode
`name`	string	*	kind = episode Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = episode
`data.script_resource_id`	string	*	kind = episode Format: UUID
`data.sequence`	integer	*	kind = episode Minimum: 1 Maximum: 100
`data.raw_content`	string	—	kind = episode Maximum length: 20000 characters
`data.description`	string	—	kind = episode Maximum length: 4000 characters
`kind`	string	*	kind = shot Fixed value: shot
`name`	string	*	kind = shot Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = shot
`data.episode_id`	string	*	kind = shot Format: UUID
`data.scene_id`	string	—	kind = shot Format: UUID
`data.character_ids`	array	—	kind = shot Default: [] Maximum items: 8 items
`data.prop_ids`	array	—	kind = shot Default: [] Maximum items: 8 items
`data.description`	string	*	kind = shot Maximum length: 4000 characters
`data.video_prompt`	oneOf	—	kind = shot
`data.sequence`	integer	—	kind = shot Minimum: 1 Maximum: 100
`data.duration_seconds`	integer	*	kind = shot Minimum: 1 Maximum: 60
`data.selected_image_asset_id`	string	—	kind = shot Format: UUID
`data.selected_video_asset_id`	string	—	kind = shot Format: UUID

Prima richiesta · JSON

{
  "kind": "script",
  "name": "example",
  "data": {
    "language": "example"
  }
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "content": {
      "kind": "script",
      "name": "example",
      "data": {
        "language": "example"
      }
    },
    "created_at": "2026-09-20T00:00:00Z"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

project_id path *resource_id path *If-Match header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{project_id}/workflowConsulta la produzione Studio

Restituisce insieme copione, episodi, design, scene, asset, take, selezioni di montaggio e revision aggiornata.

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "api_runs": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "state": "example",
        "created_at": "example",
        "completed_at": "example",
        "total_steps": 0,
        "completed_steps": 0,
        "error_code": "example"
      }
    ],
    "work_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example",
    "trash": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "entity_type": "asset",
        "name": "example",
        "deleted_at": "example"
      }
    ],
    "assets": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "example",
        "kind": "example",
        "media_type": "example",
        "status": "example",
        "mime": "example",
        "lineage_id": "11111111-1111-4111-8111-111111111111",
        "version": 1,
        "is_current_version": false
      }
    ],
    "settings": {
      "title": "example",
      "tags": [
        "example"
      ],
      "cover": "example",
      "aspect": "example",
      "resolution": "example",
      "style": "example",
      "style_prompt": "example",
      "state": "example"
    },
    "script": {
      "text": "example",
      "logline": "example",
      "synopsis": "example"
    },
    "episodes": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "number": 1,
        "title": "example",
        "raw_content": "example",
        "description": "example"
      }
    ],
    "designs": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "kind": "character",
        "name": "example",
        "description": "example",
        "tags": [
          "example"
        ],
        "primary_asset_id": "11111111-1111-4111-8111-111111111111"
      }
    ],
    "scenes": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "episode_id": "11111111-1111-4111-8111-111111111111",
        "number": 1,
        "heading": "example",
        "description": "example",
        "video_prompt": "example"
      }
    ],
    "scene_designs": [
      {
        "scene_id": "11111111-1111-4111-8111-111111111111",
        "design_id": "11111111-1111-4111-8111-111111111111",
        "kind": "example",
        "position": 1
      }
    ],
    "takes": [
      {
        "scene_id": "11111111-1111-4111-8111-111111111111",
        "asset_id": "11111111-1111-4111-8111-111111111111",
        "position": 1
      }
    ],
    "cut_selections": [
      {
        "scene_id": "11111111-1111-4111-8111-111111111111",
        "asset_id": "11111111-1111-4111-8111-111111111111"
      }
    ],
    "design_assets": [
      {
        "design_id": "11111111-1111-4111-8111-111111111111",
        "asset_id": "11111111-1111-4111-8111-111111111111",
        "kind": "example",
        "name": "example",
        "position": 1
      }
    ]
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

project_id path *

Risposta server

POST/api/v1/works/{project_id}/script/analysesAnalizza la sceneggiatura Studio

Analizza il copione per estrarre la struttura di produzione. Invia script_text per aggiornarlo oppure omettilo per usare quello salvato. Segui il job con getJob.

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`model`	string	—	Minimum length: 1 characters Maximum length: 200 characters
`script_text`	string	—	Minimum length: 1 characters Maximum length: 5000000 characters

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

project_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{project_id}/script/buildsCrea la produzione dalla sceneggiatura

Invia script_asset_ids verificati e revision per costruire copione, riferimenti e storyboard. full_rebuild sostituisce la struttura. Genera immagini e video separatamente. I token di ingresso e uscita riportati sono addebitati alle stesse tariffe di Studio. Non serve un budget di crediti per richiesta. GET /jobs/{job_id} → output_asset_ids.

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`model`	string	—	Minimum length: 1 characters Maximum length: 200 characters
`script_asset_ids`	array	—	Default: []
`material_scope`	string	—	Allowed values: unclassified, all Default: "unclassified"
`preprocess`	object	—
`preprocess.ignoreAttachments`	boolean	—	Default: true
`preprocess.discardKeywords`	array	—	Default: ["提示词","prompt","Midjourney","Stable Diffusion","DALL-E","Image1","Image2","正向提示词","负向提示词","视觉描述","出图要求","技术规格","画面描述","镜头提示词","请生成","角色三视图","服装本体展示","局部材质与细节放大"] Maximum items: 100 items
`preprocess.keepLabels`	array	—	Default: ["资产名称","资产ID","资产版本","关联角色资产名称","关联角色资产ID","关联场景资产名称","关联场景资产ID","关联道具资产名称","关联道具资产ID","服装变体ID","服装名称","道具资产ID","道具名称","场景资产ID","场景名称","宫格图ID","集数","主题","场景","角色名称","用途"] Maximum items: 100 items
`rebuild_policy`	string	*	Fixed value: full_rebuild

Prima richiesta · JSON

{
  "revision": 1,
  "rebuild_policy": "full_rebuild"
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

project_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{project_id}/libraryConsulta la libreria condivisa

Elenca gli asset importabili. scope=personal consulta la libreria personale; scope=studio, predefinito, quella condivisa.

Permesso richiesto: assets:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`limit`	integer	—	Minimum: 1 Maximum: 100
`cursor`	string	—
`scope`	string	—	Allowed values: studio, personal

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "example",
        "kind": "example",
        "media_type": "example",
        "mime": "example",
        "version": 1,
        "is_current_version": false
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

project_id path *limit cursor scope

Risposta server

POST/api/v1/works/{project_id}/importsImporta una risorsa nel progetto

Copia l’asset indicato da asset_id dalla libreria personale o condivisa nel progetto. Le modifiche successive all’originale non alterano la copia.

Permesso richiesto: assets:write, assets:read, projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`asset_id`	string	*	Format: UUID

Prima richiesta · JSON

{
  "revision": 1,
  "asset_id": "11111111-1111-4111-8111-111111111111"
}

Risposte

HTTP 201 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "state": "pending",
    "mime_type": "example",
    "size_bytes": 0,
    "download_url": "example",
    "expires_at": "2026-09-20T00:00:00Z"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

project_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{project_id}/script/draftsGenera una bozza di sceneggiatura

Invia instructions, source_text facoltativo, revision e max_output_tokens. Salva un nuovo copione senza sostituire quello esistente. I token di ingresso e uscita riportati sono addebitati alle stesse tariffe di Studio. Non serve un budget di crediti per richiesta. GET /jobs/{job_id} → output_asset_ids.

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`model`	string	—	Minimum length: 1 characters Maximum length: 200 characters
`instructions`	string	*	Minimum length: 1 characters Maximum length: 8000 characters
`source_text`	string	—	Maximum length: 50000 characters
`max_output_tokens`	integer	—	Default: 2048 Minimum: 256 Maximum: 8192

Prima richiesta · JSON

{
  "revision": 1,
  "instructions": "example"
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

project_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/charactersPersonaggio · Leggere (list)

Personaggio · Leggere (list). GET /api/v1/works/{work_id}/characters. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "kind": "character",
        "name": "example",
        "description": "example",
        "tags": [
          "example"
        ],
        "primary_asset_id": "11111111-1111-4111-8111-111111111111"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *cursor query limit query

Risposta server

POST/api/v1/works/{work_id}/charactersPersonaggio · Crea

Personaggio · Crea. POST /api/v1/works/{work_id}/characters. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Prima richiesta · JSON

{
  "name": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/characters/{reference_id}Personaggio · Leggere

Personaggio · Leggere. GET /api/v1/works/{work_id}/characters/{reference_id}. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "kind": "character",
    "name": "example",
    "description": "example",
    "tags": [
      "example"
    ],
    "primary_asset_id": "11111111-1111-4111-8111-111111111111"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *cursor query limit query

Risposta server

PATCH/api/v1/works/{work_id}/characters/{reference_id}Personaggio · Modifica

Personaggio · Modifica. PATCH /api/v1/works/{work_id}/characters/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Prima richiesta · JSON

{
  "name": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

DELETE/api/v1/works/{work_id}/characters/{reference_id}Personaggio · Elimina

Personaggio · Elimina. DELETE /api/v1/works/{work_id}/characters/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/works/{work_id}/characters/{reference_id}/primary-imagePersonaggio · Imposta immagine di riferimento

Personaggio · Imposta immagine di riferimento. PUT /api/v1/works/{work_id}/characters/{reference_id}/primary-image. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`asset_id`	string	*	Format: UUID
`current_asset_id`	oneOf	*
`revision`	integer	*

Prima richiesta · JSON

{
  "asset_id": "11111111-1111-4111-8111-111111111111",
  "current_asset_id": "11111111-1111-4111-8111-111111111111",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{work_id}/characters/{reference_id}/image-generationsPersonaggio · Genera immagine di riferimento

Personaggio · Genera immagine di riferimento. POST /api/v1/works/{work_id}/characters/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`variants`	integer	—	Default: 1 Minimum: 1 Maximum: 4
`model`	string	—	Default: "image-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 20000 characters
`aspect_ratio`	string	—
`image_size`	string	—	Maximum length: 40 characters
`quality`	string	—	Allowed values: low, medium, high
`background`	string	—	Allowed values: auto, opaque, transparent
`output_format`	string	—	Allowed values: png, jpeg
`reference_asset_ids`	array	—	Default: [] Maximum items: 16 items
`slot`	string	—	Allowed values: primary, variant Default: "primary"
`variant_name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`current_asset_id`	string	—	Format: UUID

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}Personaggio · Collega alla scena

Personaggio · Collega alla scena. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}Personaggio · Scollega dalla scena

Personaggio · Scollega dalla scena. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/background-scenesScena di sfondo · Leggere (list)

Scena di sfondo · Leggere (list). GET /api/v1/works/{work_id}/background-scenes. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "kind": "character",
        "name": "example",
        "description": "example",
        "tags": [
          "example"
        ],
        "primary_asset_id": "11111111-1111-4111-8111-111111111111"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *cursor query limit query

Risposta server

POST/api/v1/works/{work_id}/background-scenesScena di sfondo · Crea

Scena di sfondo · Crea. POST /api/v1/works/{work_id}/background-scenes. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Prima richiesta · JSON

{
  "name": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/background-scenes/{reference_id}Scena di sfondo · Leggere

Scena di sfondo · Leggere. GET /api/v1/works/{work_id}/background-scenes/{reference_id}. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "kind": "character",
    "name": "example",
    "description": "example",
    "tags": [
      "example"
    ],
    "primary_asset_id": "11111111-1111-4111-8111-111111111111"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *cursor query limit query

Risposta server

PATCH/api/v1/works/{work_id}/background-scenes/{reference_id}Scena di sfondo · Modifica

Scena di sfondo · Modifica. PATCH /api/v1/works/{work_id}/background-scenes/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Prima richiesta · JSON

{
  "name": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

DELETE/api/v1/works/{work_id}/background-scenes/{reference_id}Scena di sfondo · Elimina

Scena di sfondo · Elimina. DELETE /api/v1/works/{work_id}/background-scenes/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/works/{work_id}/background-scenes/{reference_id}/primary-imageScena di sfondo · Imposta immagine di riferimento

Scena di sfondo · Imposta immagine di riferimento. PUT /api/v1/works/{work_id}/background-scenes/{reference_id}/primary-image. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`asset_id`	string	*	Format: UUID
`current_asset_id`	oneOf	*
`revision`	integer	*

Prima richiesta · JSON

{
  "asset_id": "11111111-1111-4111-8111-111111111111",
  "current_asset_id": "11111111-1111-4111-8111-111111111111",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{work_id}/background-scenes/{reference_id}/image-generationsScena di sfondo · Genera immagine di riferimento

Scena di sfondo · Genera immagine di riferimento. POST /api/v1/works/{work_id}/background-scenes/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`variants`	integer	—	Default: 1 Minimum: 1 Maximum: 4
`model`	string	—	Default: "image-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 20000 characters
`aspect_ratio`	string	—
`image_size`	string	—	Maximum length: 40 characters
`quality`	string	—	Allowed values: low, medium, high
`background`	string	—	Allowed values: auto, opaque, transparent
`output_format`	string	—	Allowed values: png, jpeg
`reference_asset_ids`	array	—	Default: [] Maximum items: 16 items
`slot`	string	—	Allowed values: primary, variant Default: "primary"
`variant_name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`current_asset_id`	string	—	Format: UUID

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}Scena di sfondo · Collega alla scena

Scena di sfondo · Collega alla scena. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}Scena di sfondo · Scollega dalla scena

Scena di sfondo · Scollega dalla scena. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/propsOggetto · Leggere (list)

Oggetto · Leggere (list). GET /api/v1/works/{work_id}/props. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "kind": "character",
        "name": "example",
        "description": "example",
        "tags": [
          "example"
        ],
        "primary_asset_id": "11111111-1111-4111-8111-111111111111"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *cursor query limit query

Risposta server

POST/api/v1/works/{work_id}/propsOggetto · Crea

Oggetto · Crea. POST /api/v1/works/{work_id}/props. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Prima richiesta · JSON

{
  "name": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/props/{reference_id}Oggetto · Leggere

Oggetto · Leggere. GET /api/v1/works/{work_id}/props/{reference_id}. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "kind": "character",
    "name": "example",
    "description": "example",
    "tags": [
      "example"
    ],
    "primary_asset_id": "11111111-1111-4111-8111-111111111111"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *cursor query limit query

Risposta server

PATCH/api/v1/works/{work_id}/props/{reference_id}Oggetto · Modifica

Oggetto · Modifica. PATCH /api/v1/works/{work_id}/props/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Prima richiesta · JSON

{
  "name": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

DELETE/api/v1/works/{work_id}/props/{reference_id}Oggetto · Elimina

Oggetto · Elimina. DELETE /api/v1/works/{work_id}/props/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/works/{work_id}/props/{reference_id}/primary-imageOggetto · Imposta immagine di riferimento

Oggetto · Imposta immagine di riferimento. PUT /api/v1/works/{work_id}/props/{reference_id}/primary-image. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`asset_id`	string	*	Format: UUID
`current_asset_id`	oneOf	*
`revision`	integer	*

Prima richiesta · JSON

{
  "asset_id": "11111111-1111-4111-8111-111111111111",
  "current_asset_id": "11111111-1111-4111-8111-111111111111",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{work_id}/props/{reference_id}/image-generationsOggetto · Genera immagine di riferimento

Oggetto · Genera immagine di riferimento. POST /api/v1/works/{work_id}/props/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`variants`	integer	—	Default: 1 Minimum: 1 Maximum: 4
`model`	string	—	Default: "image-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 20000 characters
`aspect_ratio`	string	—
`image_size`	string	—	Maximum length: 40 characters
`quality`	string	—	Allowed values: low, medium, high
`background`	string	—	Allowed values: auto, opaque, transparent
`output_format`	string	—	Allowed values: png, jpeg
`reference_asset_ids`	array	—	Default: [] Maximum items: 16 items
`slot`	string	—	Allowed values: primary, variant Default: "primary"
`variant_name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`current_asset_id`	string	—	Format: UUID

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}Oggetto · Collega alla scena

Oggetto · Collega alla scena. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}Oggetto · Scollega dalla scena

Oggetto · Scollega dalla scena. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/gridsGriglia · Leggere (list)

Griglia · Leggere (list). GET /api/v1/works/{work_id}/grids. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "kind": "character",
        "name": "example",
        "description": "example",
        "tags": [
          "example"
        ],
        "primary_asset_id": "11111111-1111-4111-8111-111111111111"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *cursor query limit query

Risposta server

POST/api/v1/works/{work_id}/gridsGriglia · Crea

Griglia · Crea. POST /api/v1/works/{work_id}/grids. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Prima richiesta · JSON

{
  "name": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/grids/{reference_id}Griglia · Leggere

Griglia · Leggere. GET /api/v1/works/{work_id}/grids/{reference_id}. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "kind": "character",
    "name": "example",
    "description": "example",
    "tags": [
      "example"
    ],
    "primary_asset_id": "11111111-1111-4111-8111-111111111111"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *cursor query limit query

Risposta server

PATCH/api/v1/works/{work_id}/grids/{reference_id}Griglia · Modifica

Griglia · Modifica. PATCH /api/v1/works/{work_id}/grids/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Prima richiesta · JSON

{
  "name": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

DELETE/api/v1/works/{work_id}/grids/{reference_id}Griglia · Elimina

Griglia · Elimina. DELETE /api/v1/works/{work_id}/grids/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/works/{work_id}/grids/{reference_id}/primary-imageGriglia · Imposta immagine di riferimento

Griglia · Imposta immagine di riferimento. PUT /api/v1/works/{work_id}/grids/{reference_id}/primary-image. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`asset_id`	string	*	Format: UUID
`current_asset_id`	oneOf	*
`revision`	integer	*

Prima richiesta · JSON

{
  "asset_id": "11111111-1111-4111-8111-111111111111",
  "current_asset_id": "11111111-1111-4111-8111-111111111111",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{work_id}/grids/{reference_id}/image-generationsGriglia · Genera immagine di riferimento

Griglia · Genera immagine di riferimento. POST /api/v1/works/{work_id}/grids/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`variants`	integer	—	Default: 1 Minimum: 1 Maximum: 4
`model`	string	—	Default: "image-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 20000 characters
`aspect_ratio`	string	—
`image_size`	string	—	Maximum length: 40 characters
`quality`	string	—	Allowed values: low, medium, high
`background`	string	—	Allowed values: auto, opaque, transparent
`output_format`	string	—	Allowed values: png, jpeg
`reference_asset_ids`	array	—	Default: [] Maximum items: 16 items
`slot`	string	—	Allowed values: primary, variant Default: "primary"
`variant_name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`current_asset_id`	string	—	Format: UUID

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

work_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}Griglia · Collega alla scena

Griglia · Collega alla scena. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}Griglia · Scollega dalla scena

Griglia · Scollega dalla scena. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/episodesEpisodio · Leggere (list)

Episodio · Leggere (list). GET /api/v1/works/{work_id}/episodes. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "number": 1,
        "title": "example",
        "raw_content": "example",
        "description": "example"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *cursor query limit query

Risposta server

POST/api/v1/works/{work_id}/episodesCrea episodio

Crea episodio. POST /api/v1/works/{work_id}/episodes. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`title`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`number`	integer	—
`raw_content`	string	—	Maximum length: 20000 characters
`description`	string	—	Maximum length: 4000 characters
`revision`	integer	*

Prima richiesta · JSON

{
  "title": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/episodes/{episode_id}Episodio · Leggere

Episodio · Leggere. GET /api/v1/works/{work_id}/episodes/{episode_id}. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "number": 1,
    "title": "example",
    "raw_content": "example",
    "description": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *episode_id path *cursor query limit query

Risposta server

PATCH/api/v1/works/{work_id}/episodes/{episode_id}Episodio · Modifica

Episodio · Modifica. PATCH /api/v1/works/{work_id}/episodes/{episode_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`title`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`number`	integer	—
`raw_content`	string	—	Maximum length: 20000 characters
`description`	string	—	Maximum length: 4000 characters
`revision`	integer	*

Prima richiesta · JSON

{
  "title": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *episode_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

DELETE/api/v1/works/{work_id}/episodes/{episode_id}Episodio · Elimina

Episodio · Elimina. DELETE /api/v1/works/{work_id}/episodes/{episode_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *episode_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/episodes/{episode_id}/scenesScena · Leggere (list)

Scena · Leggere (list). GET /api/v1/works/{work_id}/episodes/{episode_id}/scenes. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "episode_id": "11111111-1111-4111-8111-111111111111",
        "number": 1,
        "heading": "example",
        "description": "example",
        "video_prompt": "example"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *episode_id path *cursor query limit query

Risposta server

POST/api/v1/works/{work_id}/episodes/{episode_id}/scenesCrea scena

Crea scena. POST /api/v1/works/{work_id}/episodes/{episode_id}/scenes. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`heading`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`number`	integer	—
`description`	string	—	Maximum length: 4000 characters
`video_prompt`	oneOf	—
`revision`	integer	*

Prima richiesta · JSON

{
  "heading": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *episode_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}Scena · Leggere

Scena · Leggere. GET /api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}. GET

Permesso richiesto: projects:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "episode_id": "11111111-1111-4111-8111-111111111111",
    "number": 1,
    "heading": "example",
    "description": "example",
    "video_prompt": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *episode_id path *scene_id path *cursor query limit query

Risposta server

PATCH/api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}Scena · Modifica

Scena · Modifica. PATCH /api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`heading`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`number`	integer	—
`description`	string	—	Maximum length: 4000 characters
`video_prompt`	oneOf	—
`revision`	integer	*

Prima richiesta · JSON

{
  "heading": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *episode_id path *scene_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{work_id}/archive-importsImporta archivio ZIP

Importa archivio ZIP. 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}

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`asset_id`	string	*	Format: UUID

Prima richiesta · JSON

{
  "revision": 1,
  "asset_id": "11111111-1111-4111-8111-111111111111"
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "progress": {
      "phase": "extracting",
      "current": 0,
      "total": 0
    },
    "imported": 0,
    "failed": 0,
    "asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

work_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

GET/api/v1/works/{work_id}/archive-imports/{import_id}Consulta importazione ZIP

Consulta importazione ZIP. 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

Permesso richiesto: jobs:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`import_id`path	string	*	Format: UUID

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "progress": {
      "phase": "extracting",
      "current": 0,
      "total": 0
    },
    "imported": 0,
    "failed": 0,
    "asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *import_id path *

Risposta server

POST/api/v1/works/{work_id}/uploadsPreparare un gruppo di file

Preparare un gruppo di file. POST /api/v1/works/{work_id}/uploads. Idempotency-Key + files (1–20) → PUT upload_url → POST /api/v1/uploads/{upload_id}/complete

Permesso richiesto: assets:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`files`	array	*	Maximum items: 20 items
`files[].filename`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`files[].mime_type`	string	*	Allowed values: text/plain, text/markdown, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/png, image/jpeg, image/webp, image/avif, audio/wav, application/zip
`files[].size_bytes`	integer	*	Maximum: 1073741824
`files[].sha256`	string	*

Prima richiesta · JSON

{
  "files": [
    {
      "filename": "example",
      "mime_type": "text/plain",
      "size_bytes": 1,
      "sha256": "example"
    }
  ]
}

Risposte

HTTP 201 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "items": [
      {
        "filename": "example",
        "ticket": {
          "id": "11111111-1111-4111-8111-111111111111",
          "asset_id": "11111111-1111-4111-8111-111111111111",
          "upload_url": "example",
          "method": "PUT",
          "content_type": "example",
          "expires_at": "2026-09-20T00:00:00Z"
        }
      }
    ]
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

DELETE/api/v1/works/{work_id}/scenes/{scene_id}Scena · Elimina

Scena · Elimina. DELETE /api/v1/works/{work_id}/scenes/{scene_id}. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *scene_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/works/{work_id}/episodes/{episode_id}/scene-orderRiordinare le scene

Riordinare le scene. PUT /api/v1/works/{work_id}/episodes/{episode_id}/scene-order. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`scene_ids`	array	*	Maximum items: 500 items
`revision`	integer	*

Prima richiesta · JSON

{
  "scene_ids": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *episode_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/works/{work_id}/scriptSalva copione

Salva copione. PUT /api/v1/works/{work_id}/script. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`text`	string	*	Maximum length: 5000000 characters
`revision`	integer	*

Prima richiesta · JSON

{
  "text": "example",
  "revision": 1
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{work_id}/scenes/{scene_id}/video-generationsGenera video della scena

Genera video della scena. POST /api/v1/works/{work_id}/scenes/{scene_id}/video-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`anchor_asset_id`	string	—	Format: UUID
`reference_asset_ids`	array	—	Maximum items: 12 items
`model`	string	—	Default: "video-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 10000 characters
`duration_seconds`	integer	*	Minimum: 1 Maximum: 60
`resolution`	string	*	Minimum length: 1 characters Maximum length: 20 characters
`aspect_ratio`	string	*	Minimum length: 1 characters Maximum length: 20 characters
`generate_audio`	boolean	—

Prima richiesta · JSON

{
  "revision": 1,
  "duration_seconds": 1,
  "resolution": "example",
  "aspect_ratio": "example"
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

work_id path *scene_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/works/{work_id}/scenes/{scene_id}/selected-takeSeleziona ripresa finale

Seleziona ripresa finale. PUT /api/v1/works/{work_id}/scenes/{scene_id}/selected-take. revision + Idempotency-Key

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`take_id`	oneOf	*

Prima richiesta · JSON

{
  "revision": 1,
  "take_id": "11111111-1111-4111-8111-111111111111"
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

work_id path *scene_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{work_id}/exportsEsporta video finale

Esporta video finale. POST /api/v1/works/{work_id}/exports. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`allow_partial`	boolean	—	Default: true
`selections`	array	—	Maximum items: 200 items
`selections[].scene_id`	string	*	Format: UUID
`selections[].asset_id`	string	*	Format: UUID

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

work_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

API di compatibilit?

POST/api/v1/works/{project_id}/plansVedi il piano e i crediti previsti

Controlla che cosa verrà prodotto e quanti crediti servono, senza avviare la produzione.

Permesso richiesto: runs:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`template_id`	string	*	Fixed value: episode-production
`template_version`	number	*	Fixed value: 1
`project_revision`	integer	*
`episode_ids`	array	*	Gli ID degli episodi devono essere univoci. Maximum items: 10 items
`mode`	string	*	Allowed values: reviewed, automatic
`output_profile`	string	*	Allowed values: sandbox-episode-v1, episode-standard-v1

Prima richiesta · JSON

{
  "template_id": "episode-production",
  "template_version": 1,
  "project_revision": 1,
  "episode_ids": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "mode": "reviewed",
  "output_profile": "sandbox-episode-v1"
}

Risposte

HTTP 201 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "project_revision": 1,
    "template_id": "example",
    "template_version": 1,
    "executable": false,
    "expires_at": "2026-09-20T00:00:00Z",
    "budget_ceiling": {
      "currency": "example",
      "micro_units": "example"
    },
    "steps": [
      {
        "stage_key": "example",
        "target_ids": [
          "11111111-1111-4111-8111-111111111111"
        ],
        "depends_on": [
          "example"
        ],
        "requires_review": false,
        "max_cost": {
          "currency": "example",
          "micro_units": "example"
        }
      }
    ],
    "unsupported_reasons": [
      "example"
    ]
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

project_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{project_id}/runsAvvia la produzione

Avvia la produzione da un plan_id esistente e restituisce l’ID dell’esecuzione. Segui stato e risultati con getRun.

Permesso richiesto: runs:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`plan_id`	string	*	Format: UUID
`client_reference`	string	—	Maximum length: 128 characters

Prima richiesta · JSON

{
  "plan_id": "11111111-1111-4111-8111-111111111111"
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "plan_id": "11111111-1111-4111-8111-111111111111",
    "version": 1,
    "state": "queued",
    "client_reference": "example",
    "created_at": "2026-09-20T00:00:00Z",
    "completed_at": "2026-09-20T00:00:00Z",
    "budget_remaining": {
      "currency": "example",
      "micro_units": "example"
    },
    "committed_cost": {
      "currency": "example",
      "micro_units": "example"
    },
    "unresolved_cost": {
      "currency": "example",
      "micro_units": "example"
    },
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ]
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

project_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{project_id}/workflow/commandsModifica la produzione Studio

Modifica copione, scene, design o take selezionati. Scegli operation e invia input con la revision aggiornata.

Permesso richiesto: projects:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*	operation = design.asset.set
`operation`	string	*	operation = design.asset.set Fixed value: design.asset.set
`input`	object	*	operation = design.asset.set
`input.id`	string	*	operation = design.asset.set Format: UUID
`input.asset_id`	string	*	operation = design.asset.set Format: UUID
`input.kind`	string	*	operation = design.asset.set Allowed values: primary, variant
`input.current_asset_id`	oneOf	*	operation = design.asset.set
`input.name`	string	—	operation = design.asset.set Minimum length: 1 characters Maximum length: 80 characters
`revision`	integer	*	operation = asset.delete
`operation`	string	*	operation = asset.delete Fixed value: asset.delete
`input`	object	*	operation = asset.delete
`input.id`	string	*	operation = asset.delete Format: UUID
`revision`	integer	*	operation = trash.restore
`operation`	string	*	operation = trash.restore Fixed value: trash.restore
`input`	object	*	operation = trash.restore
`input.id`	string	*	operation = trash.restore Format: UUID
`input.entity_type`	string	*	operation = trash.restore Allowed values: asset, design
`revision`	integer	*	operation = scene.duplicate
`operation`	string	*	operation = scene.duplicate Fixed value: scene.duplicate
`input`	object	*	operation = scene.duplicate
`input.id`	string	*	operation = scene.duplicate Format: UUID
`revision`	integer	*	operation = project.settings.update
`operation`	string	*	operation = project.settings.update Fixed value: project.settings.update
`input`	object	*	operation = project.settings.update
`input.title`	string	*	operation = project.settings.update Minimum length: 1 characters Maximum length: 120 characters
`input.tags`	array	*	operation = project.settings.update Maximum items: 8 items
`input.cover`	string	*	operation = project.settings.update Allowed values: amber, indigo, teal, rust, moss, ink, sage, bone, wine, wash, blush, void
`input.aspect`	string	*	operation = project.settings.update Allowed values: 16:9, 9:16, 1:1, 4:3, 21:9
`input.resolution`	string	*	operation = project.settings.update Allowed values: 480p, 720p, 1080p, 2k
`input.style`	string	*	operation = project.settings.update Allowed values: 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
`input.style_prompt`	string	*	operation = project.settings.update Maximum length: 1000 characters
`revision`	integer	*	operation = project.rename
`operation`	string	*	operation = project.rename Fixed value: project.rename
`input`	object	*	operation = project.rename
`input.title`	string	*	operation = project.rename Minimum length: 1 characters Maximum length: 120 characters
`revision`	integer	*	operation = project.state.set
`operation`	string	*	operation = project.state.set Fixed value: project.state.set
`input`	object	*	operation = project.state.set
`input.state`	string	*	operation = project.state.set Allowed values: active, archived
`revision`	integer	*	operation = script.update
`operation`	string	*	operation = script.update Fixed value: script.update
`input`	object	*	operation = script.update
`input.text`	string	*	operation = script.update Maximum length: 5000000 characters
`revision`	integer	*	operation = script.bible.update
`operation`	string	*	operation = script.bible.update Fixed value: script.bible.update
`input`	object	*	operation = script.bible.update
`input.logline`	string	*	operation = script.bible.update Maximum length: 500 characters
`input.synopsis`	string	*	operation = script.bible.update Maximum length: 4000 characters
`revision`	integer	*	operation = episode.save
`operation`	string	*	operation = episode.save Fixed value: episode.save
`input`	object	*	operation = episode.save
`input.id`	string	—	operation = episode.save Format: UUID
`input.title`	string	*	operation = episode.save Minimum length: 1 characters Maximum length: 200 characters
`input.number`	integer	—	operation = episode.save
`input.raw_content`	string	—	operation = episode.save Maximum length: 20000 characters
`input.description`	string	—	operation = episode.save Maximum length: 4000 characters
`revision`	integer	*	operation = episode.delete
`operation`	string	*	operation = episode.delete Fixed value: episode.delete
`input`	object	*	operation = episode.delete
`input.id`	string	*	operation = episode.delete Format: UUID
`revision`	integer	*	operation = scene.save
`operation`	string	*	operation = scene.save Fixed value: scene.save
`input`	object	*	operation = scene.save
`input.id`	string	—	operation = scene.save Format: UUID
`input.episode_id`	string	*	operation = scene.save Format: UUID
`input.heading`	string	*	operation = scene.save Minimum length: 1 characters Maximum length: 200 characters
`input.number`	integer	—	operation = scene.save
`input.description`	string	—	operation = scene.save Maximum length: 4000 characters
`input.video_prompt`	oneOf	—	operation = scene.save
`revision`	integer	*	operation = scene.delete
`operation`	string	*	operation = scene.delete Fixed value: scene.delete
`input`	object	*	operation = scene.delete
`input.id`	string	*	operation = scene.delete Format: UUID
`revision`	integer	*	operation = scene.reorder
`operation`	string	*	operation = scene.reorder Fixed value: scene.reorder
`input`	object	*	operation = scene.reorder
`input.episode_id`	string	*	operation = scene.reorder Format: UUID
`input.scene_ids`	array	*	operation = scene.reorder Maximum items: 500 items
`revision`	integer	*	operation = design.save
`operation`	string	*	operation = design.save Fixed value: design.save
`input`	object	*	operation = design.save
`input.id`	string	—	operation = design.save Format: UUID
`input.kind`	string	*	operation = design.save Allowed values: character, scene, prop, grid
`input.name`	string	*	operation = design.save Minimum length: 1 characters Maximum length: 200 characters
`input.description`	string	—	operation = design.save Maximum length: 4000 characters
`input.tags`	array	—	operation = design.save Maximum items: 8 items
`revision`	integer	*	operation = design.delete
`operation`	string	*	operation = design.delete Fixed value: design.delete
`input`	object	*	operation = design.delete
`input.id`	string	*	operation = design.delete Format: UUID
`revision`	integer	*	operation = design.voice.set
`operation`	string	*	operation = design.voice.set Fixed value: design.voice.set
`input`	object	*	operation = design.voice.set
`input.id`	string	*	operation = design.voice.set Format: UUID
`input.asset_id`	oneOf	*	operation = design.voice.set
`revision`	integer	*	operation = design.asset.detach
`operation`	string	*	operation = design.asset.detach Fixed value: design.asset.detach
`input`	object	*	operation = design.asset.detach
`input.id`	string	*	operation = design.asset.detach Format: UUID
`input.asset_id`	string	*	operation = design.asset.detach Format: UUID
`input.kind`	string	*	operation = design.asset.detach Allowed values: primary, variant, voice
`revision`	integer	*	operation = design.asset.restore
`operation`	string	*	operation = design.asset.restore Fixed value: design.asset.restore
`input`	object	*	operation = design.asset.restore
`input.id`	string	*	operation = design.asset.restore Format: UUID
`input.current_asset_id`	string	*	operation = design.asset.restore Format: UUID
`input.restore_asset_id`	string	*	operation = design.asset.restore Format: UUID
`input.kind`	string	*	operation = design.asset.restore Allowed values: primary, variant
`revision`	integer	*	operation = design.variant.rename
`operation`	string	*	operation = design.variant.rename Fixed value: design.variant.rename
`input`	object	*	operation = design.variant.rename
`input.id`	string	*	operation = design.variant.rename Format: UUID
`input.asset_id`	string	*	operation = design.variant.rename Format: UUID
`input.name`	string	*	operation = design.variant.rename Minimum length: 1 characters Maximum length: 80 characters
`revision`	integer	*	operation = scene.design.attach
`operation`	string	*	operation = scene.design.attach Fixed value: scene.design.attach
`input`	object	*	operation = scene.design.attach
`input.scene_id`	string	*	operation = scene.design.attach Format: UUID
`input.design_id`	string	*	operation = scene.design.attach Format: UUID
`revision`	integer	*	operation = scene.design.detach
`operation`	string	*	operation = scene.design.detach Fixed value: scene.design.detach
`input`	object	*	operation = scene.design.detach
`input.scene_id`	string	*	operation = scene.design.detach Format: UUID
`input.design_id`	string	*	operation = scene.design.detach Format: UUID
`revision`	integer	*	operation = cut.take.select
`operation`	string	*	operation = cut.take.select Fixed value: cut.take.select
`input`	object	*	operation = cut.take.select
`input.scene_id`	string	*	operation = cut.take.select Format: UUID
`input.asset_id`	oneOf	*	operation = cut.take.select
`revision`	integer	*	operation = take.delete
`operation`	string	*	operation = take.delete Fixed value: take.delete
`input`	object	*	operation = take.delete
`input.scene_id`	string	*	operation = take.delete Format: UUID
`input.asset_id`	string	*	operation = take.delete Format: UUID

Prima richiesta · JSON

{
  "revision": 1,
  "operation": "design.asset.set",
  "input": {
    "id": "11111111-1111-4111-8111-111111111111",
    "asset_id": "11111111-1111-4111-8111-111111111111",
    "kind": "primary",
    "current_asset_id": "11111111-1111-4111-8111-111111111111"
  }
}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "work_id": "11111111-1111-4111-8111-111111111111",
    "changed_id": "11111111-1111-4111-8111-111111111111",
    "revision": 1,
    "studio_url": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

project_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{project_id}/cut/exportsEsporta il montaggio Studio

Unisce i video nell’ordine di episodi e scene. selections sceglie i take; allow_partial consente scene mancanti. Segui l’esportazione con getJob.

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`allow_partial`	boolean	—	Default: true
`selections`	array	—	Maximum items: 200 items
`selections[].scene_id`	string	*	Format: UUID
`selections[].asset_id`	string	*	Format: UUID

Prima richiesta · JSON

{
  "revision": 1
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

project_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{project_id}/storyboard/videosGenera il video della scena

Genera un video per scene_id con modello, durata e risoluzione scelti. anchor_asset_id può indicare l’immagine iniziale. Segui il job con getJob.

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`scene_id`	string	*	Format: UUID
`anchor_asset_id`	string	—	Format: UUID
`reference_asset_ids`	array	—	Maximum items: 12 items
`model`	string	—	Default: "video-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 10000 characters
`duration_seconds`	integer	*	Minimum: 1 Maximum: 60
`resolution`	string	*	Minimum length: 1 characters Maximum length: 20 characters
`aspect_ratio`	string	*	Minimum length: 1 characters Maximum length: 20 characters
`generate_audio`	boolean	—

Prima richiesta · JSON

{
  "revision": 1,
  "scene_id": "11111111-1111-4111-8111-111111111111",
  "duration_seconds": 1,
  "resolution": "example",
  "aspect_ratio": "example"
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

project_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/works/{project_id}/designs/imagesGenera un’immagine di personaggio, ambiente, oggetto di scena o griglia

Genera da una a quattro immagini per design_id con prompt e riferimenti facoltativi. Scegli lo slot principale o variante e segui getJob.

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`revision`	integer	*
`design_id`	string	*	Format: UUID
`variants`	integer	—	Default: 1 Minimum: 1 Maximum: 4
`model`	string	—	Default: "image-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 20000 characters
`aspect_ratio`	string	—
`image_size`	string	—	Maximum length: 40 characters
`quality`	string	—	Allowed values: low, medium, high
`background`	string	—	Allowed values: auto, opaque, transparent
`output_format`	string	—	Allowed values: png, jpeg
`reference_asset_ids`	array	—	Default: [] Maximum items: 16 items
`slot`	string	—	Allowed values: primary, variant Default: "primary"
`variant_name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`current_asset_id`	string	—	Format: UUID

Prima richiesta · JSON

{
  "revision": 1,
  "design_id": "11111111-1111-4111-8111-111111111111"
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

project_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

Caricamenti

POST/api/v1/uploadsOttieni un indirizzo per caricare il file

Registra i metadati e restituisce upload_url. Invia il file con PUT, poi conferma il completamento del caricamento. Formati: TXT, Markdown, DOCX, PNG, JPEG, WebP, AVIF, WAV e ZIP. I limiti sono condivisi con Studio: consulta upload_limits in GET /capabilities. Copioni: massimo 5.000.000 di caratteri. Nessun separatore di percorso nel nome. WAV in PCM o IEEE float.

Permesso richiesto: assets:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`project_id`	string	*	Format: UUID
`filename`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`mime_type`	string	*	Allowed values: text/plain, text/markdown, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/png, image/jpeg, image/webp, image/avif, audio/wav, application/zip
`size_bytes`	integer	*	Maximum: 1073741824
`sha256`	string	*

Prima richiesta · JSON

{
  "project_id": "11111111-1111-4111-8111-111111111111",
  "filename": "example",
  "mime_type": "text/plain",
  "size_bytes": 1,
  "sha256": "example"
}

Risposte

HTTP 201 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "asset_id": "11111111-1111-4111-8111-111111111111",
    "upload_url": "example",
    "method": "PUT",
    "content_type": "example",
    "expires_at": "2026-09-20T00:00:00Z"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

Idempotency-Key header * Corpo richiesta application/json

Risposta server

POST/api/v1/uploads/{upload_id}/completeComunica che il file è stato caricato

Verifica il file caricato rispetto ai metadati dichiarati e restituisce l’asset utilizzabile nella produzione.

Permesso richiesto: assets:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`upload_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Prima richiesta · JSON

{}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "state": "pending",
    "mime_type": "example",
    "size_bytes": 0,
    "download_url": "example",
    "expires_at": "2026-09-20T00:00:00Z"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

upload_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

PUT/api/v1/uploads/{upload_id}/contentCarica il contenuto del file

Invia i byte del file come application/octet-stream per un caricamento già preparato. Poi chiama completeUpload.

Permesso richiesto: assets:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`upload_id`path	string	*	Format: UUID

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "uploaded": true
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

upload_id path * application/octet-stream

Risposta server

File e risultati

GET/api/v1/assets/{asset_id}Vedi il risultato e il link per scaricarlo

Restituisce i metadati e, se disponibile, un download_url firmato. Scarica il file prima della scadenza.

Permesso richiesto: assets:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`asset_id`path	string	*	Format: UUID

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "state": "pending",
    "mime_type": "example",
    "size_bytes": 0,
    "download_url": "example",
    "expires_at": "2026-09-20T00:00:00Z"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

asset_id path *

Risposta server

GET/api/v1/downloads/{asset_id}Scarica il file finito

Scarica il file tramite il download_url firmato completo restituito da getAsset. Il link scade dopo cinque minuti.

Parametri

Nome	Type	Obbligatorio	Descrizione
`asset_id`path	string	*	Format: UUID
`expires`query	string	*
`signature`query	string	*

Risposte

HTTP 200 Byte del file

application/octet-stream · Byte del file

Risposte di errore · error.code ↗

Prova

asset_id path *expires query *signature query *

Risposta server

Esecuzioni

GET/api/v1/runsVedi l’elenco delle produzioni

Elenca le esecuzioni filtrando per progetto, stato, client_reference e periodo.

Permesso richiesto: runs:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100
`project_id`query	string	—	Format: UUID
`state`query	string	—	Allowed values: queued, running, awaiting_review, stopping, paused, needs_attention, partially_succeeded, succeeded, failed, cancelled
`client_reference`query	string	—	Minimum length: 1 characters Maximum length: 128 characters
`from`query	string	—	Format: Date and time with timezone
`to`query	string	—	Format: Date and time with timezone

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "work_id": "11111111-1111-4111-8111-111111111111",
        "plan_id": "11111111-1111-4111-8111-111111111111",
        "version": 1,
        "state": "queued",
        "client_reference": "example",
        "created_at": "2026-09-20T00:00:00Z",
        "completed_at": "2026-09-20T00:00:00Z",
        "budget_remaining": {
          "currency": "example",
          "micro_units": "example"
        },
        "committed_cost": {
          "currency": "example",
          "micro_units": "example"
        },
        "unresolved_cost": {
          "currency": "example",
          "micro_units": "example"
        },
        "output_asset_ids": [
          "11111111-1111-4111-8111-111111111111"
        ]
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

cursor query limit query project_id query state query client_reference query from query to query

Risposta server

GET/api/v1/runs/{run_id}Vedi a che punto è la produzione

Restituisce stato, versione e risultati disponibili di un’esecuzione. Usa la versione per inviare una decisione.

Permesso richiesto: runs:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`run_id`path	string	*	Format: UUID

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "plan_id": "11111111-1111-4111-8111-111111111111",
    "version": 1,
    "state": "queued",
    "client_reference": "example",
    "created_at": "2026-09-20T00:00:00Z",
    "completed_at": "2026-09-20T00:00:00Z",
    "budget_remaining": {
      "currency": "example",
      "micro_units": "example"
    },
    "committed_cost": {
      "currency": "example",
      "micro_units": "example"
    },
    "unresolved_cost": {
      "currency": "example",
      "micro_units": "example"
    },
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ]
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

run_id path *

Risposta server

GET/api/v1/runs/{run_id}/stepsVedi l’avanzamento passo per passo

Elenca le fasi di un’esecuzione per vedere quali sono in attesa, in corso o completate.

Permesso richiesto: runs:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`run_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "run_id": "11111111-1111-4111-8111-111111111111",
        "stage_key": "example",
        "target_id": "11111111-1111-4111-8111-111111111111",
        "job_id": "11111111-1111-4111-8111-111111111111",
        "state": "blocked",
        "output_asset_ids": [
          "11111111-1111-4111-8111-111111111111"
        ],
        "error_code": "example",
        "ordinal": 1
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

run_id path *cursor query limit query

Risposta server

GET/api/v1/runs/{run_id}/eventsVedi cosa è successo durante la produzione

Elenca eventi come cambi di stato e richieste di revisione per ricostruire il processo di produzione.

Permesso richiesto: runs:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`run_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "items": [
      {
        "event_id": "11111111-1111-4111-8111-111111111111",
        "run_id": "11111111-1111-4111-8111-111111111111",
        "sequence": 1,
        "type": "run.state_changed",
        "state": "queued",
        "step_id": "11111111-1111-4111-8111-111111111111",
        "created_at": "2026-09-20T00:00:00Z"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

run_id path *cursor query limit query

Risposta server

POST/api/v1/runs/{run_id}/decisionsApprova se continuare o ferma tutto

Invia una decisione: approve, stop, resume, cancel_remaining o retry_result. Indica la versione più recente in expected_version. retry_result riprende solo la verifica del video salvato. Invia expected_version aggiornato e step_id. Mantiene il lavoro e i crediti prenotati senza rigenerare. Disponibile entro 24 ore dalla richiesta. Altri risultati o consumi incerti richiedono una verifica operatore.

Permesso richiesto: runs:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`run_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`action`	string	*	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. Allowed values: approve, stop, resume, cancel_remaining, retry_result
`expected_version`	integer	*
`step_id`	string	—	Format: UUID
`selected_asset_ids`	array	—	Maximum items: 10 items

Prima richiesta · JSON

{
  "action": "approve",
  "expected_version": 1
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "plan_id": "11111111-1111-4111-8111-111111111111",
    "version": 1,
    "state": "queued",
    "client_reference": "example",
    "created_at": "2026-09-20T00:00:00Z",
    "completed_at": "2026-09-20T00:00:00Z",
    "budget_remaining": {
      "currency": "example",
      "micro_units": "example"
    },
    "committed_cost": {
      "currency": "example",
      "micro_units": "example"
    },
    "unresolved_cost": {
      "currency": "example",
      "micro_units": "example"
    },
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ]
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

run_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

Funzioni del workflow

GET/api/v1/jobs/{job_id}Vedi stato e risultato di un lavoro

Restituisce lo stato del job e gli ID degli asset prodotti. Al termine usa getAsset per recuperare i file.

Permesso richiesto: jobs:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`job_id`path	string	*	Format: UUID

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

job_id path *

Risposta server

GET/api/v1/jobs/{job_id}/buildLeggere avanzamento e fonti

Restituisce fase, messaggi di avanzamento e documenti sorgente della costruzione del copione, incluso il testo preparato per l’elaborazione.

Permesso richiesto: jobs:read, assets:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`job_id`path	string	*	Format: UUID

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "state": "example",
    "stage": "example",
    "messages": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "role": "assistant",
        "stage": "example",
        "content": "example",
        "status": "streaming",
        "seq": 1,
        "created_at": "example",
        "updated_at": "example"
      }
    ],
    "sources": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "example",
        "filterMode": "prompt_index",
        "sourceText": "example",
        "llmText": "example",
        "originalChars": 1,
        "preparedChars": 1
      }
    ]
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

job_id path *

Risposta server

API di compatibilit?

POST/api/v1/jobsEsegui subito una sola funzione

Esegui una sola funzione invece dell’intera produzione. analyze_script legge il copione e crea le inquadrature, generate_image crea le immagini di personaggi, ambienti, oggetti e inquadrature, generate_video crea il video di un’inquadratura di cui hai scelto l’immagine e assemble_video unisce un episodio in cui tutte le inquadrature hanno un video. Invia sempre l’ultima revision del progetto. Le richieste Live bloccano i crediti in anticipo.

Permesso richiesto: jobs:create

Parametri

Nome	Type	Obbligatorio	Descrizione
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`project_id`	string	*	Format: UUID
`project_revision`	integer	*
`target_id`	string	*	Format: UUID
`type`	string	*	Allowed values: analyze_script, generate_image, generate_video, assemble_video
`profile_id`	string	*	Maximum length: 100 characters
`client_reference`	string	—	Maximum length: 128 characters

Prima richiesta · JSON

{
  "project_id": "11111111-1111-4111-8111-111111111111",
  "project_revision": 1,
  "target_id": "11111111-1111-4111-8111-111111111111",
  "type": "analyze_script",
  "profile_id": "example"
}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "state": "queued",
    "output_asset_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

Idempotency-Key header * Corpo richiesta application/json

Risposta server

Registri richieste

GET/api/v1/requestsVedi le richieste che hai inviato

Elenca le richieste API con stato HTTP e durata. Filtra per progetto e periodo per esaminare le chiamate.

Permesso richiesto: requests:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100
`from`query	string	—	Format: Date and time with timezone
`to`query	string	—	Format: Date and time with timezone
`project_id`query	string	—	Format: UUID
`run_id`query	string	—	Format: UUID
`job_id`query	string	—	Format: UUID
`key_id`query	string	—	Format: UUID
`status_code`query	integer	—	Minimum: 100 Maximum: 599
`method`query	string	—	Allowed values: GET, POST, PATCH, PUT
`route_template`query	string	—	Minimum length: 1 characters Maximum length: 300 characters

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "items": [
      {
        "request_id": "11111111-1111-4111-8111-111111111111",
        "created_at": "2026-09-20T00:00:00Z",
        "method": "GET",
        "route_template": "example",
        "status_code": 100,
        "duration_ms": 0,
        "actor_kind": "api_key",
        "work_id": "11111111-1111-4111-8111-111111111111",
        "run_id": "11111111-1111-4111-8111-111111111111",
        "job_id": "11111111-1111-4111-8111-111111111111",
        "replayed": false,
        "error_code": "example"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

cursor query limit query from query to query project_id query run_id query job_id query key_id query status_code query method query route_template query

Risposta server

GET/api/v1/requests/{request_id}Vedi una singola richiesta inviata

Cerca una chiamata tramite request_id con stato HTTP, durata ed esecuzione o job associato.

Permesso richiesto: requests:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`request_id`path	string	*	Format: UUID

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "request_id": "11111111-1111-4111-8111-111111111111",
    "created_at": "2026-09-20T00:00:00Z",
    "method": "GET",
    "route_template": "example",
    "status_code": 100,
    "duration_ms": 0,
    "actor_kind": "api_key",
    "work_id": "11111111-1111-4111-8111-111111111111",
    "run_id": "11111111-1111-4111-8111-111111111111",
    "job_id": "11111111-1111-4111-8111-111111111111",
    "replayed": false,
    "error_code": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

request_id path *

Risposta server

Utilizzo

GET/api/v1/usageVedi quanti crediti hai usato

Restituisce i totali di utilizzo nel periodo richiesto, inclusi gli importi riservati e contabilizzati.

Permesso richiesto: usage:read

Parametri

Nessun parametro

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "period_start": "2026-09-20T00:00:00Z",
    "period_end": "2026-09-20T00:00:00Z",
    "as_of": "2026-09-20T00:00:00Z",
    "http_requests": 0,
    "runs": 0,
    "jobs": 0,
    "reserved": {
      "currency": "example",
      "micro_units": "example"
    },
    "committed": {
      "currency": "example",
      "micro_units": "example"
    },
    "unresolved": {
      "currency": "example",
      "micro_units": "example"
    },
    "remaining": {
      "currency": "example",
      "micro_units": "example"
    },
    "amount_basis": "partner_limit",
    "billing_mode": "pilot"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

Risposta server

Webhook

GET/api/v1/webhook-endpointsVedi i tuoi indirizzi Webhook

Elenca URL Webhook registrati, eventi sottoscritti e stato di attivazione.

Permesso richiesto: webhooks:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "url": "example",
        "work_ids": [
          "11111111-1111-4111-8111-111111111111"
        ],
        "events": [
          "run.state_changed"
        ],
        "enabled": false,
        "verified": false,
        "secret_version": 1,
        "created_at": "2026-09-20T00:00:00Z"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

cursor query limit query

Risposta server

POST/api/v1/webhook-endpointsAggiungi un indirizzo Webhook

Registra un URL Webhook per ricevere gli eventi di produzione selezionati per i progetti indicati.

Permesso richiesto: webhooks:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`url`	string	*	Format: uri Maximum length: 2000 characters
`project_ids`	array	*	Maximum items: 100 items
`events`	array	*	Maximum items: 4 items

Prima richiesta · JSON

{
  "url": "example",
  "project_ids": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "events": [
    "run.state_changed"
  ]
}

Risposte

HTTP 201 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "endpoint": {
      "id": "11111111-1111-4111-8111-111111111111",
      "url": "example",
      "work_ids": [
        "11111111-1111-4111-8111-111111111111"
      ],
      "events": [
        "run.state_changed"
      ],
      "enabled": false,
      "verified": false,
      "secret_version": 1,
      "created_at": "2026-09-20T00:00:00Z"
    }
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

Idempotency-Key header * Corpo richiesta application/json

Risposta server

PATCH/api/v1/webhook-endpoints/{endpoint_id}Modifica un indirizzo Webhook

Attiva o disattiva un Webhook oppure modifica gli eventi ricevuti.

Permesso richiesto: webhooks:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`endpoint_id`path	string	*	Format: UUID
`If-Match`header	string	*	Usa il più recente ETag, comprese le virgolette.

Corpo richiesta

Nome	Type	Obbligatorio	Descrizione
`enabled`	boolean	—
`events`	array	—	Maximum items: 4 items

Prima richiesta · JSON

{}

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "url": "example",
    "work_ids": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "events": [
      "run.state_changed"
    ],
    "enabled": false,
    "verified": false,
    "secret_version": 1,
    "created_at": "2026-09-20T00:00:00Z"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

endpoint_id path *If-Match header * Corpo richiesta application/json

Risposta server

Consegne Webhook

GET/api/v1/webhook-deliveriesVedi i Webhook già inviati

Elenca i tentativi di consegna Webhook e il loro stato per verificare l’invio delle notifiche.

Permesso richiesto: webhooks:read

Parametri

Nome	Type	Obbligatorio	Descrizione
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Risposte

HTTP 200 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "items": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "endpoint_id": "11111111-1111-4111-8111-111111111111",
        "event_id": "11111111-1111-4111-8111-111111111111",
        "state": "pending",
        "attempt": 0,
        "http_status": 1,
        "next_attempt_at": "2026-09-20T00:00:00Z",
        "created_at": "2026-09-20T00:00:00Z"
      }
    ],
    "next_cursor": "example"
  }
}

Header risposta: X-Request-Id · ETag

Risposte di errore · error.code ↗

Prova

cursor query limit query

Risposta server

POST/api/v1/webhook-deliveries/{delivery_id}/redeliverInvia di nuovo un Webhook

Richiede un nuovo invio della notifica Webhook indicata da delivery_id.

Permesso richiesto: webhooks:write

Parametri

Nome	Type	Obbligatorio	Descrizione
`delivery_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Riprova con la stessa Idempotency-Key e lo stesso corpo. Minimum length: 16 characters Maximum length: 128 characters

Corpo richiesta

Prima richiesta · JSON

{}

Risposte

HTTP 202 Successo

Prima richiesta · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "endpoint_id": "11111111-1111-4111-8111-111111111111",
    "event_id": "11111111-1111-4111-8111-111111111111",
    "state": "pending",
    "attempt": 0,
    "http_status": 1,
    "next_attempt_at": "2026-09-20T00:00:00Z",
    "created_at": "2026-09-20T00:00:00Z"
  }
}

Header risposta: X-Request-Id · ETag · Retry-After

Risposte di errore · error.code ↗

Prova

delivery_id path *Idempotency-Key header * Corpo richiesta application/json

Risposta server

Specifica

GET/api/v1/openapi.jsonScarica la specifica dell’API

Scarica la specifica OpenAPI con percorsi, campi delle richieste e schemi delle risposte.

Parametri

Nessun parametro

Risposte

HTTP 200 Documento OpenAPI

Prima richiesta · JSON

{}

Prova

Risposta server

Risposte di errore · error.code 71

Una risposta 2xx significa che la richiesta è passata. 201 indica che qualcosa è stato creato, 202 che la richiesta è stata accettata ed è ancora in lavorazione: il risultato non c’è ancora, controlla lo stato del job per sapere quando è pronto. Le risposte riuscite contengono request_id e data. Fanno eccezione solo il download dei file e il documento di specifica. In caso di errore tutti gli endpoint restituiscono lo stesso oggetto error. Usa error.code per le condizioni nel codice; message spiega a una persona la causa e cosa fare. È retryable a dire se puoi rimandare la richiesta. Riprova automaticamente solo quando è true e aspetta il tempo indicato da retry_after_seconds o dall’header Retry-After. Quando ripeti una POST, invia la stessa Idempotency-Key e lo stesso corpo per non pagare o creare due volte. Se ricevi un error.code che non conosci, gestiscilo in base allo stato HTTP e a retryable. Indica request_id quando contatti il supporto. Gli errori che si verificano dopo l’accettazione di un job compaiono nello stato e nel risultato del job, non in questa risposta.

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid input. Check the required fields, types and values.",
    "retryable": false
  }
}

error.code	HTTP	Descrizione
`INVALID_REFERENCE`	422	A selected reference is unavailable or does not belong to this project. Select a ready image from this project.
`MODEL_UNAVAILABLE`	422	The selected model is unavailable. Refresh the model list and select another model.
`MODEL_POLICY_REQUIRED`	503	No default model policy is configured. Specify a model or ask the administrator to configure the task policy.
`BUILD_REPLAY_CONFLICT`	409	The build inputs changed. Review the saved build before continuing.
`INVALID_REQUEST`	400,422	Invalid input. Check the required fields, types and values.
`INVALID_API_KEY`	401	Invalid credentials or download signature. Check the API key or obtain a new download URL.
`INSUFFICIENT_SCOPE`	403	Permission denied. Check the key scopes and project access.
`PARTNER_BLOCKED`	403	Account blocked. Contact support.
`PARTNER_PAUSED`	403	Account paused. Ask the administrator to resume access.
`RESOURCE_NOT_FOUND`	404	Resource unavailable. Check its ID and access permissions.
`METHOD_NOT_ALLOWED`	405	Unsupported HTTP method. Use the documented method.
`REQUEST_TIMEOUT`	408	Request body timed out. Check the connection and upload size.
`IDEMPOTENCY_KEY_REQUIRED`	400	Provide a valid Idempotency-Key header.
`IDEMPOTENCY_CONFLICT`	409	This Idempotency-Key belongs to a different request. Reuse it only with the original request.
`IDEMPOTENCY_KEY_EXPIRED`	409	Idempotency record expired. Check the original result before starting a new operation.
`PRECONDITION_FAILED`	412	Provide the latest quoted ETag in If-Match.
`REVISION_CONFLICT`	409	Resource changed. Read the latest revision before updating.
`RESOURCE_CONFLICT`	409	Resource conflicts with existing data. Review the current resource.
`INVALID_TRANSITION`	409	Action is unavailable in the current state. Read the latest state.
`RUN_IN_PROGRESS`	409	A run is in progress. Check its status before starting another.
`JOB_RUNNING`	409	A job is running. Wait for completion before editing.
`PLAN_EXPIRED`	409	Plan expired. Create a new plan and review its quote.
`INSUFFICIENT_CREDITS`	402	Insufficient credits. Check the balance and required credits.
`BUDGET_EXCEEDED`	409,429	Budget limit exceeded. Review usage and the configured budget.
`RATE_LIMITED`	429	Request rate exceeded. Follow retryable and Retry-After before retrying.
`CAPACITY_EXCEEDED`	429	Capacity limit exceeded. Reduce the workload or wait for active work to finish.
`PAYLOAD_TOO_LARGE`	413	Request body too large. Reduce it to the documented limit.
`UNSUPPORTED_MEDIA_TYPE`	415	Unsupported content type or encoding. Use the documented Content-Type without Content-Encoding.
`UPLOAD_TOO_LARGE`	422	Uploaded content exceeds its processing limit. Reduce the file size.
`UPLOAD_NOT_VERIFIED`	422	Upload is incomplete, expired or invalid. Check the upload and verification steps.
`ASSET_KIND_MISMATCH`	422	Asset type does not match the operation. Select a compatible asset.
`SELECTED_IMAGE_REQUIRED`	422	Select a valid image before generating video.
`SELECTED_VIDEO_REQUIRED`	422	Select valid videos for the requested shots before assembly.
`REFERENCE_LIMIT_EXCEEDED`	422	Too many reference assets. Reduce them to the model limit.
`REFERENCE_IMAGE_REQUIRED`	422	This model requires a reference image. Add an image or select a text-to-image model.
`INVALID_GENERATION_OPTIONS`	422	Generation options are invalid. Check the model capabilities.
`PROMPT_REQUIRED`	422	Provide a generation prompt.
`SCRIPT_TEXT_REQUIRED`	422	Provide script text before starting this operation.
`SCENES_REQUIRED`	422	Create scenes before starting this operation.
`VARIANT_NAME_REQUIRED`	422	Provide a variant name.
`EPISODE_ALREADY_STRUCTURED`	409	Episode already has shots. Review its existing structure.
`ONE_SCRIPT_PER_PROJECT`	409	This project supports one script. Use the existing script.
`MULTIPLE_SCRIPTS_REQUIRE_REVIEW`	409	Multiple scripts need review before continuing.
`NATIVE_CONTENT_ALREADY_EXISTS`	409	Studio content already exists. Review it before continuing.
`LIVE_PROJECT_REQUIRED`	409	This operation requires a live project.
`STUDIO_MIGRATION_REQUIRED`	409	Project needs Studio migration. Contact support.
`UNSUPPORTED_CAPABILITY`	422	Unsupported operation or profile. Check GET /capabilities.
`CAPABILITY_UNAVAILABLE`	503	Capability currently unavailable. Check GET /capabilities.
`API_NOT_ACCEPTING`	503	New requests are paused. Check service availability.
`DEPENDENCY_UNAVAILABLE`	503	A required service is unavailable. Follow the retry guidance or contact support.
`PRICING_UNAVAILABLE`	503	Pricing unavailable. A valid quote is required to proceed.
`MEDIA_TOOLS_UNAVAILABLE`	503	Media processing unavailable. Contact support.
`STORAGE_READ_FAILED`	503	Could not read the stored asset. Contact support with request_id.
`STORAGE_WRITE_FAILED`	503	Could not save the asset. Check the result before retrying.
`INTERNAL_ERROR`	500	Internal error. Follow retry guidance; include request_id when contacting support.
`RESPONSE_CONTRACT_VIOLATION`	500	Server response validation failed. Contact support with request_id.
`INVALID_EXECUTION_CONTEXT`	500	Execution context is invalid. Contact support.
`RETRY_TRANSACTION`	503	Transaction could not complete. Follow the response retry guidance.
`CLAIM_LOST`	409	Execution ownership changed. Check the current job state.
`PROVIDER_TIMEOUT`	504	Generation service timed out. Check the existing job before submitting again.
`PROVIDER_TERMINAL_FAILURE`	422	Generation failed. Review the job result and inputs.
`PROVIDER_RESULT_UNAVAILABLE`	502	Generation result unavailable. Check the existing job and recovery options.
`INVALID_RESULT`	422,503	Result failed validation. Review the job or contact support.
`RESULT_TOO_LARGE`	422	Result exceeds the processing limit. Reduce the requested output.
`EXPORT_TOO_LARGE`	422	Export exceeds the size limit. Reduce the export selection.
`RECOVERY_BACKOFF`	409	Existing result recovery is delayed. Check again later; do not resubmit generation.
`VIDEO_RECOVERY_REVIEW_REQUIRED`	503	The original video task needs scheduled recovery or operator review. Do not resubmit generation.
`RESULT_RECOVERY_REQUIRED`	409,503	Existing result needs recovery. Check the run recovery options before resubmitting.
`RESULT_NOT_RECOVERABLE`	409	Result cannot be recovered through this action. Review the run or contact support.
`RECOVERY_CAPACITY_EXCEEDED`	409	Recovery limit reached. Contact support before further recovery attempts.
`USAGE_RECOVERY_REQUIRED`	503	Usage needs reconciliation. Contact support; do not resubmit generation blindly.