Skip to content
Logo LogoThe AT Protocol SDK
Quickstart Guides Examples Custom lexicons Models Changelog
Logo LogoThe AT Protocol SDK
Quickstart Guides Examples Custom lexicons Models Changelog

🚀 Getting started

  • Installation
  • Quickstart

📚 Guides

  • Guides
    • Concepts
    • Authentication
    • Async
    • Posting
    • Reading
    • Social graph
    • Notifications
    • Direct messages
    • Records and repositories
    • Working with models
    • String formats
    • Resolving identities
    • Firehose
    • Jetstream
    • Error handling
    • Proxies and labelers
    • HTTP and transport
    • Building a feed generator

💡 Examples

  • Examples
    • Basics
    • Advanced usage
    • Firehose
    • Jetstream

🛠 CLI & code generation

  • The atp CLI
    • Custom lexicons
    • Code generator reference

🎛 Clients

  • Client (API)
    • Clients
      • Client
      • Raw Client
      • Base Client
      • Client method mixins
      • HTTP Client
    • Namespace
    • Utils
      • Text Builder (rich text)

📖 Models

  • Lexicons
    • app
      • bsky
        • actor
        • ageassurance
        • bookmark
        • contact
        • draft
        • embed
        • feed
        • graph
        • labeler
        • notification
        • richtext
        • unspecced
        • video
    • chat
      • bsky
        • actor
        • convo
        • embed
        • group
        • moderation
        • notification
    • com
      • atproto
        • admin
        • identity
        • label
        • lexicon
        • moderation
        • repo
        • server
        • sync
        • temp
      • germnetwork
        • declaration
    • internal
      • bsky
        • actor
    • network
      • bsky
        • jetstream
    • site
      • standard
        • graph
        • theme
        • document
        • publication
    • tools
      • ozone
        • communication
        • hosting
        • moderation
        • queue
        • report
        • safelink
        • server
        • set
        • setting
        • signature
        • team
        • verification
  • Core
    • base
    • blob_ref
    • common
    • dot_dict
    • languages
    • models_loader
    • record_registry
    • string_formats
    • type_conversion
    • unknown_type
    • unknown_union
    • utils

📡 Firehose & Jetstream

  • Firehose (data streaming)
    • Frame models
  • Jetstream (data streaming)
    • Frame models
    • Archive replay
  • Subscription
    • Subscription client
    • Frame models
    • Websocket client

🧱 Advanced

  • Core
    • NSID (NameSpaced ID)
    • CID decoder
    • AT URI Scheme
    • CAR reader
    • DAG-CBOR
    • DID Document
  • Identity (DID and Handle resolvers)
    • ID Resolver
    • Handle Resolver
    • DID Resolver
    • Cache
    • AT Protocol Data
  • Crypto
    • DID
    • Multibase
    • Verify signature
  • Server
    • Auth
  • Lexicon
    • Parser
    • Models
  • Exceptions

🛠 Development

  • Change Log
  • Security Policy
  • Licence

🔗 Project Links

  • GitHub
  • PyPI
  • Author
  • AT Protocol Docs
  • Bluesky Docs
  • Discord Bluesky API
The AT Protocol SDK
/
Lexicons
/
chat
/
chat.bsky
/
chat.bsky.embed
/
chat.bsky.embed.joinLink

chat.bsky.embed.joinLink

Join link.

class atproto_client.models.chat.bsky.embed.join_link.Main

Bases: ModelBase

Definition model for chat.bsky.embed.joinLink.

field code: str [Required]

The join link code.

class atproto_client.models.chat.bsky.embed.join_link.View

Bases: ModelBase

Definition model for chat.bsky.embed.joinLink.

field join_link_preview: models.ChatBskyGroupDefs.JoinLinkPreviewView | models.ChatBskyGroupDefs.DisabledJoinLinkPreviewView | models.ChatBskyGroupDefs.InvalidJoinLinkPreviewView | DotDict [Required]

Join link preview.

Constraints:
  • __module__ = atproto_client.models.unknown_union

  • __firstlineno__ = 17

  • __doc__ = Annotation for open ref unions: an unrecognized $type falls back to DotDict. Applied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated by py_type as usual, so a known type that fails validation still raises. Only a $type that matches no member, or a missing one, degrades to a DotDict.

  • __get_pydantic_core_schema__ = <bound method UnknownUnionFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownUnionFallback’>>

  • __static_attributes__ = ()

  • __dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 17, ‘__doc__’: “Annotation for open ref unions: an unrecognized $type falls back to DotDict.nnApplied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated byn``py_type`` as usual, so a known type that fails validation still raises. Only a $type thatnmatches no member, or a missing one, degrades to a DotDict.n”, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownUnionFallback.__get_pydantic_core_schema__ at 0x786e5ef30c20>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownUnionFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>}

  • __weakref__ = <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>

chat.bsky.embed
chat.bsky.group

On this page

  • Main
    • Main.code
  • View
    • View.join_link_preview

© 2023-2026 Ilya (Marshal) 🦁