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.

class atproto_client.models.app.bsky.embed.get_embed_external_view.Params

Bases: ParamsModelBase

Parameters model for app.bsky.embed.getEmbedExternalView.

field canonical_uri: AtUri | None = None

field uris: List[AtUri] | None = None

Constraints:

max_length = 4

field url: Uri [Required]: 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.

class atproto_client.models.app.bsky.embed.get_embed_external_view.ParamsDict

Bases: TypedDict

url: 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.

canonical_uri: NotRequired[AtUri | None]: The canonical AT URI of the atproto record found on the webpage. When provided, takes precedence over uris, which is then ignored.

uris: NotRequired[List[AtUri] | None]: 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.

class atproto_client.models.app.bsky.embed.get_embed_external_view.Response

Bases: ResponseModelBase

Output data model for app.bsky.embed.getEmbedExternalView.

field associated_records: List[UnknownType] | None = None

field associated_refs: List[models.ComAtprotoRepoStrongRef.Main] | None = None

field data: models.AppBskyEmbedExternal.ViewArticle | models.AppBskyEmbedExternal.ViewArticlePublication | models.AppBskyEmbedExternal.ViewGallery | models.AppBskyEmbedExternal.ViewLivestream | DotDict | None = None: Preferred to #view. Hydrated data of the embed. Present only when validation passed and the records supply enough information to populate the required fields.

field unverified_associated_records: List[UnknownType] | None = None

field unverified_associated_refs: List[models.ComAtprotoRepoStrongRef.Main] | None = None

field view: models.AppBskyEmbedExternal.View | None = None