API reference

API reference · Account

Rename a preset or replace its recipe

PATCH/api/studio/presets/{id}Signed in session

Parameters

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

Request body

application/json, required

Request body fields
FieldTypeWhat it is
namestringAt most 80 characters.
recipeobjectWhat the preset sets on a shot; at least one field.
recipe.promptstringAt most 4000 characters.
recipe.camerastring or nullOne of "push-in", "pull-out", "orbit", "crane-up", "dolly-zoom", "tracking", "handheld", "drone", "whip-pan", "static", null.
recipe.lookstringOne of "none", "teal-orange", "noir", "bleach", "dusk", "nebula", "film", "vivid".
recipe.lensstringOne of "wide", "normal", "portrait", "macro", "anamorphic", "tele", "fisheye".
recipe.stockstringOne of "portrait", "tungsten", "slide", "mono", "super8", "16mm".
recipe.modelstring
recipe.secondsnumber

Example

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

Answer 200

The preset.

Fields of the 200 answer
FieldTypeWhat it is
idstringspr_ followed by hex.
objectstringOne of "studio.preset".
namestring
recipeobjectWhat the preset sets on a shot; at least one field.
recipe.promptstringAt most 4000 characters.
recipe.camerastring or nullOne of "push-in", "pull-out", "orbit", "crane-up", "dolly-zoom", "tracking", "handheld", "drone", "whip-pan", "static", null.
recipe.lookstringOne of "none", "teal-orange", "noir", "bleach", "dusk", "nebula", "film", "vivid".
recipe.lensstringOne of "wide", "normal", "portrait", "macro", "anamorphic", "tele", "fisheye".
recipe.stockstringOne of "portrait", "tungsten", "slide", "mono", "super8", "16mm".
recipe.modelstring
recipe.secondsnumber
created_atinteger
updated_atinteger

Errors

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