Antimatter

POST/api/studio/sharesSigned in session

One ready clip the account keeps, by its stored id or by the job that made it, with the prompt and model words the page shows. A second call for the same take answers the live link. A file whose copy is still being made is 409 content_not_ready, one whose copy could not be made 409 content_failed, a picture or a sound 400 not_a_take, past 500 live links 409 too_many_shares. A 404 with code storage_off while stored media is switched off (ANTIMATTER_STUDIO_STORAGE). The signed in account; same origin for a write.

Request body

application/json, required

Request body fields
Field	Type	What it is
asset_id	string
job_id	string
prompt	string	At most 2000 characters.
model	string	At most 200 characters.
title	string	At most 100 characters.
settings	object
settings.model	string
settings.camera	string
settings.look	string
settings.seconds	number
settings.aspect	string

Example

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

Answer 200

The live link this take already had.

Fields of the 200 answer
Field	Type	What it is
idrequired	string
objectrequired	string	One of "studio.share".
asset_idrequired	string
job_idrequired	string or null	The job that made the take, when a job did.
doc_asset_idrequired	string or null	The editor's own asset id the file was uploaded under, when one was named.
promptrequired	string or null
modelrequired	string or null
titlerequired	string or null	The title the sharer gave the link, on its page and its card.
settingsrequired	object or null	The take's settings, which a remix from the public feed starts from.
settings.model	string
settings.camera	string
settings.look	string
settings.seconds	number
settings.aspect	string
posterrequired	boolean	A poster frame is kept for the link card.
listed_atrequired	integer or null	Listed in the public feed since (unix seconds), by the sharer's choice.
hiddenrequired	boolean	The operator hid the listing from the feed.
viewsrequired	integer	Visitors who watched it from the feed or its page, each once a UTC day.
urlrequired	string	The page's path on this origin, /studio/share/{id}.
created_atrequired	integer
revoked_atrequired	integer or null

Answer 201

The link.

Fields of the 201 answer
Field	Type	What it is
idrequired	string
objectrequired	string	One of "studio.share".
asset_idrequired	string
job_idrequired	string or null	The job that made the take, when a job did.
doc_asset_idrequired	string or null	The editor's own asset id the file was uploaded under, when one was named.
promptrequired	string or null
modelrequired	string or null
titlerequired	string or null	The title the sharer gave the link, on its page and its card.
settingsrequired	object or null	The take's settings, which a remix from the public feed starts from.
settings.model	string
settings.camera	string
settings.look	string
settings.seconds	number
settings.aspect	string
posterrequired	boolean	A poster frame is kept for the link card.
listed_atrequired	integer or null	Listed in the public feed since (unix seconds), by the sharer's choice.
hiddenrequired	boolean	The operator hid the listing from the feed.
viewsrequired	integer	Visitors who watched it from the feed or its page, each once a UTC day.
urlrequired	string	The page's path on this origin, /studio/share/{id}.
created_atrequired	integer
revoked_atrequired	integer or null

Errors

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