API reference

API reference · Account

What a render plan would be held at

POST/api/studio/projects/{id}/plans/quoteSigned in session

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. The signed in account.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe project's id, stp_ followed by hex.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
shotsrequiredarray of object
shots[].kindrequiredstringA clip, a sound, or a still: a picture for a shot to start from. One of "video", "sound", "still".
shots[].modelrequiredstring
shots[].promptrequiredstring
shots[].secondsnumber
shots[].resolutionstring
shots[].aspect_ratiostring
shots[].audioboolean
shots[].imagestringThe 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[].image_assetstringA 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[].referencesarray of stringReference 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[].end_imagestringThe last frame, for a model whose endFrame is true: a picture as references takes one.
shots[].negative_promptstring
shots[].seedinteger
shots[].lyricsstring
shots[].camerastring or nullA 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[].titlestring
picturesarray of stringStarting 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.

Fields of the 200 answer
FieldTypeWhat it is
objectstringOne of "studio.plan.quote".
total_microsintegerEvery shot at its worst case, a dearer provider of the same model included, markup on.
shotsarray of object
shots[].indexinteger
shots[].modelstring
shots[].microsinteger
fundedbooleanWhether the balance covers the whole total now and the account ever deposited.
depositedbooleanWhether the account ever deposited: only a deposited balance pays for a plan, never the free allowance.
balance_microsinteger

Errors

  • 400OpenAI shaped error.
  • 401OpenAI 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.

Antimatter