API reference · Account
One idea to a finished film
POST/api/studio/filmSigned in session
Holds the shots' and the music's total whole, writes the plan with a chat model billed to the account (its cost in x-antimatter-cost-micros), then makes the shots and the music as one render plan under that hold. Any refusal before the plan stands releases the hold and nothing is made. The browser lays the cut once every take has landed. Same origin only.
Request body
application/json, required
| Field | Type | What it is |
|---|---|---|
| idearequired | string | The idea, a sentence or a paragraph. At most 4000 characters. |
| shotsrequired | integer | From 1 to 12. |
| secondsrequired | number | Seconds a shot, held to the model's own lengths. |
| modelrequired | string | The video model every shot is made on: one that makes a shot from words alone. |
| style | string | At most 500 characters. |
| aspectrequired | string | One of "16:9", "9:16", "1:1". |
| musicrequired | object | Made by a priced music model ({kind: model, model}), the person's own file ({kind: own}) or none. |
| music. | string | One of "model", "own", "none". |
| music. | string | |
| project_id | string | The account's id of the film it is made in, stp_ followed by hex (POST only). |
Example
{
"idea": "string",
"shots": 1,
"seconds": 0,
"model": "antimatter/auto",
"aspect": "16:9",
"music": {
"kind": "model",
"model": "antimatter/auto"
}
}Answer 201
The plan as written and the render plan making it.
| Field | Type | What it is |
|---|---|---|
| object | string | One of "studio.film". |
| title | string | |
| shots | array of object | |
| shots[] | string | |
| shots[] | string | |
| shots[] | string or null | |
| shots[] | string or null | |
| shots[] | number | |
| shots[] | string or null | |
| shots[] | string | |
| music_prompt | string or null | |
| music_seconds | number | |
| writing_micros | integer | Billed micro USD of the writing, every attempt counted. |
| writer_model | string | |
| writer_name | string | |
| plan | object | |
| plan. | string | |
| plan. | string | One of "studio.plan". |
| plan. | string | |
| plan. | string | One of "running", "completed", "cancelled". |
| plan. | integer | The total the balance was checked against. |
| plan. | integer | Settled shots' charges plus running shots' holds. |
| plan. | object | |
| plan. | array of object | |
| plan. | string | |
| plan. | string | One of "studio.shot". |
| plan. | integer | |
| plan. | string or null | |
| plan. | string | |
| plan. | string | One of "waiting", "starting", "running", "completed", "failed", "cancelled". |
| plan. | integer | The quote while it waits, the job's hold while it runs, the charge once done. |
| plan. | string or null | |
| plan. | object or null | The shot's job, as /api/studio/jobs answers it. |
| plan. | object or null | |
| plan. | string | |
| plan. | string | |
| plan. | integer | |
| plan. | integer or null | |
| plan. | integer or null | |
| plan. | integer | |
| plan. | integer or null | |
| music_index | integer or null | The plan's index of the music. |
Errors
- 400OpenAI shaped error.
- 401OpenAI shaped error.
- 402OpenAI shaped error.
- 403OpenAI shaped error.
- 404OpenAI shaped error.
- 429OpenAI shaped error.
- 502OpenAI shaped error.
- 503OpenAI 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.