Interface

APIEmbed

Full embed object as returned by the API / gateway.

Properties

audio?: APIEmbedMedia | null

Audio media (response/unfurl only — not on create).

author?: APIEmbedAuthor | null

Author block.

children?: APIEmbedChild[] | null

Nested embeds from unfurlers

color?: number | null

Accent color as a 24-bit integer (0xRRGGBB).

description?: string | null

Body description (markdown).

fields?: APIEmbedField[] | null

Field rows.

image?: APIEmbedMedia | null

Large image.

nsfw?: boolean | null

Whether the embed is marked NSFW.

provider?: APIEmbedAuthor | null

Provider / site name block (same shape as author).

thumbnail?: APIEmbedMedia | null

Small thumbnail.

timestamp?: string | null

ISO-8601 timestamp shown in the embed.

title?: string | null

Title text.

type?: EmbedType

Render kind; see EmbedType.

url?: string | null

Canonical URL associated with the embed.

video?: APIEmbedMedia | null

Video media (response/unfurl only — not on create).