app.bsky.embed.getEmbedExternalView

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.

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

Bases: ParamsModelBase

Parameters model for app.bsky.embed.getEmbedExternalView.

field uris: List[AtUri] [Required]

AT-URIs of any Atmosphere records that can be resolved and used to construct #externalView views. Example: a site.standard.document and optionally its associated site.standard.publication.

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. May be used for validation in the future.

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

Bases: TypedDict

uris: List[AtUri]

AT-URIs of any Atmosphere records that can be resolved and used to construct #externalView views. Example: a site.standard.document and optionally its associated site.standard.publication.

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. May be used for validation in the future.

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 view: models.AppBskyEmbedExternal.View | None = None