Embed Resource

An embed represents rich content extracted from URLs in messages, such as link previews, images, videos, and GIFs.

Embed Object

Field	Type	Description
`type` ?	`string`	Embed type (e.g. "link", "image", "gifv", "video")
`provider` ?	`string`	Provider name (e.g. "YouTube", "GitHub")
`title` ?	`string`	Embed title
`description` ?	`string`	Embed description
`url` ?	`string`	Source URL
`timestamp` ?	`string`	ISO 8601 timestamp
`color` ?	EmbedColor	Color gradient for the embed accent
`footer` ?	EmbedFooter	Footer text and icon
`image` ?	EmbedMedia	Image content
`thumbnail` ?	EmbedMedia	Thumbnail image
`video` ?	EmbedMedia	Video content
`author` ?	EmbedAuthor	Author information
`fields` ?	EmbedField[]	Additional structured fields

EmbedMedia Object

Field	Type	Description
`url`	`string`	Media URL
`width` ?	`integer`	Media width in pixels
`height` ?	`integer`	Media height in pixels

EmbedAuthor Object

Field	Type	Description
`name`	`string`	Author name
`url` ?	`string`	Author URL
`icon_url` ?	`string`	Author icon URL

EmbedFooter Object

Field	Type	Description
`text`	`string`	Footer text
`icon_url` ?	`string`	Footer icon URL

EmbedField Object

Field	Type	Description
`name`	`string`	Field name
`value`	`string`	Field value
`inline`	`boolean`	Whether the field should be displayed inline

EmbedColor Object

Field	Type	Description
`color_from` ?	`integer`	Starting color value
`color_via` ?	`integer`	Middle color value for gradient
`color_to` ?	`integer`	Ending color value for gradient

Example

{
  "type": "link",
  "provider": "YouTube",
  "title": "Never Gonna Give You Up",
  "description": "The official video for "Never Gonna Give You Up" by Rick Astley.",
  "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  "timestamp": null,
  "color": {
    "color_from": 16711680,
    "color_via": null,
    "color_to": null
  },
  "footer": null,
  "image": null,
  "thumbnail": {
    "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
    "width": 1280,
    "height": 720
  },
  "video": {
    "url": "https://www.youtube.com/embed/dQw4w9WgXcQ",
    "width": 1280,
    "height": 720
  },
  "author": {
    "name": "Rick Astley",
    "url": "https://www.youtube.com/@RickAstleyYT",
    "icon_url": null
  },
  "fields": []
}