API reference

API reference · Account

oEmbed for a shared take

GET/api/studio/oembedNo key

oEmbed 1.0, type video, the embed's iframe as html, sized inside maxwidth and maxheight, the poster as the thumbnail; for the share page in any language or the embed on this site's host. 404 not_found otherwise, 501 format_unsupported for anything but JSON.

Parameters

Path and query parameters
FieldTypeWhat it is
url (query)requiredstring
maxwidth (query)integer
maxheight (query)integer
format (query)stringOne of "json".

Answer 200

The oEmbed answer.

The answer's fields are not named in the document.

Errors

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