Embeds

Create embed

Create an embed.

post/api/embeds

Request

Base URL: https://docs.weavy.com (the document declares no server; this is the origin it was published from)
URL: https://docs.weavy.com/api/embeds
Auth: none declared

Request body

type'link' | 'photo' | 'rich' | 'video' required

Indicates the type of embed.

titlestring nullable

The title describing the resource.

descriptionstring nullable

Gets or sets a description for the resource.

imagestring nullable

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

urlstring nullable

Url to the embedded resource (when applicable).

actionsstring[] nullable

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

metadataobject nullable

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

htmlstring nullable

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

Response

Created

type'link' | 'photo' | 'rich' | 'video'

Indicates the type of embed.

titlestring nullable

Gets the title describing the resource.

descriptionstring nullable

Gets or sets a description for the resource.

urlstring nullable

Url to the embedded resource (when applicable), e.g. the "scraped" url.

thumbnail_urlstring nullable

Gets an url to a thumbnail image representing the resource.

actionsstring[] nullable

Name of optional card actions (when type is "link").

metadataobject nullable

Additional metadata.

author_namestring nullable

Gets the name of the author/owner of the resource.

author_urlstring nullable

Gets an url for the author/owner of the resource.

provider_namestring nullable

Gets the name of the resource provider.

provider_urlstring nullable

Gets the url of the resource provider.

htmlstring nullable

Gets the html required to display the resource (when type is "rich" or "video").

Changes

No recorded changes to this operation across all 1 revision of this API.