FECINE OPEN API v1.1.0

Référence API

Du scénario au montage final, connectez votre production avec FECINE.

Authentification

Utilisez votre clé FECINE comme jeton Bearer. Aucun compte requis pour lire la documentation.

Créer et lancer

Créez une œuvre, importez les scénarios et les ressources, puis ajoutez personnages, décors, accessoires et grilles. Créez les épisodes et les scènes, associez les références et générez les vidéos. Sélectionnez une prise par scène, puis exportez le montage final. Attendez la fin de chaque génération et envoyez la dernière revision pour les modifications. Lancez séparément la construction pour structurer les scénarios importés.

Récupérer les résultats

Consultez le statut ou recevez un Webhook. Les identifiants des fichiers donnent accès aux liens de téléchargement signés.

Première requête

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

GET /api/v1/capabilities

REFERENCE

Référence API

FECINE API Key

Erreur FECINE. Communiquez request_id au support.

Copiez le JSON puis remplacez les identifiants, URL et contenus par vos valeurs.

Fonctionnalités

GET/api/v1/capabilitiesVoir ce qui est disponible maintenant

Renvoie les fonctions, modèles, formats de transfert et limites de production disponibles dans cet environnement API.

Permission requise: projects:read

Paramètres

Aucun paramètre

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

Réponse du serveur

Projets et ressources

GET/api/v1/worksVoir la liste de vos projets

Liste les projets accessibles. Filtrez par state et paginez avec cursor et limit.

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

cursor query limit query state query

Réponse du serveur

POST/api/v1/worksCréer un projet

Crée un projet avec le name fourni. Utilisez son ID pour ajouter des ressources et lancer la production.

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`name`	string	*	Minimum length: 1 characters Maximum length: 80 characters
`client_reference`	string	—	Maximum length: 128 characters

Première requête · JSON

{
  "name": "example"
}

Réponses

HTTP 201 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{project_id}Voir les infos d’un projet

Renvoie le nom, l’état et la revision du projet, à consulter avant une modification ou une demande de production.

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

project_id path *

Réponse du serveur

PATCH/api/v1/works/{project_id}Modifier les infos d’un projet

Modifie le nom ou l’état active/archived du projet. Envoyez le dernier ETag dans If-Match.

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`If-Match`header	string	*	Utilisez le dernier ETag, guillemets compris.

Corps de la requête

Nom	Type	Requis	Description
`name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`state`	string	—	Allowed values: active, archived

Première requête · JSON

{}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

project_id path *If-Match header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{project_id}/resourcesVoir les éléments déjà envoyés

Liste les scénarios, personnages, scènes, accessoires, épisodes et plans du projet. Sélectionnez le type avec kind.

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

project_id path *cursor query limit query kind query

Réponse du serveur

POST/api/v1/works/{project_id}/resourcesAjouter des éléments (scénario, images…)

Ajoute une ressource structurée via kind et data, par exemple un scénario ou un plan. Transférez les fichiers via /uploads.

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`kind`	string	*	kind = script Fixed value: script
`name`	string	*	kind = script Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = scriptFournissez uniquement text ou 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

Première requête · JSON

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

Réponses

HTTP 201 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

project_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{project_id}/resources/{resource_id}Voir un élément

Renvoie le type, le contenu et la revision de la ressource désignée par resource_id dans le projet.

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`resource_id`path	string	*	Format: UUID

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

project_id path *resource_id path *

Réponse du serveur

PATCH/api/v1/works/{project_id}/resources/{resource_id}Modifier un élément

Met à jour kind et data. Envoyez le dernier ETag dans If-Match pour éviter les conflits de modification.

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`resource_id`path	string	*	Format: UUID
`If-Match`header	string	*	Utilisez le dernier ETag, guillemets compris.

Corps de la requête

Nom	Type	Requis	Description
`kind`	string	*	kind = script Fixed value: script
`name`	string	*	kind = script Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = scriptFournissez uniquement text ou 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

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

project_id path *resource_id path *If-Match header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{project_id}/workflowConsulter la production Studio

Renvoie ensemble le scénario, les épisodes, designs, scènes, assets, prises, sélections de montage et la dernière revision.

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID

Réponses

HTTP 200 Succès

Première requête · 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
      }
    ]
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

project_id path *

Réponse du serveur

POST/api/v1/works/{project_id}/script/analysesAnalyser le scénario Studio

Analyse le scénario pour en extraire la structure de production. Fournissez script_text pour le mettre à jour, sinon le scénario enregistré est utilisé. Suivez le job avec getJob.

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*
`model`	string	—	Minimum length: 1 characters Maximum length: 200 characters
`script_text`	string	—	Minimum length: 1 characters Maximum length: 5000000 characters

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

project_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{project_id}/script/buildsConstruire la production depuis le scénario

Envoyez script_asset_ids validés et revision pour créer le scénario, les références et le storyboard. full_rebuild remplace la structure existante. Générez les images et vidéos séparément. Les jetons d’entrée et de sortie déclarés sont facturés aux mêmes tarifs que Studio. Aucun budget de crédits par requête n’est requis. GET /jobs/{job_id} → output_asset_ids.

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · JSON

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

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

project_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{project_id}/libraryConsulter la bibliothèque partagée

Liste les assets importables. scope=personal consulte votre bibliothèque ; scope=studio, par défaut, consulte la bibliothèque partagée.

Permission requise: assets:read

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`limit`	integer	—	Minimum: 1 Maximum: 100
`cursor`	string	—
`scope`	string	—	Allowed values: studio, personal

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

project_id path *limit cursor scope

Réponse du serveur

POST/api/v1/works/{project_id}/importsImporter une ressource dans un projet

Copie l’asset indiqué par asset_id depuis une bibliothèque personnelle ou partagée dans le projet. Les changements ultérieurs de la source n’affectent pas la copie.

Permission requise: assets:write, assets:read, projects:write

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*
`asset_id`	string	*	Format: UUID

Première requête · JSON

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

Réponses

HTTP 201 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

project_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{project_id}/script/draftsGénérer un brouillon de scénario

Envoyez instructions, source_text facultatif, revision et max_output_tokens. Enregistre un nouveau scénario sans remplacer l’existant. Les jetons d’entrée et de sortie déclarés sont facturés aux mêmes tarifs que Studio. Aucun budget de crédits par requête n’est requis. GET /jobs/{job_id} → output_asset_ids.

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · JSON

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

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

project_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/charactersPersonnage · Consulter (list)

Personnage · Consulter (list). GET /api/v1/works/{work_id}/characters. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *cursor query limit query

Réponse du serveur

POST/api/v1/works/{work_id}/charactersPersonnage · Créer

Personnage · Créer. POST /api/v1/works/{work_id}/characters. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/characters/{reference_id}Personnage · Consulter

Personnage · Consulter. GET /api/v1/works/{work_id}/characters/{reference_id}. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *cursor query limit query

Réponse du serveur

PATCH/api/v1/works/{work_id}/characters/{reference_id}Personnage · Modifier

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

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

DELETE/api/v1/works/{work_id}/characters/{reference_id}Personnage · Supprimer

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

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/works/{work_id}/characters/{reference_id}/primary-imagePersonnage · Définir l’image de référence

Personnage · Définir l’image de référence. PUT /api/v1/works/{work_id}/characters/{reference_id}/primary-image. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`asset_id`	string	*	Format: UUID
`current_asset_id`	oneOf	*
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{work_id}/characters/{reference_id}/image-generationsPersonnage · Générer l’image de référence

Personnage · Générer l’image de référence. POST /api/v1/works/{work_id}/characters/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}Personnage · Associer à la scène

Personnage · Associer à la scène. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}Personnage · Dissocier de la scène

Personnage · Dissocier de la scène. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/background-scenesDécor · Consulter (list)

Décor · Consulter (list). GET /api/v1/works/{work_id}/background-scenes. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *cursor query limit query

Réponse du serveur

POST/api/v1/works/{work_id}/background-scenesDécor · Créer

Décor · Créer. POST /api/v1/works/{work_id}/background-scenes. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/background-scenes/{reference_id}Décor · Consulter

Décor · Consulter. GET /api/v1/works/{work_id}/background-scenes/{reference_id}. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *cursor query limit query

Réponse du serveur

PATCH/api/v1/works/{work_id}/background-scenes/{reference_id}Décor · Modifier

Décor · Modifier. PATCH /api/v1/works/{work_id}/background-scenes/{reference_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

DELETE/api/v1/works/{work_id}/background-scenes/{reference_id}Décor · Supprimer

Décor · Supprimer. DELETE /api/v1/works/{work_id}/background-scenes/{reference_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/works/{work_id}/background-scenes/{reference_id}/primary-imageDécor · Définir l’image de référence

Décor · Définir l’image de référence. PUT /api/v1/works/{work_id}/background-scenes/{reference_id}/primary-image. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`asset_id`	string	*	Format: UUID
`current_asset_id`	oneOf	*
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{work_id}/background-scenes/{reference_id}/image-generationsDécor · Générer l’image de référence

Décor · Générer l’image de référence. POST /api/v1/works/{work_id}/background-scenes/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}Décor · Associer à la scène

Décor · Associer à la scène. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}Décor · Dissocier de la scène

Décor · Dissocier de la scène. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/propsAccessoire · Consulter (list)

Accessoire · Consulter (list). GET /api/v1/works/{work_id}/props. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *cursor query limit query

Réponse du serveur

POST/api/v1/works/{work_id}/propsAccessoire · Créer

Accessoire · Créer. POST /api/v1/works/{work_id}/props. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/props/{reference_id}Accessoire · Consulter

Accessoire · Consulter. GET /api/v1/works/{work_id}/props/{reference_id}. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *cursor query limit query

Réponse du serveur

PATCH/api/v1/works/{work_id}/props/{reference_id}Accessoire · Modifier

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

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

DELETE/api/v1/works/{work_id}/props/{reference_id}Accessoire · Supprimer

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

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/works/{work_id}/props/{reference_id}/primary-imageAccessoire · Définir l’image de référence

Accessoire · Définir l’image de référence. PUT /api/v1/works/{work_id}/props/{reference_id}/primary-image. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`asset_id`	string	*	Format: UUID
`current_asset_id`	oneOf	*
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{work_id}/props/{reference_id}/image-generationsAccessoire · Générer l’image de référence

Accessoire · Générer l’image de référence. POST /api/v1/works/{work_id}/props/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}Accessoire · Associer à la scène

Accessoire · Associer à la scène. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}Accessoire · Dissocier de la scène

Accessoire · Dissocier de la scène. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/gridsGrille · Consulter (list)

Grille · Consulter (list). GET /api/v1/works/{work_id}/grids. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *cursor query limit query

Réponse du serveur

POST/api/v1/works/{work_id}/gridsGrille · Créer

Grille · Créer. POST /api/v1/works/{work_id}/grids. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/grids/{reference_id}Grille · Consulter

Grille · Consulter. GET /api/v1/works/{work_id}/grids/{reference_id}. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *cursor query limit query

Réponse du serveur

PATCH/api/v1/works/{work_id}/grids/{reference_id}Grille · Modifier

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

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

DELETE/api/v1/works/{work_id}/grids/{reference_id}Grille · Supprimer

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

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/works/{work_id}/grids/{reference_id}/primary-imageGrille · Définir l’image de référence

Grille · Définir l’image de référence. PUT /api/v1/works/{work_id}/grids/{reference_id}/primary-image. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`asset_id`	string	*	Format: UUID
`current_asset_id`	oneOf	*
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{work_id}/grids/{reference_id}/image-generationsGrille · Générer l’image de référence

Grille · Générer l’image de référence. POST /api/v1/works/{work_id}/grids/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

work_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}Grille · Associer à la scène

Grille · Associer à la scène. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}Grille · Dissocier de la scène

Grille · Dissocier de la scène. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *scene_id path *reference_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/episodesÉpisode · Consulter (list)

Épisode · Consulter (list). GET /api/v1/works/{work_id}/episodes. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *cursor query limit query

Réponse du serveur

POST/api/v1/works/{work_id}/episodesCréer un épisode

Créer un épisode. POST /api/v1/works/{work_id}/episodes. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/episodes/{episode_id}Épisode · Consulter

Épisode · Consulter. GET /api/v1/works/{work_id}/episodes/{episode_id}. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · JSON

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

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *episode_id path *cursor query limit query

Réponse du serveur

PATCH/api/v1/works/{work_id}/episodes/{episode_id}Épisode · Modifier

Épisode · Modifier. PATCH /api/v1/works/{work_id}/episodes/{episode_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *episode_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

DELETE/api/v1/works/{work_id}/episodes/{episode_id}Épisode · Supprimer

Épisode · Supprimer. DELETE /api/v1/works/{work_id}/episodes/{episode_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *episode_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/episodes/{episode_id}/scenesScène · Consulter (list)

Scène · Consulter (list). GET /api/v1/works/{work_id}/episodes/{episode_id}/scenes. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *episode_id path *cursor query limit query

Réponse du serveur

POST/api/v1/works/{work_id}/episodes/{episode_id}/scenesCréer une scène

Créer une scène. POST /api/v1/works/{work_id}/episodes/{episode_id}/scenes. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`heading`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`number`	integer	—
`description`	string	—	Maximum length: 4000 characters
`video_prompt`	oneOf	—
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *episode_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}Scène · Consulter

Scène · Consulter. GET /api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}. GET

Permission requise: projects:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

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

Réponse du serveur

PATCH/api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}Scène · Modifier

Scène · Modifier. PATCH /api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`heading`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`number`	integer	—
`description`	string	—	Maximum length: 4000 characters
`video_prompt`	oneOf	—
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *episode_id path *scene_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{work_id}/archive-importsImporter une archive ZIP

Importer une archive 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}

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*
`asset_id`	string	*	Format: UUID

Première requête · JSON

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

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

work_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

GET/api/v1/works/{work_id}/archive-imports/{import_id}Consulter une importation ZIP

Consulter une importation 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

Permission requise: jobs:read

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`import_id`path	string	*	Format: UUID

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *import_id path *

Réponse du serveur

POST/api/v1/works/{work_id}/uploadsPréparer un lot de fichiers

Préparer un lot de fichiers. POST /api/v1/works/{work_id}/uploads. Idempotency-Key + files (1–20) → PUT upload_url → POST /api/v1/uploads/{upload_id}/complete

Permission requise: assets:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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	*

Première requête · JSON

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

Réponses

HTTP 201 Succès

Première requête · 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"
        }
      }
    ]
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

DELETE/api/v1/works/{work_id}/scenes/{scene_id}Scène · Supprimer

Scène · Supprimer. DELETE /api/v1/works/{work_id}/scenes/{scene_id}. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *scene_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/works/{work_id}/episodes/{episode_id}/scene-orderRéordonner les scènes

Réordonner les scènes. PUT /api/v1/works/{work_id}/episodes/{episode_id}/scene-order. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`scene_ids`	array	*	Maximum items: 500 items
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *episode_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/works/{work_id}/scriptEnregistrer le scénario

Enregistrer le scénario. PUT /api/v1/works/{work_id}/script. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`text`	string	*	Maximum length: 5000000 characters
`revision`	integer	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{work_id}/scenes/{scene_id}/video-generationsGénérer la vidéo de scène

Générer la vidéo de scène. POST /api/v1/works/{work_id}/scenes/{scene_id}/video-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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	—

Première requête · JSON

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

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

work_id path *scene_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/works/{work_id}/scenes/{scene_id}/selected-takeChoisir la prise finale

Choisir la prise finale. PUT /api/v1/works/{work_id}/scenes/{scene_id}/selected-take. revision + Idempotency-Key

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`revision`	integer	*
`take_id`	oneOf	*

Première requête · JSON

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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

work_id path *scene_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{work_id}/exportsExporter la vidéo finale

Exporter la vidéo finale. POST /api/v1/works/{work_id}/exports. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

work_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

API de compatibilit?

POST/api/v1/works/{project_id}/plansVoir le plan et les crédits prévus

Voyez ce qui sera produit et combien de crédits cela coûtera, sans lancer la production.

Permission requise: runs:write

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`template_id`	string	*	Fixed value: episode-production
`template_version`	number	*	Fixed value: 1
`project_revision`	integer	*
`episode_ids`	array	*	Les identifiants des épisodes doivent être uniques. Maximum items: 10 items
`mode`	string	*	Allowed values: reviewed, automatic
`output_profile`	string	*	Allowed values: sandbox-episode-v1, episode-standard-v1

Première requête · 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"
}

Réponses

HTTP 201 Succès

Première requête · 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"
    ]
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

project_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{project_id}/runsLancer la production

Lance la production depuis un plan_id existant et renvoie un ID d’exécution. Suivez l’état et les résultats avec getRun.

Permission requise: runs:write

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`plan_id`	string	*	Format: UUID
`client_reference`	string	—	Maximum length: 128 characters

Première requête · JSON

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

Réponses

HTTP 202 Succès

Première requête · 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"
    ]
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

project_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{project_id}/workflow/commandsModifier la production Studio

Modifie les données de production : scénario, scènes, designs ou prises sélectionnées. Choisissez operation et envoyez input avec la dernière revision.

Permission requise: projects:write

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · 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"
  }
}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

project_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{project_id}/cut/exportsExporter le montage Studio

Assemble les vidéos dans l’ordre des épisodes et scènes. selections choisit les prises ; allow_partial autorise les scènes manquantes. Suivez l’export avec getJob.

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · JSON

{
  "revision": 1
}

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

project_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{project_id}/storyboard/videosGénérer la vidéo d’une scène

Génère une prise vidéo pour scene_id avec le modèle, la durée et la résolution choisis. anchor_asset_id définit l’image initiale. Suivez le job avec getJob.

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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	—

Première requête · JSON

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

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

project_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/works/{project_id}/designs/imagesGénérer une image de personnage, de décor, d’accessoire ou de grille

Génère une à quatre images pour design_id avec un prompt et des références facultatives. Choisissez l’image principale ou une variante, puis suivez getJob.

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · JSON

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

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

project_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

Envois

POST/api/v1/uploadsObtenir une adresse pour envoyer un fichier

Enregistre les métadonnées et renvoie upload_url. Envoyez le fichier par PUT, puis confirmez la fin du transfert. Formats : TXT, Markdown, DOCX, PNG, JPEG, WebP, AVIF, WAV et ZIP. Les limites partagent les paramètres de Studio : consultez upload_limits dans GET /capabilities. Scénarios : 5 000 000 caractères maximum. Aucun séparateur de chemin dans le nom. WAV en PCM ou IEEE float.

Permission requise: assets:write

Paramètres

Nom	Type	Requis	Description
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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	*

Première requête · JSON

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

Réponses

HTTP 201 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

POST/api/v1/uploads/{upload_id}/completeSignaler que le fichier est bien envoyé

Vérifie le fichier transféré par rapport aux métadonnées déclarées et renvoie l’asset utilisable en production.

Permission requise: assets:write

Paramètres

Nom	Type	Requis	Description
`upload_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Première requête · JSON

{}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

upload_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PUT/api/v1/uploads/{upload_id}/contentEnvoyer le contenu du fichier

Envoie les octets du fichier en application/octet-stream pour un transfert préparé. Appelez completeUpload après l’envoi.

Permission requise: assets:write

Paramètres

Nom	Type	Requis	Description
`upload_id`path	string	*	Format: UUID

Réponses

HTTP 200 Succès

Première requête · JSON

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

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

upload_id path * application/octet-stream

Réponse du serveur

Fichiers et résultats

GET/api/v1/assets/{asset_id}Voir un résultat et son lien de téléchargement

Renvoie les métadonnées et, si disponible, un download_url signé. Téléchargez le fichier avant son expiration.

Permission requise: assets:read

Paramètres

Nom	Type	Requis	Description
`asset_id`path	string	*	Format: UUID

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

asset_id path *

Réponse du serveur

GET/api/v1/downloads/{asset_id}Télécharger le fichier terminé

Télécharge le fichier via le download_url signé complet renvoyé par getAsset. Le lien expire après cinq minutes.

Paramètres

Nom	Type	Requis	Description
`asset_id`path	string	*	Format: UUID
`expires`query	string	*
`signature`query	string	*

Réponses

HTTP 200 Octets du fichier

application/octet-stream · Octets du fichier

Réponses d’erreur · error.code ↗

Essayer

asset_id path *expires query *signature query *

Réponse du serveur

Exécutions

GET/api/v1/runsVoir la liste des productions

Liste les exécutions avec des filtres par projet, état, client_reference et période.

Permission requise: runs:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

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

Réponse du serveur

GET/api/v1/runs/{run_id}Voir l’avancement d’une production

Renvoie l’état, la version et les résultats disponibles d’une exécution. Utilisez cette version pour soumettre une décision.

Permission requise: runs:read

Paramètres

Nom	Type	Requis	Description
`run_id`path	string	*	Format: UUID

Réponses

HTTP 200 Succès

Première requête · 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"
    ]
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

run_id path *

Réponse du serveur

GET/api/v1/runs/{run_id}/stepsVoir l’avancement étape par étape

Liste les étapes d’une exécution pour identifier celles en attente, en cours ou terminées.

Permission requise: runs:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

run_id path *cursor query limit query

Réponse du serveur

GET/api/v1/runs/{run_id}/eventsVoir ce qui s’est passé pendant la production

Liste les événements, tels que changements d’état et demandes de validation, pour retracer la production.

Permission requise: runs:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

run_id path *cursor query limit query

Réponse du serveur

POST/api/v1/runs/{run_id}/decisionsValider la suite ou arrêter

Soumet une décision : approve, stop, resume, cancel_remaining ou retry_result. Envoyez la dernière version dans expected_version. retry_result reprend uniquement la consultation du résultat vidéo enregistré. Fournissez expected_version à jour et step_id. Le travail et la réservation sont conservés, sans nouvelle génération. Limite : 24 heures après admission. Les autres résultats ou usages incertains nécessitent une vérification opérateur.

Permission requise: runs:write

Paramètres

Nom	Type	Requis	Description
`run_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · JSON

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

Réponses

HTTP 202 Succès

Première requête · 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"
    ]
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

run_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

Fonctions du workflow

GET/api/v1/jobs/{job_id}Voir l’état et le résultat d’une tâche

Renvoie l’état du job et les ID des assets produits. Après achèvement, utilisez getAsset pour récupérer les fichiers.

Permission requise: jobs:read

Paramètres

Nom	Type	Requis	Description
`job_id`path	string	*	Format: UUID

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

job_id path *

Réponse du serveur

GET/api/v1/jobs/{job_id}/buildConsulter la progression et les sources

Renvoie l’étape, les messages de progression et les sources d’une construction de scénario, avec le texte préparé pour le traitement.

Permission requise: jobs:read, assets:read

Paramètres

Nom	Type	Requis	Description
`job_id`path	string	*	Format: UUID

Réponses

HTTP 200 Succès

Première requête · 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
      }
    ]
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

job_id path *

Réponse du serveur

API de compatibilit?

POST/api/v1/jobsLancer une seule fonction tout de suite

Exécutez une seule fonction au lieu de toute la production. analyze_script lit le scénario et crée les plans, generate_image crée les images de personnages, décors, accessoires et plans, generate_video crée la vidéo d’un plan dont vous avez choisi l’image, et assemble_video assemble un épisode dont tous les plans ont une vidéo. Envoyez toujours la dernière revision du projet. Une requête Live réserve les crédits à l’avance.

Permission requise: jobs:create

Paramètres

Nom	Type	Requis	Description
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`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

Première requête · JSON

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

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

Journaux

GET/api/v1/requestsVoir les requêtes que vous avez envoyées

Liste les appels API avec statut HTTP et durée. Filtrez par projet et période pour examiner les requêtes.

Permission requise: requests:read

Paramètres

Nom	Type	Requis	Description
`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

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

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

Réponse du serveur

GET/api/v1/requests/{request_id}Voir une requête envoyée

Retrouve un appel par request_id avec son statut HTTP, sa durée et l’exécution ou le job associé.

Permission requise: requests:read

Paramètres

Nom	Type	Requis	Description
`request_id`path	string	*	Format: UUID

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

request_id path *

Réponse du serveur

Consommation

GET/api/v1/usageVoir votre consommation de crédits

Renvoie les totaux d’utilisation sur la période demandée, avec les montants réservés et facturés.

Permission requise: usage:read

Paramètres

Aucun paramètre

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

Réponse du serveur

Webhooks

GET/api/v1/webhook-endpointsVoir vos adresses de notification Webhook

Liste les URL Webhook enregistrées, les événements suivis et leur état d’activation.

Permission requise: webhooks:read

Paramètres

Nom	Type	Requis	Description
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

cursor query limit query

Réponse du serveur

POST/api/v1/webhook-endpointsAjouter une adresse Webhook

Enregistre une URL Webhook pour recevoir les événements de production sélectionnés pour les projets indiqués.

Permission requise: webhooks:write

Paramètres

Nom	Type	Requis	Description
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Nom	Type	Requis	Description
`url`	string	*	Format: uri Maximum length: 2000 characters
`project_ids`	array	*	Maximum items: 100 items
`events`	array	*	Maximum items: 4 items

Première requête · JSON

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

Réponses

HTTP 201 Succès

Première requête · 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"
    }
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

PATCH/api/v1/webhook-endpoints/{endpoint_id}Modifier une adresse Webhook

Active ou désactive un Webhook, ou modifie les événements reçus.

Permission requise: webhooks:write

Paramètres

Nom	Type	Requis	Description
`endpoint_id`path	string	*	Format: UUID
`If-Match`header	string	*	Utilisez le dernier ETag, guillemets compris.

Corps de la requête

Nom	Type	Requis	Description
`enabled`	boolean	—
`events`	array	—	Maximum items: 4 items

Première requête · JSON

{}

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

endpoint_id path *If-Match header * Corps de la requête application/json

Réponse du serveur

Livraisons Webhook

GET/api/v1/webhook-deliveriesVoir les envois Webhook effectués

Liste les tentatives de livraison Webhook et leur état pour vérifier la réception des notifications.

Permission requise: webhooks:read

Paramètres

Nom	Type	Requis	Description
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

Réponses

HTTP 200 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag

Réponses d’erreur · error.code ↗

Essayer

cursor query limit query

Réponse du serveur

POST/api/v1/webhook-deliveries/{delivery_id}/redeliverRenvoyer un Webhook

Demande une nouvelle livraison de la notification Webhook désignée par delivery_id.

Permission requise: webhooks:write

Paramètres

Nom	Type	Requis	Description
`delivery_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	Réessayez avec la même Idempotency-Key et le même corps. Minimum length: 16 characters Maximum length: 128 characters

Corps de la requête

Première requête · JSON

{}

Réponses

HTTP 202 Succès

Première requête · 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"
  }
}

En-têtes de réponse: X-Request-Id · ETag · Retry-After

Réponses d’erreur · error.code ↗

Essayer

delivery_id path *Idempotency-Key header * Corps de la requête application/json

Réponse du serveur

Spécification

GET/api/v1/openapi.jsonTélécharger la spécification de l’API

Télécharge la spécification OpenAPI avec les chemins, champs de requête et schémas de réponse.

Paramètres

Aucun paramètre

Réponses

HTTP 200 Document OpenAPI

Première requête · JSON

{}

Essayer

Réponse du serveur

Réponses d’erreur · error.code 71

Une réponse 2xx signifie que la requête est bien passée. 201 veut dire qu’une ressource a été créée, 202 que la demande est acceptée et encore en cours : il n’y a pas encore de résultat, consultez l’état du job pour savoir quand c’est terminé. Les réponses réussies contiennent request_id et data. Seuls le téléchargement de fichiers et la spécification de l’API font exception. En cas d’échec, tous les endpoints renvoient le même objet error. Faites vos conditions sur error.code ; message explique la cause et la marche à suivre pour une personne. C’est retryable qui dit si vous pouvez renvoyer la requête. Ne réessayez automatiquement que s’il vaut true, et attendez le délai indiqué par retry_after_seconds ou l’en-tête Retry-After. Pour réessayer un POST, renvoyez la même Idempotency-Key et le même corps afin de ne rien facturer ni créer deux fois. Si un error.code vous est inconnu, traitez-le à partir du statut HTTP et de retryable. Indiquez request_id lorsque vous contactez le support. Les échecs survenus après l’acceptation d’un job apparaissent dans son état et son résultat, pas dans cette réponse.

{
  "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	Description
`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.