Skip to main content

Create a project


Start a new project. The agent begins working immediately.

Request body

References

Each reference is either an uploaded file or a URL:
Reference types: image, video, audio, url. Max 10 references per request, max 3 URL references.

Response 202

Example

If you include an idempotency_key and a non-failed project already exists for that key, the endpoint returns 200 with a different response shape:

Adopt a project


Adopt an existing studio project for API management.

Request body

Response 201

Returned when the project is newly adopted.

Response 200

Returned when the project has already been adopted.

List projects


Response 200

The brief field is truncated to 200 characters in list responses. The source_project_id field indicates the original studio project when a project was adopted via the API.

Get project status


Returns the current status, agent message, and output URLs.

Response 200

Update project settings


Update project configuration. Blocked while the agent is actively running (running, generating, rendering).

Request body

All fields are optional. Only include fields you want to change.

Response 200

Cancel a project


Stop the agent. Valid when status is queued, running, generating, or idle. Generations already in progress at the provider level will still complete, but the agent won’t continue to the next step.

Response 200

Send a message


Send feedback or direction to the agent. Valid when the project is idle, completed, cancelled, or failed. Returns 400 if the agent is still actively working (running, generating, rendering). Requires at least 10 credits.

Request body

Response 202

The agent resumes work with your feedback.

Example

Get messages


Retrieve conversation history.

Response 200

Use the after cursor for efficient polling. Store the last message ID you’ve seen and pass it as ?after=msg_002 to get only new messages.