1. Reference
  2. Web API
  3. Embeds

Embeds

The Embeds API converts URLs into embedded videos, images and rich article previews.

Create embed

Create an embed.

POST /api/embeds
Body parameters
type string required

Indicates the type of embed.

title string

The title describing the resource.

description string

Gets or sets a description for the resource.

image string

The embed image. Can be a public URL, a base64 encoded data URI or a blob id.

url string

Url to the embedded resource (when applicable).

actions array of strings

Optional embed actions (when type is "link"). Will be rendered as buttons in the embed card, e.g. ["View", "Share", "Download"].

metadata object

Additional metadata properties, e.g. { "color": "blue", "size": "XL" }.

html string

The html required to display the resource (when type is "rich" or "video"). Must be a single