The Wayback Machine - https://web.archive.org/web/20220128202301/https://docs.joinmastodon.org/methods/oembed/

oembed

For generating OEmbed previews.

get
OEmbed as JSON

https://mastodon.example/api/oembed

Returns: OEmbed metadata
OAuth: Public
Version history:
1.0.0 - added

Request

Query Parameters
url
required
string
URL of a status
maxwidth
optional
number
width of the iframe. Defaults to 400
maxheight
optional
number
height of the iframe. Defaults to null

Response

200: Success

Represents OEmbed “rich” preview, with associated iframe and metadata.

{
  "type": "rich",
  "version": "1.0",
  "title": "New status by trwnh",
  "author_name": "infinite love ⴳ",
  "author_url": "https://mastodon.social/@trwnh",
  "provider_name": "mastodon.social",
  "provider_url": "https://mastodon.social/",
  "cache_age": 86400,
  "html": "<iframe src=\"https://mastodon.social/@trwnh/99664077509711321/embed\" class=\"mastodon-embed\" style=\"max-width: 100%; border: 0\" width=\"400\" allowfullscreen=\"allowfullscreen\"></iframe><script src=\"https://mastodon.social/embed.js\" async=\"async\"></script>",
  "width": 400,
  "height": null
}

404: Not Found

Status not found

{
  "error": "Record not found"
}

Last updated December 27, 2020 · Improve this page