API reference

API reference · Account

A pasted script broken into scenes and shots

POST/api/studio/direct/scriptSigned in session

One chat call on the signed in account under strict JSON, by the director plan's writer and billed like it: the script in its order as scenes, each with a heading and its shots, every line of dialogue in the shot it is said in with who says it. A line said on screen is marked lipsync only while a lip sync model and stored media are on. Nothing is kept. 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
scriptrequiredstringThe script as the person pasted it: a screenplay or plain prose. At most 20000 characters.
secondsnumberSeconds a shot, when the person has a length in mind.
stylestringAt most 500 characters.
aspectstringOne of "16:9", "9:16", "1:1".

Example

{
  "script": "string",
  "seconds": 0,
  "style": "string",
  "aspect": "16:9"
}

Answer 200

The scenes.

Fields of the 200 answer
FieldTypeWhat it is
titlestring
scenesarray of object
scenes[].headingstring
scenes[].shotsarray of object
scenes[].shots[].titlerequiredstring
scenes[].shots[].promptrequiredstringThe shot as a video prompt, without its camera move.
scenes[].shots[].camerarequiredstring or nullOne of "push-in", "pull-out", "orbit", "crane-up", "dolly-zoom", "tracking", "handheld", "drone", "whip-pan", "static", null.
scenes[].shots[].lookrequiredstring or nullA colour grade the shot takes in the cut. One of "teal-orange", "noir", "bleach", "dusk", "nebula", "film", "vivid", null.
scenes[].shots[].secondsrequirednumber
scenes[].shots[].modelrequiredstring or nullA video model the studio offers now that makes it from words alone.
scenes[].shots[].voiceoverstringThe line said in the shot, word for word.
scenes[].shots[].speakerstringWho says the line; absent for a narrator.
scenes[].shots[].facebooleanThe line is said on screen by a face the shot shows.
scenes[].shots[].lipsyncbooleanThe line is said on screen and a lip sync model is offered now; absent, it is speech heard over the shot.
lipsyncbooleanA lip sync model is offered now.
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