Sign in

v3

latestOpenAPI 3.1.02026-07-313340106.6 KB
Projects

Create a project

Creates a project and returns its id. Pass that id as projectId on POST /v2/generate or POST /v2/assets to group generations and assets under it in Studio. Supply your own id for idempotent creation: re-sending the same id returns the existing project (also as 201, indistinguishable from a fresh create) instead of creating a duplicate. On such a replay the other request fields are ignored; the first successful create wins.

post/v2/projects

Request body

idstring uuid

Optional client-supplied project id (UUID) for idempotent creation. Re-sending the same id returns the existing project instead of creating a duplicate; the other request fields are ignored on such a replay. If the id is already used by a different user or organization, or by a deleted project, the request fails with 409.

namestring required
descriptionstring
visibility'USER' | 'ORGANIZATION'

Who can see the project. Defaults to USER (visible only to the owner).

mode'CREATOR' | 'DEVELOPER'

Project mode. Defaults to CREATOR.

defaultWorkflow'lipsync' | 'translate_and_dub' | 'change_appearance' | 'image_to_video' | 'edit_dialogue' | 'assistant' | 'timeline'

Default top-level creator workflow for this project.

Response

Project created successfully, or the existing project when the supplied id was already created by the same user

idstring required
createdAtstring date-time required
updatedAtstring date-time required
organizationIdstring required
userIdstring nullable required
namestring nullable required
descriptionstring nullable required
visibility'USER' | 'ORGANIZATION' required
deletedAtstring date-time nullable required
mode'CREATOR' | 'DEVELOPER' required
defaultWorkflow'lipsync' | 'translate_and_dub' | 'change_appearance' | 'image_to_video' | 'edit_dialogue' | 'assistant' | 'timeline' | 'null' nullable