Lexicon Garden

app.bsky.embed.getEmbedExternalView

Resolve one AT-URI record into the data needed to render an enhanced external embed. The records are validated against the requested `url` before any view is built. When validation passes, returns `data`, `associatedRefs` (strongRefs to embed into a post's external.associatedRefs) and the raw `associatedRecords`, plus a legacy `view` for Standard.site records only. When validation fails, only `unverifiedAssociatedRefs` and `unverifiedAssociatedRecords` are returned and no view or data is built. The response is empty (`{}`) when no record URI was usable or the record could not be resolved; clients should fall back to their own link-card rendering in that case and skip writing strongRefs to the post.

Repository @bsky-lexicons.bsky.social did:plc:4v4y5r3lwsbtmsxhile2ljac namespace authority
Details · query
Kindquery
Authorityembed.bsky.app
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

canonicalUri

string · at-uri

The canonical AT URI of the atproto record found on the webpage. When provided, takes precedence over `uris`, which is then ignored.

uris

array

Legacy input for Standard.site callers, ignored when `canonicalUri` is provided. A single record is selected from it: the first site.standard.document URI, otherwise the first site.standard.publication URI. Other entries are ignored; a document's publication is discovered from the document itself.

  • maxLength: 4
itemsstring · at-uri

url

requiredstring · uri

The canonical web URL the embed represents (typically the URL the user pasted into the composer). Used as the returned view's `uri`, and validated against the resolved records.

Output

application/json

associatedRecords

array
itemsunknown

The raw record data of the Atmosphere records selected for persistence, index-aligned with `associatedRefs`. Returned for convenience, to avoid the client separately fetching them. Present only when validation passed.

associatedRefs

array

StrongRefs (URI+CID) of the Atmosphere records selected for persistence in a post, suitable for embedding into its external.associatedRefs: the canonical record, plus only the additional records the service chooses to persist for its collection. This can be a subset of the records used to render `data`, which may also draw on other hydrated records such as recommendations, subscriptions, or favorites. Present only when validation passed. Index-aligned with `associatedRecords`.

itemsref
Reference

data

union

Preferred to #view. Hydrated data of the embed. Present only when validation passed and the records supply enough information to populate the required fields.

One of

unverifiedAssociatedRecords

array
itemsunknown

The raw record data of the persistence-selected Atmosphere records, index-aligned with `unverifiedAssociatedRefs`. Present only when validation failed.

unverifiedAssociatedRefs

array

StrongRefs (URI+CID) of the same persistence-selected Atmosphere records (the canonical record plus chosen additional records) when validation of the requested `url` failed. These must not be written to a post. Index-aligned with `unverifiedAssociatedRecords`.

itemsref
Reference

view

ref

Legacy hydrated view of the embed, returned for Standard.site records only. Present only when validation passed and the records supply enough information to populate the required `viewExternal` fields.

Reference

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • town.delve.embed.getEmbedExternalView

    query not from the namespace authority

    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.

  • town.delve.embed.external

    object not from the namespace authority

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

  • app.bsky.embed.external

    object

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

  • social.colibri.beta.embed.getMetadata

    query

    Fetches and parses a link preview. The AppView fetches the URL on the client's behalf, so the client's address is never exposed to the target site.

  • social.coves.embed.external

    object

    External link embed with optional aggregated sources for megathreads