Skip to main content

​
Three kinds of string

The API reference types text, resource ids and some fixed choices as string, but you fill them in differently:
Never construct an id from an example. Examples such as brd_4b81 only show the shape; use ids returned for your workspace.
These docs use the same example ids throughout: prj_9x2a4c (project), brd_4b81 (Brand), job_4k1b7d (render job), job_7e3c2f (footage-edit job) and cnt_8f3e2a71 (asset).

​
Where each resource id comes from

Products have two ids on purpose. products[].id addresses the product record and is the {productDocId} path parameter for reads and updates. products[].productId is the short binding id that Brands and autopilot destinations refer to.

​
Theme ids

Theme ids are versioned IAB taxonomy identifiers such as iab:3.1:391. The accepted set is too large and evolves too independently to paste into every field. The API itself is the list:
Use themes[].id exactly as returned, including the colons and version. Search by name when you do not know the id:
Send the response’s nextCursor back as cursor to continue. See Pagination.

​
Values that come from the dashboard

A few ids refer to things a person sets up interactively, such as an account authorization. The API accepts them but does not create them: The API reference repeats these notes on each field.

​
Dates, times, regions, and languages

​
Fixed choices

When a field has a closed set, the API reference lists every accepted value under it and explains choices whose names are not self-evident — for example draft_only, review_first and full_auto. A value outside the list answers 400 invalid_request. A string field without a list says in its description whether it is free text, provider-specific, or best left unset. Voice and model ids are provider-specific: omit them to use Sigmora’s defaults unless you have a value you know is valid. GET /v1/video/options lists the live voices, models and other video choices.