Skip to main content

app.bsky.embed.external

#main​

A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).

PropertyTypeKnown ValuesRequiredDescription
external#external-✅-

#external​

PropertyTypeKnown ValuesRequiredDescription
uristring (uri)-✅-
titlestring-✅-
descriptionstring-✅-
thumbblob-❌-
associatedRefsarray of com.atproto.repo.strongRef-❌StrongRefs (uri+cid) of the Atmosphere records that backed this view.

#view​

PropertyTypeKnown ValuesRequiredDescription
external#viewExternal-✅-

#viewExternal​

PropertyTypeKnown ValuesRequiredDescription
uristring (uri)-✅-
titlestring-✅-
descriptionstring-✅-
thumbstring (uri)-❌-
createdAtstring (datetime)-❌When the external content was created, if available. Example: a publication date, for an article.
updatedAtstring (datetime)-❌When the external content was updated, if available.
readingTimeinteger-❌Estimated reading time in minutes, if applicable and available.
labelsarray of com.atproto.label.defs#label-❌-
source#viewExternalSource-❌-
associatedRefsarray of com.atproto.repo.strongRef-❌StrongRefs (uri+cid) of the Atmosphere records that backed this view.
associatedProfilesarray of app.bsky.actor.defs#profileViewBasic-❌Profiles of the owners of the Atmosphere records that backed this view.

#viewExternalSource​

The source of an external embed, such as a standard.site publication.

PropertyTypeKnown ValuesRequiredDescription
uristring (uri)-✅URI of the source, if available. Example: the https:// URL of a site.standard.publication record.
iconstring (uri)-❌Fully-qualified URL where an icon representing the source can be fetched. For example, CDN location provided by the App View.
titlestring-✅-
descriptionstring-❌-
theme#viewExternalSourceTheme-❌-

#viewExternalSourceTheme​

The theme colors of an external source, such as a site.standard.publication. These colors may be used when rendering an embed from that source.

PropertyTypeKnown ValuesRequiredDescription
backgroundRGB#colorRGB-❌-
foregroundRGB#colorRGB-❌-
accentRGB#colorRGB-❌-
accentForegroundRGB#colorRGB-❌-

#colorRGB​

RGB color definition, inspired by site.standard.theme.color#rgb

PropertyTypeKnown ValuesRequiredDescription
rinteger-✅-
ginteger-✅-
binteger-✅-

#viewArticle​

PropertyTypeKnown ValuesRequiredDescription
uristring (uri)-✅-
titlestring-✅-
descriptionstring-✅-
createdAtstring (datetime)-❌-
updatedAtstring (datetime)-❌-
labelsarray of com.atproto.label.defs#label-❌-
associatedRefsarray of com.atproto.repo.strongRef-❌-
associatedProfilesarray of app.bsky.actor.defs#profileViewBasic-❌-
imagestring (uri)-❌-
publisher#viewArticlePublication-❌-
readingTimeinteger-❌-
likeCountinteger-❌-
likersarray of app.bsky.actor.defs#profileViewBasic-❌Available profile previews. Selected deterministically by DID; not a ranking.

#viewArticlePublication​

PropertyTypeKnown ValuesRequiredDescription
uristring (uri)-✅-
titlestring-✅-
descriptionstring-✅-
createdAtstring (datetime)-❌-
updatedAtstring (datetime)-❌-
labelsarray of com.atproto.label.defs#label-❌-
associatedRefsarray of com.atproto.repo.strongRef-❌-
associatedProfilesarray of app.bsky.actor.defs#profileViewBasic-❌-
logostring (uri)-❌-
imagestring (uri)-❌-
theme#viewArticlePublicationTheme-❌-
subscriptionCountinteger-❌-
subscribersarray of app.bsky.actor.defs#profileViewBasic-❌Available profile previews. Selected deterministically by DID; not a ranking.

#viewArticlePublicationTheme​

PropertyTypeKnown ValuesRequiredDescription
backgroundstring-❌Hex color string, if available. Example: '#ffffff'.
foregroundstring-❌Hex color string, if available. Example: '#ffffff'.
accentstring-❌Hex color string, if available. Example: '#ffffff'.
accentForegroundstring-❌Hex color string, if available. Example: '#ffffff'.

#viewGallery​

PropertyTypeKnown ValuesRequiredDescription
uristring (uri)-✅-
titlestring-✅-
descriptionstring-✅-
createdAtstring (datetime)-❌-
updatedAtstring (datetime)-❌-
labelsarray of com.atproto.label.defs#label-❌-
associatedRefsarray of com.atproto.repo.strongRef-❌-
associatedProfilesarray of app.bsky.actor.defs#profileViewBasic-❌-
itemsarray of union
#viewGalleryImage
-✅The media items in the gallery. Each item may be of a different type, but all types must be supported by the client.
likeCountinteger-❌-
likersarray of app.bsky.actor.defs#profileViewBasic-❌Available profile previews. Selected deterministically by DID; not a ranking.

#viewGalleryImage​

PropertyTypeKnown ValuesRequiredDescription
thumbnailstring (uri)-✅Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View.
fullsizestring (uri)-✅Fully-qualified URL where a large version of the image can be fetched. May or may not be the exact original blob. For example, CDN location provided by the App View.
altstring-❌Alt text description of the image, for accessibility.
aspectRatioapp.bsky.embed.defs#aspectRatio-❌-

#viewLivestream​

PropertyTypeKnown ValuesRequiredDescription
uristring (uri)-✅-
titlestring-✅-
descriptionstring-✅-
createdAtstring (datetime)-❌-
updatedAtstring (datetime)-❌-
labelsarray of com.atproto.label.defs#label-❌-
associatedRefsarray of com.atproto.repo.strongRef-❌-
associatedProfilesarray of app.bsky.actor.defs#profileViewBasic-❌-
imagestring (uri)-❌-
activeboolean-✅True if the livestream is currently active at the time this view is served, false if it has ended.
startedAtstring (datetime)-❌-
endedAtstring (datetime)-❌-