API reference

API reference · Account

Keep a poster frame for a link

PUT/api/studio/shares/{id}/posterSigned in session

The sharer's own browser draws it from the take: WebP or JPEG, its bytes the body, at most 256 KiB, checked by its bytes. A second poster replaces the first. The signed in account; same origin for a write.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe link's id: 22 characters of base64url.

Request body

image/webp, required

The document names no fields for this body.

Answer 200

The link, its poster kept.

Fields of the 200 answer
FieldTypeWhat it is
idrequiredstring
objectrequiredstringOne of "studio.share".
asset_idrequiredstring
job_idrequiredstring or nullThe job that made the take, when a job did.
doc_asset_idrequiredstring or nullThe editor's own asset id the file was uploaded under, when one was named.
promptrequiredstring or null
modelrequiredstring or null
titlerequiredstring or nullThe title the sharer gave the link, on its page and its card.
settingsrequiredobject or nullThe take's settings, which a remix from the public feed starts from.
settings.modelstring
settings.camerastring
settings.lookstring
settings.secondsnumber
settings.aspectstring
posterrequiredbooleanA poster frame is kept for the link card.
listed_atrequiredinteger or nullListed in the public feed since (unix seconds), by the sharer's choice.
hiddenrequiredbooleanThe operator hid the listing from the feed.
viewsrequiredintegerVisitors who watched it from the feed or its page, each once a UTC day.
urlrequiredstringThe page's path on this origin, /studio/share/{id}.
created_atrequiredinteger
revoked_atrequiredinteger or null

Errors

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

Antimatter