API reference · API
What a render plan would be held at
POST/v1/studio/projects/{id}/plans/quoteAPI key
One total and each shot at its worst case, markup on, and whether the balance covers it; nothing is made or held. A 404 while video and sound jobs are switched off. An API key with the read scope. Rate limited per key at the key's own requests a minute, in a window of its own. An agent's key is refused (403 policy_violation). Every /v1/studio door is a 404 while video and sound jobs are switched off.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The project's id, stp_ followed by hex. |
Request body
application/json, required
| Field | Type | What it is |
|---|---|---|
| shotsrequired | array of object | |
| shots[] | string | A clip, a sound, or a still: a picture for a shot to start from. One of "video", "sound", "still". |
| shots[] | string | |
| shots[] | string | |
| shots[] | number | |
| shots[] | string | |
| shots[] | string | |
| shots[] | boolean | |
| shots[] | string | The starting picture for a model whose input is image: an https URL, or a data:image/png, jpeg or webp base64 URL of at most 5242880 bytes decoded. |
| shots[] | string | A picture the account stored (sa_ followed by hex) to start from instead of image; sent to the provider as a data URL, never as a link to the store. For a talking still, a motion control, an upscale of a picture (enlarge) or a fill (inpaint), the still it starts from, which the provider fetches through a signed link on this origin that lapses after 30 minutes; an upscale or a fill is held from the still's own size, read from the file on the server. |
| shots[] | array of string | Reference pictures a model keeps a subject from (a character's), or a still is made from, as many as the model takes (its references in the model list): each an https URL, a data:image URL, or a stored picture (sa_ followed by hex) sent as a data URL. |
| shots[] | string | The last frame, for a model whose endFrame is true: a picture as references takes one. |
| shots[] | string | |
| shots[] | integer | |
| shots[] | string | |
| shots[] | string or null | A camera move phrased into a video's prompt on the server. One of "push-in", "pull-out", "orbit", "crane-up", "dolly-zoom", "tracking", "handheld", "drone", "whip-pan", "static", null. |
| shots[] | string | |
| pictures | array of string | Starting pictures as data:image URLs, sent once: a shot's image may say picture:<index> to name one. |
Example
{
"shots": [
{
"kind": "video",
"model": "antimatter/auto",
"prompt": "Say hello in five words."
}
],
"pictures": [
"string"
]
}Answer 200
The quote.
| Field | Type | What it is |
|---|---|---|
| object | string | One of "studio.plan.quote". |
| total_micros | integer | Every shot at its worst case, a dearer provider of the same model included, markup on. |
| shots | array of object | |
| shots[] | integer | |
| shots[] | string | |
| shots[] | integer | |
| funded | boolean | Whether the balance covers the whole total now and the account ever deposited. |
| deposited | boolean | Whether the account ever deposited: only a deposited balance pays for a plan, never the free allowance. |
| balance_micros | integer |
Errors
- 400OpenAI shaped error.
- 401OpenAI shaped error.
- 403OpenAI shaped error.
- 404OpenAI shaped error.
- 429OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.