API reference

API reference · Account

The most a film from one idea could cost

POST/api/studio/film/quoteSigned in session

The plan's writing, every shot and the music at their worst cases, and whether the balance covers the total now. Titles and captions are free. Nothing is held or made.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
idearequiredstringThe idea, a sentence or a paragraph. At most 4000 characters.
shotsrequiredintegerFrom 1 to 12.
secondsrequirednumberSeconds a shot, held to the model's own lengths.
modelrequiredstringThe video model every shot is made on: one that makes a shot from words alone.
stylestringAt most 500 characters.
aspectrequiredstringOne of "16:9", "9:16", "1:1".
musicrequiredobjectMade by a priced music model ({kind: model, model}), the person's own file ({kind: own}) or none.
music.kindrequiredstringOne of "model", "own", "none".
music.modelstring
project_idstringThe 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 200

The quote.

Fields of the 200 answer
FieldTypeWhat it is
objectstringOne of "studio.film.quote".
writing_microsintegerThe plan's writing at its worst case.
writer_modelstring
writer_namestring
shot_microsintegerOne shot at its worst case, every shot the same.
shotsinteger
shot_secondsnumber
music_microsinteger0 for the person's own file or none.
music_secondsnumber
total_microsinteger
fundedbooleanA deposit was made and the balance covers the total now.
depositedboolean
balance_microsinteger

Errors

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

Antimatter