API reference

API reference · Account

A shot's words rewritten for the model it is made with

POST/api/studio/direct/refineSigned in session

One chat call on the signed in account under strict JSON, by the director plan's writer and billed like it: the shot's words rewritten as a prompt for the named video model, keeping what the person asked for, with the camera move and what the take should not show kept apart. Nothing is kept. What it cost is in micros and x-antimatter-cost-micros, refused or not. Same origin only.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
promptrequiredstringThe shot's words as the person wrote them. At most 4000 characters.
modelrequiredstringThe video model the shot will be made with.
camerastring or nullThe shot's camera move, set apart from the words. One of "push-in", "pull-out", "orbit", "crane-up", "dolly-zoom", "tracking", "handheld", "drone", "whip-pan", "static", null.
secondsnumber
aspectstringOne of "16:9", "9:16", "1:1".
negativestringWhat the take should not show. At most 2000 characters.

Example

{
  "prompt": "Say hello in five words.",
  "model": "antimatter/auto"
}

Answer 200

The words.

Fields of the 200 answer
FieldTypeWhat it is
promptstring
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