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
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/system/capabilities
Current organization model configuration and feature availability
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
Models
get /v1/models
Available models and capability contracts
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/models/{code}/price
Model sale price
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
code | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/models/{code}
Model details
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
code | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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_id | body | anyOf | Optional | |
model_code | body | string | Required | |
prompt | body | string | Optional | |
negative_prompt | body | string | Optional | |
params | body | object | Optional | |
references | body | object[] | Optional | |
count | body | integer | Optional | |
source | body | studio|canvas|editor|api|pipeline|mcp|shots | Optional | |
idempotency_key | body | string | Optional | |
expected_quote | body | object | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Origin | header | string | Required | |
x-lashot-expected-user-id | header | string | Required | |
token | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Origin | header | string | Required | |
x-lashot-expected-user-id | header | string | Required | |
token | body | string | Required | |
expected_org_id | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Origin | header | string | Required | |
x-lashot-expected-user-id | header | string | Required | |
token | body | string | Required | |
expected_org_id | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Origin | header | string | Required | |
x-lashot-expected-user-id | header | string | Required | |
token | body | string | Required | |
expected_org_id | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/organization-invite-links
List organization invitation links (admin session)
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
create_request_id | body | string | Required | |
max_uses | body | integer | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/members
List project member permissions
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/member-candidates
List eligible organization members
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
put /v1/projects/{id}/members/{userId}
Grant project member access
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
userId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_revision | body | string | Required | |
idempotency_key | body | string | Required | |
permission | body | read|write|admin | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
delete /v1/projects/{id}/members/{userId}
Revoke project member access
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
userId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_revision | body | string | Required | |
idempotency_key | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects
List projects
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
include_archived | query | true|false | Optional | |
limit | query | integer | Optional | |
cursor | query | string | Optional | The previous page's next_cursor |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects
Create a project
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Required | |
kind | body | general|drama|commerce|quickcut | Optional | |
aspect_ratio | body | 16:9|9:16|1:1|4:3|3:4|21:9 | Optional | |
style_preset | body | string | Optional | |
settings | body | object | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}
Project and asset statistics
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/projects/{id}
Update a project using revision
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Optional | |
kind | body | general|drama|commerce|quickcut | Optional | |
aspect_ratio | body | 16:9|9:16|1:1|4:3|3:4|21:9 | Optional | |
style_preset | body | anyOf | Optional | |
cover_asset_id | body | anyOf | Optional | |
settings | body | object | Optional | |
revision | body | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
delete /v1/projects/{id}
Trash a project for 30 days
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
204 | Success, no response body |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects/{id}/archive
Archive a project
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects/{id}/restore
Restore an archived project
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Status | Notes |
|---|
200 | Success |
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/batches
List project batches
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects/{id}/batches
Create a batch draft
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
id | path | string | Required | |
name | body | string | Required | |
csv | body | string | Optional | |
data | body | object[] | Optional | |
mapping | body | object | Optional | |
concurrency | body | integer | Optional | |
template_version_id | body | string | Optional | |
template_id | body | string | Optional | |
idempotency_key | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/batches/{id}
Read batch and row progress
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/batches/{id}/mapping
Update draft column mapping
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
id | path | string | Required | |
model_code | body | string | Optional | |
model_column | body | string | Optional | |
prompt_template | body | string | Optional | |
variables | body | object | Optional | |
params | body | object | Optional | |
parameter_columns | body | object | Optional | |
dependency_column | body | string | Optional | |
dependency_role | body | image|first_frame|last_frame|style|subject|mask|control|audio|video|person|top_garment|bottom_garment | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/batches/{id}/precheck
Validate and quote without reserving funds
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/batches/{id}/start
Start the reviewed batch
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
id | path | string | Required | |
digest | body | string | Required | |
Responses
| Status | Notes |
|---|
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
id | path | string | Required | |
rows | body | integer[] | Optional | |
corrections | body | object[] | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/batches/{id}/errors.csv
Download error rows as CSV
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
413 | Payload too large |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
key | body | string | Required | |
source | body | object | Required | |
content | body | object | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
413 | Payload too large |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Required | |
bytes | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
413 | Payload too large |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
get /v1/drama-plans/{id}
Read a drama plan and revisions
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
413 | Payload too large |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
patch /v1/drama-plans/{id}
Save a plan with revision checks
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Required | |
content | body | object | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
413 | Payload too large |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
post /v1/drama-plans/{id}/publish
Create production episodes from a plan
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
413 | Payload too large |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
post /v1/drama-plans/{id}/quote
Quote a model planning operation
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
key | body | string | Required | |
revision | body | integer | Required | |
operation | body | outline|divide|episode|script | Required | |
target | body | string | Optional | |
instruction | body | string | Optional | |
model | body | string | Required | |
params | body | object | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
413 | Payload too large |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
post /v1/drama-plans/{id}/operations
Submit a confirmed planning operation
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
input | body | object | Required | |
quote | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
413 | Payload too large |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
key | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
413 | Payload too large |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
key | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
413 | Payload too large |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
key | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
accept | body | boolean | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
413 | Payload too large |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
post /v1/projects/{id}/commands
Submit a document command with concurrency protection
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
command_id | body | string | Required | UUID |
type | body | string | Required | |
payload | body | object | Optional | |
base_revision | body | integer | Required | |
idempotency_key | body | string | Required | UUID |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/canvas
Read the canvas document
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/timeline
Read the timeline document
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/scene3d
Read the stage3d document
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/image
Read the image document
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/image/versions
List image document revisions
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
cursor | query | string | Optional | The previous page's next_cursor |
limit | query | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
versionId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects/{id}/renders
Enqueue an FFmpeg timeline render
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
format | body | mp4|webm|wav|png_sequence | Optional | |
revision | body | integer | Optional | |
video_bitrate | body | integer | Optional | |
width | body | integer | Optional | |
height | body | integer | Optional | |
fps | body | integer | Optional | |
idempotency_key | body | string | Optional | |
Responses
| Status | Notes |
|---|
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
jobId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/renders/{jobId}
Read a timeline render job
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
jobId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects/{id}/exports
Enqueue an image export
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Optional | |
page_id | body | string | Optional | UUID |
width | body | integer | Optional | |
height | body | integer | Optional | |
mode | body | contain|cover|stretch | Optional | |
format | body | png|jpeg|webp | Optional | |
idempotency_key | body | string | Optional | |
Responses
| Status | Notes |
|---|
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
jobId | path | string | Required | |
Responses
| Status | Notes |
|---|
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/exports/{jobId}
Read an image export job
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
jobId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/templates
Official and team templates
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
kind | query | cover|knowledge|poster|product|quote|event|social|story | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/templates
Save an image document as a template
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
code | body | string | Optional | |
name | body | string | Required | |
kind | body | cover|knowledge|poster|product|quote|event|social|story | Required | |
document | body | object | Required | |
variables | body | object[] | Optional | |
note | body | string | Optional | |
publish_shared | body | boolean | Optional | |
idempotency_key | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/templates/{id}
Template and latest version
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
templateId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
version | body | integer | Optional | |
variables | body | object | Optional | |
base_revision | body | integer | Required | |
command_id | body | string | Optional | |
idempotency_key | body | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/products
List products
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/products
Create a product
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Required | |
title | body | string | Required | |
brand_color | body | string | Optional | |
logo_asset_id | body | anyOf | Optional | |
publish_shared | body | boolean | Optional | |
idempotency_key | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/products/{id}
Product and SKU details
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/products/{id}
Update a product
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Optional | |
title | body | string | Optional | |
brand_color | body | string | Optional | |
logo_asset_id | body | anyOf | Optional | |
publish_shared | body | boolean | Optional | |
idempotency_key | body | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/products/{id}/skus
Create a SKU with channel presets
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
code | body | string | Required | |
title | body | string | Required | |
hero_asset_id | body | anyOf | Optional | |
publish_shared | body | boolean | Optional | |
idempotency_key | body | string | Optional | |
channel_presets | body | object[] | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/skus/{id}
Update a SKU
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
code | body | string | Optional | |
title | body | string | Optional | |
hero_asset_id | body | anyOf | Optional | |
publish_shared | body | boolean | Optional | |
idempotency_key | body | string | Optional | |
channel_presets | body | object[] | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
skuId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
skuId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_id | body | string | Required | |
version | body | integer | Optional | |
variables | body | object | Optional | |
base_revision | body | integer | Required | |
command_id | body | string | Optional | |
idempotency_key | body | string | Optional | |
export_channels | body | boolean | Optional | |
layout_mode | body | original|adaptive | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_ids | body | string[] | Required | |
revision | body | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/characters/{id}/versions
Read character version history
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
version | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_ids | body | string[] | Required | |
revision | body | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/scenes/{id}/versions
Read scene version history
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
version | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_ids | body | string[] | Required | |
revision | body | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/props/{id}/versions
Read prop version history
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
version | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/episodes/{id}/shot-order
Reorder shots within an episode
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_ids | body | string[] | Required | |
previous_ids | body | string[] | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/characters/{id}
Edit a character card
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Optional | |
role | body | string | Optional | |
appearance | body | anyOf | Optional | |
styling | body | anyOf | Optional | |
personality | body | anyOf | Optional | |
final_prompt | body | anyOf | Optional | |
revision | body | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
delete /v1/characters/{id}
Delete a character profile
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Optional | |
base_updated_at | body | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/scenes/{id}
Edit a scene
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Optional | |
location | body | string | Optional | |
time_of_day | body | anyOf | Optional | |
lighting | body | anyOf | Optional | |
final_prompt | body | anyOf | Optional | |
prompt | body | anyOf | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
delete /v1/scenes/{id}
Delete a scene profile
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Optional | |
base_updated_at | body | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/props/{id}
Edit a prop
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_prompt | body | anyOf | Optional | |
revision | body | integer | Optional | |
name | body | string | Optional | |
type | body | string | Optional | |
prompt | body | anyOf | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
delete /v1/props/{id}
Delete a prop profile
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Optional | |
base_updated_at | body | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/shots/{id}
Read one shot
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/shots/{id}
Edit shot descriptions and prompts
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_ids | body | string[] | Optional | |
prop_ids | body | string[] | Optional | |
shot_type | body | anyOf | Optional | |
angle | body | anyOf | Optional | |
movement | body | anyOf | Optional | |
atmosphere | body | anyOf | Optional | |
bgm_prompt | body | anyOf | Optional | |
sfx | body | anyOf | Optional | |
first_frame_asset_id | body | anyOf | Optional | |
last_frame_asset_id | body | anyOf | Optional | |
scene_id | body | anyOf | Optional | |
base_updated_at | body | string | Optional | |
title | body | string | Optional | |
description | body | anyOf | Optional | |
duration_ms | body | integer | Optional | |
image_prompt | body | anyOf | Optional | |
video_prompt | body | anyOf | Optional | |
dialogue | body | object[] | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
delete /v1/shots/{id}
Delete a shot and its take records
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Optional | |
base_updated_at | body | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
delete /v1/episodes/{id}
Delete an episode and its shot records
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Optional | |
base_updated_at | body | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/characters/{id}/references
Update character reference images
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_ids | body | string[] | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{projectId}/drama
Read or create the project drama
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/projects/{projectId}/drama
Update drama metadata
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
title | body | string | Optional | |
genre | body | anyOf | Optional | |
style_preset | body | anyOf | Optional | |
aspect_ratio | body | string | Optional | |
language | body | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{projectId}/episodes
List episodes
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects/{projectId}/episodes
Create an episode
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
title | body | string | Required | |
source_text | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/episodes/{episodeId}
Update episode title or source text
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
episodeId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
title | body | string | Optional | |
source_text | body | anyOf | Optional | |
script_text | body | string | Optional | |
resolution | body | 720x1280|1080x1920 | Optional | |
base_updated_at | body | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{projectId}/characters
List characters
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Required | |
role | body | string | Optional | |
appearance | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{projectId}/scenes
List scene bible entries
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects/{projectId}/scenes
Create a scene bible entry
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
location | body | string | Required | |
time_of_day | body | string | Optional | |
lighting | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{projectId}/props
List prop bible entries
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects/{projectId}/props
Create a prop bible entry
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Required | |
type | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/episodes/{episodeId}/shots
List episode shots
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
episodeId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/episodes/{episodeId}/shots
Create a shot
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
episodeId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
title | body | string | Required | |
description | body | string | Optional | |
duration_ms | body | integer | Optional | |
scene_id | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/shots/{shotId}/takes
List shot takes
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
shotId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/shots/{shotId}/takes
Record a shot take
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
shotId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_id | body | string | Optional | |
asset_version_id | body | string | Required | |
note | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/takes/{takeId}/accept
Accept one take
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
takeId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
operationId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/quickcut/styles
List production visual and caption styles
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/pipelines/{id}/production/quote
Quote a quickcut production operation
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
operation | body | alignment|research|stock|vision|critic|regenerate_scene|revise_script | Required | |
model_code | body | string | Required | |
scene_id | body | string | Optional | |
frame_asset_version_id | body | string | Optional | |
query | body | string | Optional | |
media_kind | body | image|video | Optional | |
params | body | object | Optional | |
idempotency_key | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
operation | body | alignment|research|stock|vision|critic|regenerate_scene|revise_script | Required | |
model_code | body | string | Required | |
scene_id | body | string | Optional | |
frame_asset_version_id | body | string | Optional | |
query | body | string | Optional | |
media_kind | body | image|video | Optional | |
params | body | object | Optional | |
idempotency_key | body | string | Required | |
quote_digest | body | string | Required | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
operationId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
operationId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
operationId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_id | body | string | Required | |
scene_id | body | string | Required | |
license_accepted | body | boolean | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
operationId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
kind | body | character_image|scene_image|prop_image|shot_take|character_prompt|scene_prompt|prop_prompt|shot_image_prompt|shot_video_prompt | Required | |
target_ids | body | string[] | Required | |
model_code | body | string | Required | |
params | body | object | Optional | |
idempotency_key | body | string | Required | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_key | body | string | Required | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
n | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Required | |
changes | body | object | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/skills/{id}/versions
Read instruction version history
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/skills/{id}/fork
Create an editable team instruction copy
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
body | body | string | Optional | |
name | body | string | Optional | |
attachments | body | object | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/skills/{id}
Save a new instruction version
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revision | body | integer | Required | |
body | body | string | Required | |
name | body | string | Optional | |
attachments | body | object | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
kind | body | character_image|scene_image|prop_image|shot_take|speech|character_prompt|scene_prompt|prop_prompt|shot_image_prompt|shot_video_prompt | Required | |
target_id | body | string | Required | |
model_code | body | string | Required | |
prompt | body | string | Required | |
params | body | object | Optional | |
references | body | object[] | Optional | |
idempotency_key | body | string | Required | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/quickcut/archetypes
Sandbox quickcut archetypes
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/skills
Official and team skills
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{projectId}/pipelines
List project pipeline runs
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects/{projectId}/pipelines
Create a drama or quickcut pipeline
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
kind | body | drama|quickcut|commerce | Optional | |
params | body | object | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/pipelines/{id}
Pipeline and step details
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_id | body | string | Required | |
base | body | anyOf | Required | |
decision | body | apply|keep | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
n | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
n | path | string | Required | |
Responses
| Status | Notes |
|---|
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
n | path | string | Required | |
Responses
| Status | Notes |
|---|
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
n | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
n | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
n | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Required | |
arguments | body | object | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/voices
Official and team voices
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/music-tracks
Official and team music beds
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{projectId}/speech-segments
List project speech segments
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
projectId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
text | body | string | Required | |
voice_id | body | string | Optional | |
request_id | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/shots/{shotId}/audio
List shot audio
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
shotId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
shotId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
kind | body | dialogue|narration | Required | |
text | body | string | Required | |
voice_id | body | string | Optional | |
speech_segment_id | body | string | Optional | |
asset_version_id | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
limit | query | integer | Optional | |
cursor | query | string | Optional | |
scene_id | query | string | Optional | |
unmarked | query | true|false | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
id | body | string | Required | |
camera_id | body | string | Required | |
time_ms | body | integer | Required | |
asset_version_id | body | string | Required | |
kind | body | image|video | Required | |
revision | body | integer | Required | |
source_stage_node_id | body | string | Optional | |
scene_id | body | string | Optional | |
view_camera | body | object | Optional | |
orbit | body | object | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_id | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/stage/character-presets
Stage character presets
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/stage/pose-presets
Stage pose presets
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
episodeId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_ids | body | string[] | Optional | |
music_asset_version_id | body | string | Optional | |
mode | body | append|replace | Optional | |
base_revision | body | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
Assets
get /v1/share/{token}
Read the media revision bound to a review link
Parameters
| Name | In | Type | | Notes |
|---|
token | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/share/{token}/media
Read review link media content
Parameters
| Name | In | Type | | Notes |
|---|
token | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
206 | OK |
304 | No content |
400 | Invalid request parameters |
404 | Resource not found |
416 | No content |
422 | CONTENT_BLOCKED / PROVIDER_REJECTED |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/share/{token}/approval
Decide the shared revision when visitor approval is enabled
Parameters
| Name | In | Type | | Notes |
|---|
token | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_name | body | string | Required | |
decision | body | approved|changes_requested | Required | |
version_hash | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
projectId | path | string | Required | |
asset_ids | body | string[] | Required | |
idempotency_key | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/asset-versions/{versionId}/content
Read authorized media content
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
versionId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
206 | OK |
304 | No content |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
416 | No content |
422 | CONTENT_BLOCKED / PROVIDER_REJECTED |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/assets/imports
List asset imports
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
status | query | pending|downloading|succeeded|failed | Optional | |
limit | query | integer | Optional | |
cursor | query | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
url | body | string | Required | |
project_id | body | anyOf | Optional | |
name | body | string | Optional | |
kind | body | image|video|audio|font|subtitle|model3d|document|bundle | Optional | |
Responses
| Status | Notes |
|---|
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/assets/imports/{id}
Read an asset import
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/assets/multipart
Create or resume a multipart upload
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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_id | body | string | Required | |
mime | body | string | Required | |
byte_size | body | integer | Required | |
content_hash | body | string | Required | |
name | body | string | Required | |
idempotency_key | body | string | Required | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/assets/multipart/{id}
Reconcile multipart receipts and completion
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
delete /v1/assets/multipart/{id}
Cancel multipart upload and confirm cleanup
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_number | body | integer | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_number | body | integer | Required | |
etag | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/assets/uploads
Create an upload URL
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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_id | body | string | Optional | |
project_id | body | anyOf | Optional | |
mime | body | string | Required | |
byte_size | body | integer | Required | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
intentId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
intentId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Optional | |
tags | body | string[] | Optional | |
asset_id | body | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
413 | Payload too large |
415 | error |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/assets
List assets
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
project_id | query | string | Optional | |
kind | query | string | Optional | |
tag | query | string | Optional | |
q | query | string | Optional | |
search_tags | query | true|false | Optional | |
trash | query | true|false | Optional | |
limit | query | integer | Optional | |
cursor | query | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/assets/{id}
Asset details, versions and lineage
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/assets/{id}
Rename or retag an asset
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Optional | |
tags | body | string[] | Optional | |
current_version_id | body | string | Optional | |
rights | body | object | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
delete /v1/assets/{id}
Move an asset to trash
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
force | query | true|false | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/assets/{id}/url
Get a temporary download URL
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
version_id | query | string | Optional | |
download | query | true|false | Optional | |
expires_in | query | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/assets/{id}/restore
Restore an asset from trash
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/asset-versions/{versionId}/url
Get a historical version URL
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
versionId | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/fonts
Redistributable font catalog
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
project_id | query | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/fonts/subset
Cache a font subset
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
family | body | string | Required | |
text | body | string | Required | |
weight | body | regular|medium|bold | Optional | |
project_id | body | string | Optional | |
asset_version_id | body | string | Optional | |
source_hash | body | string | Optional | |
include_source | body | boolean | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
purpose | query | review|delivery | Optional | |
q | query | string | Optional | |
cursor | query | string | Optional | |
limit | query | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/shares
List review links, comments and decisions
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects/{id}/shares
Create a version-bound review link
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_type | body | asset|timeline|render|image_doc | Required | |
target_id | body | string | Required | |
media_version_id | body | string | Optional | |
title | body | string | Required | |
expires_at | body | string | Required | |
allow_comment | body | boolean | Optional | |
allow_approval | body | boolean | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
shareId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
revoke | body | boolean | Optional | |
expires_at | body | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
shareId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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_name | body | string | Required | |
decision | body | approved|changes_requested | Required | |
version_hash | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
commentId | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
resolved | body | boolean | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/projects/{id}/deliveries
List delivery ZIP jobs
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/projects/{id}/deliveries
Package frozen asset versions
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Required | |
version_ids | body | string[] | Required | |
idempotency_key | body | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
Generations
get /v1/generations
List generations
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
project_id | query | string | Optional | |
idempotency_key | query | string | Optional | |
status | query | string | Optional | |
limit | query | integer | Optional | |
cursor | query | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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_id | body | anyOf | Optional | |
model_code | body | string | Required | |
prompt | body | string | Optional | |
negative_prompt | body | string | Optional | |
params | body | object | Optional | |
references | body | object[] | Optional | |
count | body | integer | Optional | |
source | body | studio|canvas|editor|api|pipeline|mcp|shots | Optional | |
idempotency_key | body | string | Optional | |
expected_quote | body | object | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/generations/{id}
Generation job and output details
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
project_id | query | string | Optional | |
status | query | string | Optional | |
model | query | string | Optional | |
key_id | query | string | Optional | |
limit | query | integer | Optional | |
cursor | query | string | Optional | |
expand | query | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/jobs/{id}/cancel
Cancel a job
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
model | body | string | Required | Model code from the model catalog |
prompt | body | string | Optional | |
n | body | integer | Optional | Number of outputs; maps to count |
size | body | string | Optional | Passed as params.size |
aspect_ratio | body | string | Optional | Maps to contract ratio or aspect_ratio |
quality | body | string | Optional | Maps to contract quality |
seed | body | integer | Optional | Passed as params.seed |
references | body | object[] | Optional | |
project_id | body | anyOf | Optional | |
negative_prompt | body | string | Optional | |
expected_quote | body | object | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
model | body | string | Required | Model code from the model catalog |
prompt | body | string | Optional | |
n | body | integer | Optional | Number of outputs; maps to count |
size | body | string | Optional | Passed as params.size |
aspect_ratio | body | string | Optional | Maps to contract ratio or aspect_ratio |
quality | body | string | Optional | Maps to contract quality |
seed | body | integer | Optional | Passed as params.seed |
references | body | object[] | Optional | |
project_id | body | anyOf | Optional | |
negative_prompt | body | string | Optional | |
expected_quote | body | object | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
model | body | string | Required | Model code from the model catalog |
prompt | body | string | Optional | |
duration_s | body | integer | Optional | Seconds, converted to the contract duration/duration_s and unit |
resolution | body | string | Optional | Passed as params.resolution |
aspect_ratio | body | string | Optional | Maps to contract ratio or aspect_ratio |
audio | body | boolean | Optional | Applied when supported; otherwise returns warnings |
seed | body | integer | Optional | Passed as params.seed |
references | body | object[] | Optional | |
project_id | body | anyOf | Optional | |
negative_prompt | body | string | Optional | |
expected_quote | body | object | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
model | body | string | Required | Model code from the model catalog |
prompt | body | string | Optional | |
duration_s | body | integer | Optional | Seconds, converted to the contract duration/duration_s and unit |
resolution | body | string | Optional | Passed as params.resolution |
aspect_ratio | body | string | Optional | Maps to contract ratio or aspect_ratio |
audio | body | boolean | Optional | Applied when supported; otherwise returns warnings |
seed | body | integer | Optional | Passed as params.seed |
references | body | object[] | Optional | |
project_id | body | anyOf | Optional | |
negative_prompt | body | string | Optional | |
expected_quote | body | object | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
202 | Queued; poll the job or subscribe to events |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
402 | Insufficient balance or quota |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
Events
get /v1/events
Organization event stream (SSE)
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
project_id | query | string | Optional | |
generation_id | query | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/generations/{id}/events
Generation event stream (SSE)
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/billing/settings
Low balance notification threshold
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/billing/settings
Set the low balance notification threshold
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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_threshold | body | anyOf | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/billing/ledger
Immutable ledger with sale amounts only
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
type | query | string | Optional | |
limit | query | integer | Optional | |
cursor | query | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/billing/channels
Available top-up channels
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/billing/topups
List top-up orders
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
limit | query | integer | Optional | |
cursor | query | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
amount | body | anyOf | Required | |
channel | body | string | Required | |
return_url | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
409 | Revision, idempotency or state conflict |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
from | query | string | Optional | |
to | query | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/usage
Aggregate usage and sale amounts
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
from | query | string | Optional | |
to | query | string | Optional | |
group_by | query | string | Optional | |
project_id | query | string | Optional | |
model_code | query | string | Optional | |
key_id | query | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
from | query | string | Optional | |
to | query | string | Optional | |
group_by | query | string | Optional | |
project_id | query | string | Optional | |
model_code | query | string | Optional | |
key_id | query | string | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
key_id | query | string | Optional | |
route | query | string | Optional | |
status | query | string | Optional | |
from | query | string | Optional | |
to | query | string | Optional | |
cursor | query | string | Optional | The previous page's next_cursor |
limit | query | integer | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
API keys
get /v1/api-keys
List API keys without hashes
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/api-keys
Create an API key shown only once
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Required | |
scopes | body | models:read|generations:write|generations:read|assets:read|assets:write|projects:read|projects:write|commands:write|billing:read|webhooks:write[] | Required | |
project_id | body | anyOf | Optional | |
expires_in_days | body | anyOf | Optional | |
ip_allowlist | body | string[] | Optional | |
environment | body | live|test | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/api-keys/{id}
Update API key permissions and limits
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
name | body | string | Optional | |
ip_allowlist | body | string[] | Optional | |
expires_in_days | body | anyOf | Optional | |
scopes | body | models:read|generations:write|generations:read|assets:read|assets:write|projects:read|projects:write|commands:write|billing:read|webhooks:write[] | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
delete /v1/api-keys/{id}
Revoke an API key
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
204 | Success, no response body |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
Webhooks
get /v1/webhooks
List webhook endpoints
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
limit | query | integer | Optional | |
cursor | query | string | Optional | The previous page's next_cursor |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal 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
| Name | In | Type | | Notes |
|---|
Idempotency-Key | header | string | Optional | Same 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. |
url | body | string | Required | |
events | body | job.succeeded|job.failed|job.needs_reconciliation|job.cancelled|asset.imported|balance.low|review.comment.added|review.approval.added[] | Required | |
description | body | string | Optional | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/webhooks/events
Subscribable event catalog
Send x-api-key, or a signed-in session cookie.
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/webhooks/{id}
Webhook endpoint details
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
patch /v1/webhooks/{id}
Update a webhook endpoint
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Idempotency-Key | header | string | Optional | Same 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. |
url | body | string | Optional | |
events | body | job.succeeded|job.failed|job.needs_reconciliation|job.cancelled|asset.imported|balance.low|review.comment.added|review.approval.added[] | Optional | |
description | body | anyOf | Optional | |
status | body | active|paused | Optional | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
delete /v1/webhooks/{id}
Delete a webhook endpoint
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
204 | Success, no response body |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/webhooks/{id}/rotate-secret
Rotate a webhook secret
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/webhooks/{id}/test
Enqueue a ping test delivery
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
Responses
| Status | Notes |
|---|
201 | Created |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
get /v1/webhooks/{id}/deliveries
Webhook delivery history
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
status | query | pending|succeeded|failed | Optional | |
limit | query | integer | Optional | |
cursor | query | string | Optional | The previous page's next_cursor |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
post /v1/webhooks/{id}/deliveries/{did}/redeliver
Retry a webhook delivery
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
id | path | string | Required | |
did | path | string | Required | |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |
Audit
get /v1/audit
Redacted organization audit logs
Send x-api-key, or a signed-in session cookie.
Parameters
| Name | In | Type | | Notes |
|---|
actions | query | string | Optional | Comma-separated actions or prefixes, e.g. auth, webhook.create |
from | query | string | Optional | Only records where created_at >= from |
limit | query | integer | Optional | |
cursor | query | string | Optional | The previous page's next_cursor |
Responses
| Status | Notes |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Unauthenticated or invalid API key |
403 | Permission, scope or model access denied |
404 | Resource not found |
429 | Rate limited; honor Retry-After |
500 | Internal server error |