Projects API

Create Project

Create a project to group related generations and assets. Pass the returned id as projectId on POST /v2/generate or POST /v2/assets to file them under this project so they show up together in Studio. Only name is required — visibility defaults to USER and mode to CREATOR.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
namestringRequired
A name for the project.
descriptionstringOptional
An optional description for the project.
visibilityenumOptional

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

modeenumOptional
The project mode. Defaults to CREATOR.

Response

Project created successfully
idstring
A unique identifier for a project.
createdAtdatetime
The date and time the project was created.
updatedAtdatetime
The date and time the project was last updated.
visibilityenum
Who can see the project.
modeenum
The project mode.
namestring
The display name of the project.
descriptionstring
An optional description of the project.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error