Skip to navigation

API · Projects · Create a project of a type (Project or AdCreativeProject)

View as Markdown

Create a project of the given resourcetype. title is the common field; type-specific fields go under data (varies by resourcetype — inspect a getProject response for the target type to see its shape). Returns the new project’s UUID, used for createProjectItem, listProjectItems, etc.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

resourcetypeenumRequired

Project type selector (the model name). The API is polymorphic — the same URL structure serves different project types based on this value. Valid values:

  • Project — generic projects (the default for most content).
  • AdCreativeProject — ad-creative projects (specialized fields). Use the same value on create, get, list, and delete for a given project.
Allowed values:

Request

This endpoint expects an object.
titlestringOptional

Project title (defaults to "Untitled Project" if omitted)

descriptionstringOptional
Optional project description
primary_typestringOptional

Free-form project category string. Known values include: ad, SMQuotes, AIAvatarVideo, AiProductVideos, UGCVideo, ImageYTThumb, campaign, blog, or any custom type.

datamap from strings to anyOptional

Flexible JSON data for this project. Has a base schema with flags (Dict[str,bool]) but accepts any additional fields. Used to store project-specific config like campaign settings, prompts, image params, etc.

Response

Project created

Errors

400
Bad Request Error
401
Unauthorized Error