API reference · Account
Make the first shot on us
POST/api/studio/free-shotSigned in session
A sample still and a camera move made into one video shot by the house for a signed in account that has never made a studio or media job: once per wallet, on the sample model at its shortest length with its defaults, nothing held or charged to the account. The job is the account's own (its job list, its take, its stored copy). A failed or stopped shot gives the claim back, three tries a wallet at most. Refused 409 (code free_shot_used or free_shot_not_first), 403 for a frozen or flagged account, 503 (code free_shot_budget) when the house's budget for free shots is spoken for. While the first shot on us is off this door answers the unknown endpoint 404 (code unknown_endpoint). Same origin only.
Request body
application/json, required
| Field | Type | What it is |
|---|---|---|
| stillrequired | string | One of "coast", "fashion", "product". |
| camerarequired | string | One of "push-in", "pull-out", "orbit", "crane-up", "dolly-zoom", "tracking", "handheld", "drone", "whip-pan", "static". |
| aspect_ratio | string | The film's shape; the model's own default where it does not make it. |
| project_id | string | The project (stp_ followed by hex) the shot's stored copy is kept with. |
Example
{
"still": "coast",
"camera": "push-in",
"aspect_ratio": "string",
"project_id": "string"
}Answer 200
The shot, queued.
| Field | Type | What it is |
|---|---|---|
| job | object | |
| job. | string | |
| job. | string | One of "video", "sound", "still". |
| job. | string | |
| job. | string | One of "queued", "in_progress", "completed", "failed", "cancelled". |
| job. | integer or null | |
| job. | integer | The hold while running, the charge once settled. |
| job. | integer | |
| job. | integer or null | |
| job. | integer or null | |
| job. | object or null | |
| job. | string | |
| job. | string | |
| job. | object | Present only when the cheapest provider was unreachable or answered a server error at submit and the job went to the next provider of the same model: how many were tried, why, the first hold, and whether the job is now held dearer. No provider is named. |
| job. | integer | |
| job. | array of string | |
| job. | integer | |
| job. | boolean | |
| job. | object or null | On GET /api/studio/jobs where stored media is on: the stored copy of the output and where it stands. |
| job. | string | |
| job. | string | One of "ready", "awaiting", "failed". |
| job. | object | On GET /api/studio/jobs while the job is queued or running: queued at its provider (with how many requests are ahead of it where the provider's status says one) or being made, and the median seconds this model's takes took from submit to landing over the last 7 days, from at least 5 of them (null with fewer). Nothing is estimated without them. |
| job. | string | One of "queued", "running". |
| job. | integer or null | |
| job. | integer or null | |
| prompt | string | The shot's words, in English, without the camera move, which rides camera. |
| still | string | |
| camera | string | |
| seconds | number | |
| aspect_ratio | string or null |
Errors
- 400OpenAI shaped error.
- 401OpenAI shaped error.
- 403OpenAI shaped error.
- 404OpenAI shaped error.
- 409OpenAI 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.