API reference

API reference · Account

An idea written as a director's shot plan

POST/api/studio/directSigned in session

One chat call on the signed in account under strict JSON, billed like a chat turn (the free allowance for an account that never deposited, a hold and settlement for one that did), on ANTIMATTER_STUDIO_PLAN_MODEL or the cheapest priced model from a well known lab that declares JSON output. A title and shots, each with words, a camera move, a look, a length and a suggested video model. What it cost is in micros and x-antimatter-cost-micros, refused or not. Open while jobs are off. Same origin only.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
idearequiredstringThe idea, a sentence or a paragraph. At most 4000 characters.
shotsintegerFrom 1 to 12.
secondsnumberSeconds a shot, when the person has a length in mind.
stylestringAt most 500 characters.
aspectstringOne of "16:9", "9:16", "1:1".

Example

{
  "idea": "string"
}

Answer 200

The plan.

Fields of the 200 answer
FieldTypeWhat it is
titlestring
shotsarray of object
shots[].titlerequiredstring
shots[].promptrequiredstringThe shot as a video prompt, without its camera move.
shots[].camerarequiredstring or nullOne of "push-in", "pull-out", "orbit", "crane-up", "dolly-zoom", "tracking", "handheld", "drone", "whip-pan", "static", null.
shots[].lookrequiredstring or nullA colour grade the shot takes in the cut. One of "teal-orange", "noir", "bleach", "dusk", "nebula", "film", "vivid", null.
shots[].secondsrequirednumber
shots[].modelrequiredstring or nullA video model the studio offers now that makes it from words alone.
shots[].voiceoverstring
microsinteger
modelstring
modelNamestringThe writer's name as a person reads it.

Errors

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

Antimatter