Skip to main content

app.bsky.embed.getEmbedExternalView

#main

Resolve one or more AT-URIs into the data needed to render an enhanced external embed. Returns associatedRefs (strongRefs to embed into a post's external.associatedRefs), the raw associatedRecords, and a hydrated view. The response is empty ({}) when no records were resolvable, or when validation determined the resolved records don't actually back the requested URL; clients should fall back to their own link-card rendering in that case and skip writing strongRefs to the post.

Parameters

PropertyTypeKnown ValuesRequiredDescription
urlstring (uri)-The canonical web URL the embed represents (typically the URL the user pasted into the composer). Used as the returned view's uri. May be used for validation in the future.
urisarray of at-uri--

Output

  • Encoding: application/json
PropertyTypeKnown ValuesRequiredDescription
viewapp.bsky.embed.external#view--
associatedRefsarray of com.atproto.repo.strongRef-StrongRefs (URI+CID) of the Atmosphere records that backed this view, suitable for embedding into a post's external.associatedRefs.
associatedRecordsarray of unknown--