All endpoints

Methods and paths by group. Platform admin routes are hidden.

Session

get /v1/me

Current identity and permissions

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/system/status

Read active notices and feature availability for your organization

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/system/capabilities

Current organization model configuration and feature availability

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

Models

get /v1/models

Available models and capability contracts

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/models/{code}/price

Model sale price

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
codepathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/models/{code}

Model details

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
codepathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/quotes

Get a quote without charging

Validate parameters against the model contract and calculate the sale price without charging or creating a job. Uses the same body as POST /v1/generations.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
project_idbodyanyOfOptional
model_codebodystringRequired
promptbodystringOptional
negative_promptbodystringOptional
paramsbodyobjectOptional
referencesbodyobject[]Optional
countbodyintegerOptional
sourcebodystudio|canvas|editor|api|pipeline|mcp|shotsOptional
idempotency_keybodystringOptional
expected_quotebodyobjectOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

Projects

post /v1/organization-invite-links/access/preview

Preview an invitation link (account session)

Requires a fresh account session, a trusted Origin and the expected user identity. API keys are not accepted. The token is read from the JSON body and never cached.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
OriginheaderstringRequired
x-lashot-expected-user-idheaderstringRequired
tokenbodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/organization-invite-links/access/receipt

Check the original invitation acceptance (account session)

Requires a fresh account session, a trusted Origin and the expected user identity. API keys are not accepted. The token is read from the JSON body and never cached.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
OriginheaderstringRequired
x-lashot-expected-user-idheaderstringRequired
tokenbodystringRequired
expected_org_idbodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/organization-invite-links/access/accept

Confirm joining the invited organization (account session)

Requires a fresh account session, a trusted Origin and the expected user identity. API keys are not accepted. The token is read from the JSON body and never cached.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
OriginheaderstringRequired
x-lashot-expected-user-idheaderstringRequired
tokenbodystringRequired
expected_org_idbodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/organization-invite-links/access/enter

Enter an organization you have joined (account session)

Requires a fresh account session, a trusted Origin and the expected user identity. API keys are not accepted. The token is read from the JSON body and never cached.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
OriginheaderstringRequired
x-lashot-expected-user-idheaderstringRequired
tokenbodystringRequired
expected_org_idbodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/organization-invite-links

List organization invitation links (admin session)

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/organization-invite-links

Create an organization invitation link (admin session)

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
create_request_idbodystringRequired
max_usesbodyintegerOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/organization-invite-links/{id}/copy

Copy an organization invitation link (admin session)

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/organization-invite-links/{id}/revoke

Revoke an organization invitation link (admin session)

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/members

List project member permissions

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/member-candidates

List eligible organization members

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

put /v1/projects/{id}/members/{userId}

Grant project member access

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
userIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
access_revisionbodystringRequired
idempotency_keybodystringRequired
permissionbodyread|write|adminRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

delete /v1/projects/{id}/members/{userId}

Revoke project member access

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
userIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
access_revisionbodystringRequired
idempotency_keybodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects

List projects

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
include_archivedquerytrue|falseOptional
limitqueryintegerOptional
cursorquerystringOptionalThe previous page's next_cursor

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects

Create a project

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringRequired
kindbodygeneral|drama|commerce|quickcutOptional
aspect_ratiobody16:9|9:16|1:1|4:3|3:4|21:9Optional
style_presetbodystringOptional
settingsbodyobjectOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}

Project and asset statistics

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/projects/{id}

Update a project using revision

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringOptional
kindbodygeneral|drama|commerce|quickcutOptional
aspect_ratiobody16:9|9:16|1:1|4:3|3:4|21:9Optional
style_presetbodyanyOfOptional
cover_asset_idbodyanyOfOptional
settingsbodyobjectOptional
revisionbodyintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

delete /v1/projects/{id}

Trash a project for 30 days

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
204Success, no response body
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/archive

Archive a project

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/restore

Restore an archived project

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/package/export

Export workspace documents and exact media

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/project-packages/inspect

Validate and inspect a workspace package

Raw application/zip body; maximum 256 MiB.

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/project-packages/import

Import workspace package as a new project

Raw application/zip body. X-Import-Key must be a stable UUID; optional X-Project-Name is URL-encoded. Always creates a new project and never overwrites another project.

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/batches

List project batches

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/batches

Create a batch draft

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
idpathstringRequired
namebodystringRequired
csvbodystringOptional
databodyobject[]Optional
mappingbodyobjectOptional
concurrencybodyintegerOptional
template_version_idbodystringOptional
template_idbodystringOptional
idempotency_keybodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/batches/{id}

Read batch and row progress

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/batches/{id}/mapping

Update draft column mapping

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
idpathstringRequired
model_codebodystringOptional
model_columnbodystringOptional
prompt_templatebodystringOptional
variablesbodyobjectOptional
paramsbodyobjectOptional
parameter_columnsbodyobjectOptional
dependency_columnbodystringOptional
dependency_rolebodyimage|first_frame|last_frame|style|subject|mask|control|audio|video|person|top_garment|bottom_garmentOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/batches/{id}/precheck

Validate and quote without reserving funds

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/batches/{id}/start

Start the reviewed batch

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
idpathstringRequired
digestbodystringRequired

Responses

StatusNotes
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/batches/{id}/cancel

Cancel pending rows and request child cancellation

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/batches/{id}/retry

Prepare failed or cancelled rows for precheck

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
idpathstringRequired
rowsbodyinteger[]Optional
correctionsbodyobject[]Optional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/batches/{id}/errors.csv

Download error rows as CSV

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

Documents

get /v1/projects/{id}/drama-plans

List whole-drama planning editions

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
413Payload too large
429Rate limited; honor Retry-After
500Internal server error
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/projects/{id}/drama-plans

Save source and create a drama plan

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
keybodystringRequired
sourcebodyobjectRequired
contentbodyobjectRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
413Payload too large
429Rate limited; honor Retry-After
500Internal server error
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/projects/{id}/drama-plans/import

Extract script text from a document

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringRequired
bytesbodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
413Payload too large
429Rate limited; honor Retry-After
500Internal server error
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

get /v1/drama-plans/{id}

Read a drama plan and revisions

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
413Payload too large
429Rate limited; honor Retry-After
500Internal server error
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

patch /v1/drama-plans/{id}

Save a plan with revision checks

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerRequired
contentbodyobjectRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
413Payload too large
429Rate limited; honor Retry-After
500Internal server error
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/drama-plans/{id}/publish

Create production episodes from a plan

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
413Payload too large
429Rate limited; honor Retry-After
500Internal server error
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/drama-plans/{id}/quote

Quote a model planning operation

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
keybodystringRequired
revisionbodyintegerRequired
operationbodyoutline|divide|episode|scriptRequired
targetbodystringOptional
instructionbodystringOptional
modelbodystringRequired
paramsbodyobjectOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
413Payload too large
429Rate limited; honor Retry-After
500Internal server error
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/drama-plans/{id}/operations

Submit a confirmed planning operation

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
inputbodyobjectRequired
quotebodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
413Payload too large
429Rate limited; honor Retry-After
500Internal server error
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

get /v1/drama-plans/{id}/operations/{key}

Read planning candidate and generation receipt

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
keypathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
413Payload too large
429Rate limited; honor Retry-After
500Internal server error
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/drama-plans/{id}/operations/{key}/resume

Resume the saved planning request

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
keypathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
413Payload too large
429Rate limited; honor Retry-After
500Internal server error
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/drama-plans/{id}/operations/{key}/review

Accept or discard a planning candidate

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
keypathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
acceptbodybooleanRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
413Payload too large
429Rate limited; honor Retry-After
500Internal server error
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/projects/{id}/commands

Submit a document command with concurrency protection

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
command_idbodystringRequiredUUID
typebodystringRequired
payloadbodyobjectOptional
base_revisionbodyintegerRequired
idempotency_keybodystringRequiredUUID

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/canvas

Read the canvas document

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/timeline

Read the timeline document

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/scene3d

Read the stage3d document

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/image

Read the image document

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/image/versions

List image document revisions

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
cursorquerystringOptionalThe previous page's next_cursor
limitqueryintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/image/versions/{versionId}

Read an image document revision

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
versionIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/renders

Enqueue an FFmpeg timeline render

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
formatbodymp4|webm|wav|png_sequenceOptional
revisionbodyintegerOptional
video_bitratebodyintegerOptional
widthbodyintegerOptional
heightbodyintegerOptional
fpsbodyintegerOptional
idempotency_keybodystringOptional

Responses

StatusNotes
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/renders/{jobId}/cancel

Cancel an unfinished timeline export

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
jobIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/renders/{jobId}

Read a timeline render job

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
jobIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/exports

Enqueue an image export

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerOptional
page_idbodystringOptionalUUID
widthbodyintegerOptional
heightbodyintegerOptional
modebodycontain|cover|stretchOptional
formatbodypng|jpeg|webpOptional
idempotency_keybodystringOptional

Responses

StatusNotes
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/exports/{jobId}/retry

Retry a failed image export at its frozen revision

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
jobIdpathstringRequired

Responses

StatusNotes
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/exports/{jobId}

Read an image export job

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
jobIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/templates

Official and team templates

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
kindquerycover|knowledge|poster|product|quote|event|social|storyOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/templates

Save an image document as a template

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
codebodystringOptional
namebodystringRequired
kindbodycover|knowledge|poster|product|quote|event|social|storyRequired
documentbodyobjectRequired
variablesbodyobject[]Optional
notebodystringOptional
publish_sharedbodybooleanOptional
idempotency_keybodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/templates/{id}

Template and latest version

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{projectId}/templates/{templateId}/apply

Apply a template to an image document

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
templateIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
versionbodyintegerOptional
variablesbodyobjectOptional
base_revisionbodyintegerRequired
command_idbodystringOptional
idempotency_keybodystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/products

List products

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/products

Create a product

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringRequired
titlebodystringRequired
brand_colorbodystringOptional
logo_asset_idbodyanyOfOptional
publish_sharedbodybooleanOptional
idempotency_keybodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/products/{id}

Product and SKU details

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/products/{id}

Update a product

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringOptional
titlebodystringOptional
brand_colorbodystringOptional
logo_asset_idbodyanyOfOptional
publish_sharedbodybooleanOptional
idempotency_keybodystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/products/{id}/skus

Create a SKU with channel presets

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
codebodystringRequired
titlebodystringRequired
hero_asset_idbodyanyOfOptional
publish_sharedbodybooleanOptional
idempotency_keybodystringOptional
channel_presetsbodyobject[]Optional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/skus/{id}

Update a SKU

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
codebodystringOptional
titlebodystringOptional
hero_asset_idbodyanyOfOptional
publish_sharedbodybooleanOptional
idempotency_keybodystringOptional
channel_presetsbodyobject[]Optional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{projectId}/skus/{skuId}/exports

Read SKU export progress and files

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
skuIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{projectId}/skus/{skuId}/apply

Apply a SKU to a template and export

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
skuIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
template_idbodystringRequired
versionbodyintegerOptional
variablesbodyobjectOptional
base_revisionbodyintegerRequired
command_idbodystringOptional
idempotency_keybodystringOptional
export_channelsbodybooleanOptional
layout_modebodyoriginal|adaptiveOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

patch /v1/characters/{id}/reference-images

Update character design references with revision protection

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
reference_asset_idsbodystring[]Required
revisionbodyintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/characters/{id}/versions

Read character version history

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/characters/{id}/versions/{version}/restore

Restore character as a new version

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
versionpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/scenes/{id}/reference-images

Update scene design references with revision protection

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
reference_asset_idsbodystring[]Required
revisionbodyintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/scenes/{id}/versions

Read scene version history

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/scenes/{id}/versions/{version}/restore

Restore scene as a new version

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
versionpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/props/{id}/reference-images

Update prop design references with revision protection

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
reference_asset_idsbodystring[]Required
revisionbodyintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/props/{id}/versions

Read prop version history

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/props/{id}/versions/{version}/restore

Restore prop as a new version

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
versionpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/episodes/{id}/shot-order

Reorder shots within an episode

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
shot_idsbodystring[]Required
previous_idsbodystring[]Required

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/characters/{id}

Edit a character card

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringOptional
rolebodystringOptional
appearancebodyanyOfOptional
stylingbodyanyOfOptional
personalitybodyanyOfOptional
final_promptbodyanyOfOptional
revisionbodyintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

delete /v1/characters/{id}

Delete a character profile

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerOptional
base_updated_atbodystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/scenes/{id}

Edit a scene

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerOptional
locationbodystringOptional
time_of_daybodyanyOfOptional
lightingbodyanyOfOptional
final_promptbodyanyOfOptional
promptbodyanyOfOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

delete /v1/scenes/{id}

Delete a scene profile

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerOptional
base_updated_atbodystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/props/{id}

Edit a prop

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
final_promptbodyanyOfOptional
revisionbodyintegerOptional
namebodystringOptional
typebodystringOptional
promptbodyanyOfOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

delete /v1/props/{id}

Delete a prop profile

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerOptional
base_updated_atbodystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/shots/{id}

Read one shot

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/shots/{id}

Edit shot descriptions and prompts

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
character_idsbodystring[]Optional
prop_idsbodystring[]Optional
shot_typebodyanyOfOptional
anglebodyanyOfOptional
movementbodyanyOfOptional
atmospherebodyanyOfOptional
bgm_promptbodyanyOfOptional
sfxbodyanyOfOptional
first_frame_asset_idbodyanyOfOptional
last_frame_asset_idbodyanyOfOptional
scene_idbodyanyOfOptional
base_updated_atbodystringOptional
titlebodystringOptional
descriptionbodyanyOfOptional
duration_msbodyintegerOptional
image_promptbodyanyOfOptional
video_promptbodyanyOfOptional
dialoguebodyobject[]Optional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

delete /v1/shots/{id}

Delete a shot and its take records

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerOptional
base_updated_atbodystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

delete /v1/episodes/{id}

Delete an episode and its shot records

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerOptional
base_updated_atbodystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/characters/{id}/references

Update character reference images

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
reference_asset_idsbodystring[]Required

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{projectId}/drama

Read or create the project drama

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/projects/{projectId}/drama

Update drama metadata

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
titlebodystringOptional
genrebodyanyOfOptional
style_presetbodyanyOfOptional
aspect_ratiobodystringOptional
languagebodystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{projectId}/episodes

List episodes

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{projectId}/episodes

Create an episode

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
titlebodystringRequired
source_textbodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/episodes/{episodeId}

Update episode title or source text

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
episodeIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
titlebodystringOptional
source_textbodyanyOfOptional
script_textbodystringOptional
resolutionbody720x1280|1080x1920Optional
base_updated_atbodystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{projectId}/characters

List characters

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{projectId}/characters

Create a character and its first version

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringRequired
rolebodystringOptional
appearancebodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{projectId}/scenes

List scene bible entries

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{projectId}/scenes

Create a scene bible entry

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
locationbodystringRequired
time_of_daybodystringOptional
lightingbodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{projectId}/props

List prop bible entries

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{projectId}/props

Create a prop bible entry

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringRequired
typebodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/episodes/{episodeId}/shots

List episode shots

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
episodeIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/episodes/{episodeId}/shots

Create a shot

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
episodeIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
titlebodystringRequired
descriptionbodystringOptional
duration_msbodyintegerOptional
scene_idbodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/shots/{shotId}/takes

List shot takes

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
shotIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/shots/{shotId}/takes

Record a shot take

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
shotIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
generation_idbodystringOptional
asset_version_idbodystringRequired
notebodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/takes/{takeId}/accept

Accept one take

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
takeIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/production/{operationId}/resume

Resume a confirmed operation that has not started

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
operationIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/pipelines/{id}/quality-evidence

Export generation, alignment and review evidence

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/quickcut/styles

List production visual and caption styles

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/production/quote

Quote a quickcut production operation

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
operationbodyalignment|research|stock|vision|critic|regenerate_scene|revise_scriptRequired
model_codebodystringRequired
scene_idbodystringOptional
frame_asset_version_idbodystringOptional
querybodystringOptional
media_kindbodyimage|videoOptional
paramsbodyobjectOptional
idempotency_keybodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/production

Confirm a quote and start a production operation

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
operationbodyalignment|research|stock|vision|critic|regenerate_scene|revise_scriptRequired
model_codebodystringRequired
scene_idbodystringOptional
frame_asset_version_idbodystringOptional
querybodystringOptional
media_kindbodyimage|videoOptional
paramsbodyobjectOptional
idempotency_keybodystringRequired
quote_digestbodystringRequired

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/pipelines/{id}/production/{operationId}

Read operation status and archived results

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
operationIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/production/{operationId}/accept

Accept a reviewed production result

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
operationIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/production/{operationId}/stock

Confirm stock media licensing and request import

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
operationIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
candidate_idbodystringRequired
scene_idbodystringRequired
license_acceptedbodybooleanRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/production/{operationId}/stock/attach

Apply imported stock media to a scene

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
operationIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{projectId}/resource-batches

Prepare a quoted batch of character images or shot takes

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
kindbodycharacter_image|scene_image|prop_image|shot_take|character_prompt|scene_prompt|prop_prompt|shot_image_prompt|shot_video_promptRequired
target_idsbodystring[]Required
model_codebodystringRequired
paramsbodyobjectOptional
idempotency_keybodystringRequired

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/retry-failed

Create a retry run for failed batch targets only

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
idempotency_keybodystringRequired

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/steps/{n}/review

Edit a stage result and continue

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
npathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerRequired
changesbodyobjectOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/skills/{id}/versions

Read instruction version history

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/skills/{id}/fork

Create an editable team instruction copy

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
bodybodystringOptional
namebodystringOptional
attachmentsbodyobjectOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/skills/{id}

Save a new instruction version

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revisionbodyintegerRequired
bodybodystringRequired
namebodystringOptional
attachmentsbodyobjectOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{projectId}/resource-generations

Generate a resource image, shot take or speech

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
kindbodycharacter_image|scene_image|prop_image|shot_take|speech|character_prompt|scene_prompt|prop_prompt|shot_image_prompt|shot_video_promptRequired
target_idbodystringRequired
model_codebodystringRequired
promptbodystringRequired
paramsbodyobjectOptional
referencesbodyobject[]Optional
idempotency_keybodystringRequired

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/quickcut/archetypes

Sandbox quickcut archetypes

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/skills

Official and team skills

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{projectId}/pipelines

List project pipeline runs

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{projectId}/pipelines

Create a drama or quickcut pipeline

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
kindbodydrama|quickcut|commerceOptional
paramsbodyobjectOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/pipelines/{id}

Pipeline and step details

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/prompt-review

Apply an archived prompt or retain the current pipeline text

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
generation_idbodystringRequired
basebodyanyOfRequired
decisionbodyapply|keepRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/pipelines/{id}/steps/{n}/quote

Review a pipeline step quote

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
npathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/steps/{n}/approve-and-run

Approve the quote and queue a drama step

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
npathstringRequired

Responses

StatusNotes
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/steps/{n}/execute

Queue a confirmed pipeline step

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
npathstringRequired

Responses

StatusNotes
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/pipelines/{id}/steps/{n}/prompt

Build a step prompt without calling a model

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
npathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/steps/{n}/confirm

Confirm a paid step without reserving funds

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
npathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/pipelines/{id}/steps/{n}/apply

Apply a validated tool call

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
npathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringRequired
argumentsbodyobjectRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/voices

Official and team voices

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/music-tracks

Official and team music beds

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{projectId}/speech-segments

List project speech segments

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{projectId}/speech-segments

Create a speech segment without a paid call

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
projectIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
textbodystringRequired
voice_idbodystringOptional
request_idbodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/speech-segments/{id}/synthesize

Generate a sandbox WAV; live providers are unavailable

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/shots/{shotId}/audio

List shot audio

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
shotIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/shots/{shotId}/audio

Add dialogue or narration to a shot

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
shotIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
kindbodydialogue|narrationRequired
textbodystringRequired
voice_idbodystringOptional
speech_segment_idbodystringOptional
asset_version_idbodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/scene3d/captures

List camera captures and temporary previews

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
limitqueryintegerOptional
cursorquerystringOptional
scene_idquerystringOptional
unmarkedquerytrue|falseOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/scene3d/captures

Register a camera capture against a scene revision

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
idbodystringRequired
camera_idbodystringRequired
time_msbodyintegerRequired
asset_version_idbodystringRequired
kindbodyimage|videoRequired
revisionbodyintegerRequired
source_stage_node_idbodystringOptional
scene_idbodystringOptional
view_camerabodyobjectOptional
orbitbodyobjectOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/scene3d/panorama

Mark an owned image as a panorama

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
asset_version_idbodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/stage/character-presets

Stage character presets

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/stage/pose-presets

Stage pose presets

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/episodes/{episodeId}/assemble

Write accepted takes and captions to the timeline

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
episodeIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
shot_idsbodystring[]Optional
music_asset_version_idbodystringOptional
modebodyappend|replaceOptional
base_revisionbodyintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

Assets

get /v1/share/{token}

Read the media revision bound to a review link

Parameters

NameInTypeNotes
tokenpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/share/{token}/media

Read review link media content

Parameters

NameInTypeNotes
tokenpathstringRequired

Responses

StatusNotes
200Success
206OK
304No content
400Invalid request parameters
404Resource not found
416No content
422CONTENT_BLOCKED / PROVIDER_REJECTED
429Rate limited; honor Retry-After
500Internal server error

post /v1/share/{token}/comments

Comment through a review link

Parameters

NameInTypeNotes
tokenpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
author_namebodystringRequired
bodybodystringRequired
anchorbodyobjectOptional

Responses

StatusNotes
200Success
400Invalid request parameters
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

post /v1/share/{token}/approval

Decide the shared revision when visitor approval is enabled

Parameters

NameInTypeNotes
tokenpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
author_namebodystringRequired
decisionbodyapproved|changes_requestedRequired
version_hashbodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{projectId}/shared-copies

Copy organization catalog media into a project

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
projectIdpathstringRequired
asset_idsbodystring[]Required
idempotency_keybodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/asset-versions/{versionId}/content

Read authorized media content

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
versionIdpathstringRequired

Responses

StatusNotes
200Success
206OK
304No content
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
416No content
422CONTENT_BLOCKED / PROVIDER_REJECTED
429Rate limited; honor Retry-After
500Internal server error

get /v1/assets/imports

List asset imports

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
statusquerypending|downloading|succeeded|failedOptional
limitqueryintegerOptional
cursorquerystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/assets/imports

Import an asset from a public HTTPS URL

Create an asynchronous asset import (202). Only public HTTPS URLs are accepted; private, loopback, link-local, CGNAT and metadata addresses return URL_BLOCKED. The same organization and source_url reuse an import for 24 hours. Send url and optionally project_id and name.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
urlbodystringRequired
project_idbodyanyOfOptional
namebodystringOptional
kindbodyimage|video|audio|font|subtitle|model3d|document|bundleOptional

Responses

StatusNotes
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/assets/imports/{id}

Read an asset import

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/assets/multipart

Create or resume a multipart upload

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
project_idbodystringRequired
mimebodystringRequired
byte_sizebodyintegerRequired
content_hashbodystringRequired
namebodystringRequired
idempotency_keybodystringRequired

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/assets/multipart/{id}

Reconcile multipart receipts and completion

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

delete /v1/assets/multipart/{id}

Cancel multipart upload and confirm cleanup

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/assets/multipart/{id}/parts

Sign a missing part upload URL

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
part_numberbodyintegerRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/assets/multipart/{id}/parts/complete

Verify and save a part receipt

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
part_numberbodyintegerRequired
etagbodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/assets/multipart/{id}/complete

Assemble parts and verify the file

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/assets/uploads

Create an upload URL

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
request_idbodystringOptional
project_idbodyanyOfOptional
mimebodystringRequired
byte_sizebodyintegerRequired

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/assets/uploads/{intentId}/resume

Recover or renew the same upload intent

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
intentIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/assets/uploads/{intentId}/complete

Complete upload and register a version

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
intentIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringOptional
tagsbodystring[]Optional
asset_idbodystringOptional

Responses

StatusNotes
200Success
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
413Payload too large
415error
429Rate limited; honor Retry-After
500Internal server error

get /v1/assets

List assets

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
project_idquerystringOptional
kindquerystringOptional
tagquerystringOptional
qquerystringOptional
search_tagsquerytrue|falseOptional
trashquerytrue|falseOptional
limitqueryintegerOptional
cursorquerystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/assets/{id}

Asset details, versions and lineage

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/assets/{id}

Rename or retag an asset

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringOptional
tagsbodystring[]Optional
current_version_idbodystringOptional
rightsbodyobjectOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

delete /v1/assets/{id}

Move an asset to trash

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
forcequerytrue|falseOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/assets/{id}/url

Get a temporary download URL

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
version_idquerystringOptional
downloadquerytrue|falseOptional
expires_inqueryintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/assets/{id}/restore

Restore an asset from trash

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/assets/{id}/frames

Extract a first, last or timed frame

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
positionbodystart|end|msRequired
at_msbodyintegerOptional
version_idbodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/asset-versions/{versionId}/url

Get a historical version URL

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
versionIdpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/fonts

Redistributable font catalog

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
project_idquerystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/fonts/subset

Cache a font subset

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
familybodystringRequired
textbodystringRequired
weightbodyregular|medium|boldOptional
project_idbodystringOptional
asset_version_idbodystringOptional
source_hashbodystringOptional
include_sourcebodybooleanOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/review-targets

List reviewable revisions and delivery assets

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
purposequeryreview|deliveryOptional
qquerystringOptional
cursorquerystringOptional
limitqueryintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/shares

List review links, comments and decisions

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/shares

Create a version-bound review link

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
target_typebodyasset|timeline|render|image_docRequired
target_idbodystringRequired
media_version_idbodystringOptional
titlebodystringRequired
expires_atbodystringRequired
allow_commentbodybooleanOptional
allow_approvalbodybooleanOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

patch /v1/projects/{id}/shares/{shareId}

Revoke a review link or change its expiry

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
shareIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
revokebodybooleanOptional
expires_atbodystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/shares/{shareId}/approval

Approve the exact revision or request changes

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
shareIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
author_namebodystringRequired
decisionbodyapproved|changes_requestedRequired
version_hashbodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

patch /v1/projects/{id}/review-comments/{commentId}

Resolve or reopen a review comment

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
commentIdpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
resolvedbodybooleanRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/projects/{id}/deliveries

List delivery ZIP jobs

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

post /v1/projects/{id}/deliveries

Package frozen asset versions

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringRequired
version_idsbodystring[]Required
idempotency_keybodystringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

Generations

get /v1/generations

List generations

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
project_idquerystringOptional
idempotency_keyquerystringOptional
statusquerystringOptional
limitqueryintegerOptional
cursorquerystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/generations

Create a generation with quote, reserve and queue

The unified request used by Studio. External integrations should prefer /v1/images/generations or /v1/videos/generations. Replaying the same Idempotency-Key returns 200 and replayed=true.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
project_idbodyanyOfOptional
model_codebodystringRequired
promptbodystringOptional
negative_promptbodystringOptional
paramsbodyobjectOptional
referencesbodyobject[]Optional
countbodyintegerOptional
sourcebodystudio|canvas|editor|api|pipeline|mcp|shotsOptional
idempotency_keybodystringOptional
expected_quotebodyobjectOptional

Responses

StatusNotes
200Success
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/generations/{id}

Generation job and output details

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/generations/{id}/cancel

Cancel a generation when the provider supports it

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

Jobs

get /v1/jobs

List jobs

The id is a generation ID. Signed URLs are included only with expand=outputs. The default page size is 20, maximum 100.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
project_idquerystringOptional
statusquerystringOptional
modelquerystringOptional
key_idquerystringOptional
limitqueryintegerOptional
cursorquerystringOptional
expandquerystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/jobs/{id}

Read a job by generation ID

The public id is a generation ID; internal job IDs are also resolved. Output URLs expire after one hour. Cost includes quoted, reserved and charged sale amounts.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/jobs/{id}/cancel

Cancel a job

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

get /v1/jobs/{id}/events

Job event stream (SSE)

Alias of GET /v1/generations/:id/events using the generation ID. Refetch the authoritative job state after receiving an event.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

Images

post /v1/images/generations

Create an image generation job

Send model, prompt, n, size, aspect_ratio, quality, seed and references. n maps to count, size/seed to params. Aspect ratio and quality require contract support. References accept asset_id, version_id and role; URL imports wait up to 20 seconds. The response has object=job and empty outputs while queued.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
modelbodystringRequiredModel code from the model catalog
promptbodystringOptional
nbodyintegerOptionalNumber of outputs; maps to count
sizebodystringOptionalPassed as params.size
aspect_ratiobodystringOptionalMaps to contract ratio or aspect_ratio
qualitybodystringOptionalMaps to contract quality
seedbodyintegerOptionalPassed as params.seed
referencesbodyobject[]Optional
project_idbodyanyOfOptional
negative_promptbodystringOptional
expected_quotebodyobjectOptional

Responses

StatusNotes
200Success
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

post /v1/images/edits

Create an image editing job

Uses the image generation body, with at least one references[].role set to image or mask. The model contract must support that slot. Returns a job view.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
modelbodystringRequiredModel code from the model catalog
promptbodystringOptional
nbodyintegerOptionalNumber of outputs; maps to count
sizebodystringOptionalPassed as params.size
aspect_ratiobodystringOptionalMaps to contract ratio or aspect_ratio
qualitybodystringOptionalMaps to contract quality
seedbodyintegerOptionalPassed as params.seed
referencesbodyobject[]Optional
project_idbodyanyOfOptional
negative_promptbodystringOptional
expected_quotebodyobjectOptional

Responses

StatusNotes
200Success
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

Videos

post /v1/videos/generations

Create a video generation job

Send model, prompt, duration_s, resolution, aspect_ratio, audio, seed and references. Duration maps to duration/duration_s with millisecond conversion; aspect maps to ratio/aspect_ratio. Unsupported audio is ignored with warnings. Reference URL imports wait up to 20 seconds. Returns a job view and warnings.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
modelbodystringRequiredModel code from the model catalog
promptbodystringOptional
duration_sbodyintegerOptionalSeconds, converted to the contract duration/duration_s and unit
resolutionbodystringOptionalPassed as params.resolution
aspect_ratiobodystringOptionalMaps to contract ratio or aspect_ratio
audiobodybooleanOptionalApplied when supported; otherwise returns warnings
seedbodyintegerOptionalPassed as params.seed
referencesbodyobject[]Optional
project_idbodyanyOfOptional
negative_promptbodystringOptional
expected_quotebodyobjectOptional

Responses

StatusNotes
200Success
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

post /v1/videos/extensions

Extend a video from a video or last frame

Uses the video generation body, with at least one references[].role set to video or last_frame. An unsupported slot returns MODEL_CAPABILITY_UNSUPPORTED. Returns a job and warnings.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
modelbodystringRequiredModel code from the model catalog
promptbodystringOptional
duration_sbodyintegerOptionalSeconds, converted to the contract duration/duration_s and unit
resolutionbodystringOptionalPassed as params.resolution
aspect_ratiobodystringOptionalMaps to contract ratio or aspect_ratio
audiobodybooleanOptionalApplied when supported; otherwise returns warnings
seedbodyintegerOptionalPassed as params.seed
referencesbodyobject[]Optional
project_idbodyanyOfOptional
negative_promptbodystringOptional
expected_quotebodyobjectOptional

Responses

StatusNotes
200Success
202Queued; poll the job or subscribe to events
400Invalid request parameters
401Unauthenticated or invalid API key
402Insufficient balance or quota
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

Events

get /v1/events

Organization event stream (SSE)

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
project_idquerystringOptional
generation_idquerystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/generations/{id}/events

Generation event stream (SSE)

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

Billing

get /v1/billing/balance

Wallet balance, reserved funds and credit limit

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/billing/settings

Low balance notification threshold

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/billing/settings

Set the low balance notification threshold

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
low_balance_thresholdbodyanyOfRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/billing/ledger

Immutable ledger with sale amounts only

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
typequerystringOptional
limitqueryintegerOptional
cursorquerystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/billing/channels

Available top-up channels

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/billing/topups

List top-up orders

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
limitqueryintegerOptional
cursorquerystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/billing/topups

Create a top-up order

Wechat Native requires CNY and an explicit Idempotency-Key. Retain that key to recover the same order; a browser return does not confirm payment.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
amountbodyanyOfRequired
channelbodystringRequired
return_urlbodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/billing/topups/{id}

Read the original top-up order and saved payment instruction

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/billing/topups/{id}/refresh

Query the payment provider and reconcile authenticated status

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

post /v1/billing/topups/{id}/resume

Resume the original Wechat payment and recover its instruction

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

post /v1/billing/topups/{id}/cancel

Cancel an unpaid top-up order

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
409Revision, idempotency or state conflict
429Rate limited; honor Retry-After
500Internal server error

Usage

get /v1/usage/overview

Request and settled-spend overview

Defaults to the last seven days; maximum span is seven days, with inclusive UTC bounds. Failures are HTTP 4xx/5xx and failure_rate is null for zero requests. API keys see only their own calls and sales; project-bound keys additionally restrict attributed jobs and sales to their project. Unattributed calls remain limited to the requesting key.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
fromquerystringOptional
toquerystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/usage

Aggregate usage and sale amounts

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
fromquerystringOptional
toquerystringOptional
group_byquerystringOptional
project_idquerystringOptional
model_codequerystringOptional
key_idquerystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/usage/export.csv

Export usage as UTF-8 BOM CSV

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
fromquerystringOptional
toquerystringOptional
group_byquerystringOptional
project_idquerystringOptional
model_codequerystringOptional
key_idquerystringOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/usage/requests

Organization API request logs

Defaults to the last 24 hours, with a maximum seven-day range. Export longer ranges. status accepts 2xx, 4xx, 5xx or an exact HTTP status code.

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
key_idquerystringOptional
routequerystringOptional
statusquerystringOptional
fromquerystringOptional
toquerystringOptional
cursorquerystringOptionalThe previous page's next_cursor
limitqueryintegerOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

API keys

get /v1/api-keys

List API keys without hashes

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/api-keys

Create an API key shown only once

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringRequired
scopesbodymodels:read|generations:write|generations:read|assets:read|assets:write|projects:read|projects:write|commands:write|billing:read|webhooks:write[]Required
project_idbodyanyOfOptional
expires_in_daysbodyanyOfOptional
ip_allowlistbodystring[]Optional
environmentbodylive|testOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/api-keys/{id}

Update API key permissions and limits

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
namebodystringOptional
ip_allowlistbodystring[]Optional
expires_in_daysbodyanyOfOptional
scopesbodymodels:read|generations:write|generations:read|assets:read|assets:write|projects:read|projects:write|commands:write|billing:read|webhooks:write[]Optional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

delete /v1/api-keys/{id}

Revoke an API key

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
204Success, no response body
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

Webhooks

get /v1/webhooks

List webhook endpoints

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
limitqueryintegerOptional
cursorquerystringOptionalThe previous page's next_cursor

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/webhooks

Create a webhook with a one-time secret display

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
urlbodystringRequired
eventsbodyjob.succeeded|job.failed|job.needs_reconciliation|job.cancelled|asset.imported|balance.low|review.comment.added|review.approval.added[]Required
descriptionbodystringOptional

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/webhooks/events

Subscribable event catalog

Send x-api-key, or a signed-in session cookie.

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/webhooks/{id}

Webhook endpoint details

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

patch /v1/webhooks/{id}

Update a webhook endpoint

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
Idempotency-KeyheaderstringOptionalSame key and body replay for 24 hours. A different body returns 409 IDEMPOTENCY_MISMATCH; an in-flight request returns 409 IDEMPOTENCY_IN_FLIGHT with Retry-After: 1. Without a key, create/charge requests deduplicate by digest for 10 minutes.
urlbodystringOptional
eventsbodyjob.succeeded|job.failed|job.needs_reconciliation|job.cancelled|asset.imported|balance.low|review.comment.added|review.approval.added[]Optional
descriptionbodyanyOfOptional
statusbodyactive|pausedOptional

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

delete /v1/webhooks/{id}

Delete a webhook endpoint

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
204Success, no response body
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/webhooks/{id}/rotate-secret

Rotate a webhook secret

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/webhooks/{id}/test

Enqueue a ping test delivery

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired

Responses

StatusNotes
201Created
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

get /v1/webhooks/{id}/deliveries

Webhook delivery history

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
statusquerypending|succeeded|failedOptional
limitqueryintegerOptional
cursorquerystringOptionalThe previous page's next_cursor

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

post /v1/webhooks/{id}/deliveries/{did}/redeliver

Retry a webhook delivery

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
idpathstringRequired
didpathstringRequired

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error

Audit

get /v1/audit

Redacted organization audit logs

Send x-api-key, or a signed-in session cookie.

Parameters

NameInTypeNotes
actionsquerystringOptionalComma-separated actions or prefixes, e.g. auth, webhook.create
fromquerystringOptionalOnly records where created_at >= from
limitqueryintegerOptional
cursorquerystringOptionalThe previous page's next_cursor

Responses

StatusNotes
200Success
400Invalid request parameters
401Unauthenticated or invalid API key
403Permission, scope or model access denied
404Resource not found
429Rate limited; honor Retry-After
500Internal server error