API reference

API reference · Account

Publish a recipe from your own film

POST/api/studio/recipesSigned in session

A shot recipe or an ad template, with one of the account's own live shares as its sample if wanted. At its link at once, listed once the operator approves it. Personal accounts only, at most 50 an account. Same origin only.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
kindrequiredstringOne of "shot", "ad".
titlerequiredstringAt most 80 characters.
aboutstringAt most 400 characters.
bodyrequiredobject
share_idstring

Example

{
  "kind": "shot",
  "title": "string",
  "body": {
    "prompt": "Say hello in five words.",
    "model": "antimatter/auto"
  }
}

Answer 200

The recipe as published.

Fields of the 200 answer
FieldTypeWhat it is
idstringsrx_ followed by 24 hex digits.
objectstringOne of "studio.recipe".
kindstringOne of "shot", "ad".
titlestring
aboutstring or null
bodyobject
share_idstring or nullThe creator's own live share that plays as its sample.
statestringOne of "pending", "listed", "declined".
pathstringIts page on this origin.
created_atinteger
reviewed_atinteger or null

Errors

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