Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
The AT Protocol SDK
Logo
The AT Protocol SDK
  • Getting Started
    • Introduction
    • Requirements
    • Installing
    • Quick start
    • SDK structure
    • Documentation
    • Getting help
    • Advanced usage
  • Examples

SDK

  • Direct Messages (Chats)
  • Client (API)
    • Clients
      • Client
      • Raw Client
      • Base Client
      • HTTP Client
    • Namespace
    • Models
      • base
      • app
        • app.bsky
          • app.bsky.actor
            • app.bsky.actor.defs
            • app.bsky.actor.get_preferences
            • app.bsky.actor.get_profile
            • app.bsky.actor.get_profiles
            • app.bsky.actor.get_suggestions
            • app.bsky.actor.profile
            • app.bsky.actor.put_preferences
            • app.bsky.actor.search_actors
            • app.bsky.actor.search_actors_typeahead
            • app.bsky.actor.status
          • app.bsky.ageassurance
            • app.bsky.ageassurance.begin
            • app.bsky.ageassurance.defs
            • app.bsky.ageassurance.get_config
            • app.bsky.ageassurance.get_state
          • app.bsky.bookmark
            • app.bsky.bookmark.create_bookmark
            • app.bsky.bookmark.defs
            • app.bsky.bookmark.delete_bookmark
            • app.bsky.bookmark.get_bookmarks
          • app.bsky.contact
            • app.bsky.contact.defs
            • app.bsky.contact.dismiss_match
            • app.bsky.contact.get_matches
            • app.bsky.contact.get_sync_status
            • app.bsky.contact.import_contacts
            • app.bsky.contact.remove_data
            • app.bsky.contact.send_notification
            • app.bsky.contact.start_phone_verification
            • app.bsky.contact.verify_phone
          • app.bsky.draft
            • app.bsky.draft.create_draft
            • app.bsky.draft.defs
            • app.bsky.draft.delete_draft
            • app.bsky.draft.get_drafts
            • app.bsky.draft.update_draft
          • app.bsky.embed
            • app.bsky.embed.defs
            • app.bsky.embed.external
            • app.bsky.embed.gallery
            • app.bsky.embed.get_embed_external_view
            • app.bsky.embed.images
            • app.bsky.embed.record
            • app.bsky.embed.record_with_media
            • app.bsky.embed.video
          • app.bsky.feed
            • app.bsky.feed.defs
            • app.bsky.feed.describe_feed_generator
            • app.bsky.feed.generator
            • app.bsky.feed.get_actor_feeds
            • app.bsky.feed.get_actor_likes
            • app.bsky.feed.get_author_feed
            • app.bsky.feed.get_feed
            • app.bsky.feed.get_feed_generator
            • app.bsky.feed.get_feed_generators
            • app.bsky.feed.get_feed_skeleton
            • app.bsky.feed.get_likes
            • app.bsky.feed.get_list_feed
            • app.bsky.feed.get_post_thread
            • app.bsky.feed.get_posts
            • app.bsky.feed.get_quotes
            • app.bsky.feed.get_reposted_by
            • app.bsky.feed.get_suggested_feeds
            • app.bsky.feed.get_timeline
            • app.bsky.feed.like
            • app.bsky.feed.post
            • app.bsky.feed.postgate
            • app.bsky.feed.repost
            • app.bsky.feed.search_posts
            • app.bsky.feed.send_interactions
            • app.bsky.feed.threadgate
          • app.bsky.graph
            • app.bsky.graph.block
            • app.bsky.graph.defs
            • app.bsky.graph.follow
            • app.bsky.graph.get_actor_starter_packs
            • app.bsky.graph.get_blocks
            • app.bsky.graph.get_followers
            • app.bsky.graph.get_follows
            • app.bsky.graph.get_known_followers
            • app.bsky.graph.get_list
            • app.bsky.graph.get_list_blocks
            • app.bsky.graph.get_list_mutes
            • app.bsky.graph.get_lists
            • app.bsky.graph.get_lists_with_membership
            • app.bsky.graph.get_mutes
            • app.bsky.graph.get_relationships
            • app.bsky.graph.get_starter_pack
            • app.bsky.graph.get_starter_packs
            • app.bsky.graph.get_starter_packs_with_membership
            • app.bsky.graph.get_suggested_follows_by_actor
            • app.bsky.graph.list
            • app.bsky.graph.listblock
            • app.bsky.graph.listitem
            • app.bsky.graph.mute_actor
            • app.bsky.graph.mute_actor_list
            • app.bsky.graph.mute_thread
            • app.bsky.graph.search_starter_packs
            • app.bsky.graph.starterpack
            • app.bsky.graph.unmute_actor
            • app.bsky.graph.unmute_actor_list
            • app.bsky.graph.unmute_thread
            • app.bsky.graph.verification
          • app.bsky.labeler
            • app.bsky.labeler.defs
            • app.bsky.labeler.get_services
            • app.bsky.labeler.service
          • app.bsky.notification
            • app.bsky.notification.declaration
            • app.bsky.notification.defs
            • app.bsky.notification.get_preferences
            • app.bsky.notification.get_unread_count
            • app.bsky.notification.list_activity_subscriptions
            • app.bsky.notification.list_notifications
            • app.bsky.notification.put_activity_subscription
            • app.bsky.notification.put_preferences
            • app.bsky.notification.put_preferences_v2
            • app.bsky.notification.register_push
            • app.bsky.notification.unregister_push
            • app.bsky.notification.update_seen
          • app.bsky.richtext
            • app.bsky.richtext.facet
          • app.bsky.unspecced
            • app.bsky.unspecced.defs
            • app.bsky.unspecced.get_age_assurance_state
            • app.bsky.unspecced.get_config
            • app.bsky.unspecced.get_onboarding_suggested_starter_packs
            • app.bsky.unspecced.get_onboarding_suggested_starter_packs_skeleton
            • app.bsky.unspecced.get_onboarding_suggested_users_skeleton
            • app.bsky.unspecced.get_popular_feed_generators
            • app.bsky.unspecced.get_post_thread_other_v2
            • app.bsky.unspecced.get_post_thread_v2
            • app.bsky.unspecced.get_suggested_feeds
            • app.bsky.unspecced.get_suggested_feeds_skeleton
            • app.bsky.unspecced.get_suggested_onboarding_users
            • app.bsky.unspecced.get_suggested_starter_packs
            • app.bsky.unspecced.get_suggested_starter_packs_skeleton
            • app.bsky.unspecced.get_suggested_users
            • app.bsky.unspecced.get_suggested_users_for_discover
            • app.bsky.unspecced.get_suggested_users_for_discover_skeleton
            • app.bsky.unspecced.get_suggested_users_for_explore
            • app.bsky.unspecced.get_suggested_users_for_explore_skeleton
            • app.bsky.unspecced.get_suggested_users_for_see_more
            • app.bsky.unspecced.get_suggested_users_for_see_more_skeleton
            • app.bsky.unspecced.get_suggested_users_skeleton
            • app.bsky.unspecced.get_suggestions_skeleton
            • app.bsky.unspecced.get_tagged_suggestions
            • app.bsky.unspecced.get_trending_topics
            • app.bsky.unspecced.get_trends
            • app.bsky.unspecced.get_trends_skeleton
            • app.bsky.unspecced.init_age_assurance
            • app.bsky.unspecced.search_actors_skeleton
            • app.bsky.unspecced.search_posts_skeleton
            • app.bsky.unspecced.search_starter_packs_skeleton
          • app.bsky.video
            • app.bsky.video.defs
            • app.bsky.video.get_job_status
            • app.bsky.video.get_upload_limits
            • app.bsky.video.upload_video
      • com
        • com.atproto
          • com.atproto.admin
            • com.atproto.admin.defs
            • com.atproto.admin.delete_account
            • com.atproto.admin.disable_account_invites
            • com.atproto.admin.disable_invite_codes
            • com.atproto.admin.enable_account_invites
            • com.atproto.admin.get_account_info
            • com.atproto.admin.get_account_infos
            • com.atproto.admin.get_invite_codes
            • com.atproto.admin.get_subject_status
            • com.atproto.admin.search_accounts
            • com.atproto.admin.send_email
            • com.atproto.admin.update_account_email
            • com.atproto.admin.update_account_handle
            • com.atproto.admin.update_account_password
            • com.atproto.admin.update_account_signing_key
            • com.atproto.admin.update_subject_status
          • com.atproto.identity
            • com.atproto.identity.defs
            • com.atproto.identity.get_recommended_did_credentials
            • com.atproto.identity.refresh_identity
            • com.atproto.identity.request_plc_operation_signature
            • com.atproto.identity.resolve_did
            • com.atproto.identity.resolve_handle
            • com.atproto.identity.resolve_identity
            • com.atproto.identity.sign_plc_operation
            • com.atproto.identity.submit_plc_operation
            • com.atproto.identity.update_handle
          • com.atproto.label
            • com.atproto.label.defs
            • com.atproto.label.query_labels
            • com.atproto.label.subscribe_labels
          • com.atproto.lexicon
            • com.atproto.lexicon.resolve_lexicon
            • com.atproto.lexicon.schema
          • com.atproto.moderation
            • com.atproto.moderation.create_report
            • com.atproto.moderation.defs
          • com.atproto.repo
            • com.atproto.repo.apply_writes
            • com.atproto.repo.create_record
            • com.atproto.repo.defs
            • com.atproto.repo.delete_record
            • com.atproto.repo.describe_repo
            • com.atproto.repo.get_record
            • com.atproto.repo.import_repo
            • com.atproto.repo.list_missing_blobs
            • com.atproto.repo.list_records
            • com.atproto.repo.put_record
            • com.atproto.repo.strong_ref
            • com.atproto.repo.upload_blob
          • com.atproto.server
            • com.atproto.server.activate_account
            • com.atproto.server.check_account_status
            • com.atproto.server.confirm_email
            • com.atproto.server.create_account
            • com.atproto.server.create_app_password
            • com.atproto.server.create_invite_code
            • com.atproto.server.create_invite_codes
            • com.atproto.server.create_session
            • com.atproto.server.deactivate_account
            • com.atproto.server.defs
            • com.atproto.server.delete_account
            • com.atproto.server.delete_session
            • com.atproto.server.describe_server
            • com.atproto.server.get_account_invite_codes
            • com.atproto.server.get_service_auth
            • com.atproto.server.get_session
            • com.atproto.server.list_app_passwords
            • com.atproto.server.refresh_session
            • com.atproto.server.request_account_delete
            • com.atproto.server.request_email_confirmation
            • com.atproto.server.request_email_update
            • com.atproto.server.request_password_reset
            • com.atproto.server.reserve_signing_key
            • com.atproto.server.reset_password
            • com.atproto.server.revoke_app_password
            • com.atproto.server.update_email
          • com.atproto.sync
            • com.atproto.sync.defs
            • com.atproto.sync.get_blob
            • com.atproto.sync.get_blocks
            • com.atproto.sync.get_checkout
            • com.atproto.sync.get_head
            • com.atproto.sync.get_host_status
            • com.atproto.sync.get_latest_commit
            • com.atproto.sync.get_record
            • com.atproto.sync.get_repo
            • com.atproto.sync.get_repo_status
            • com.atproto.sync.list_blobs
            • com.atproto.sync.list_hosts
            • com.atproto.sync.list_repos
            • com.atproto.sync.list_repos_by_collection
            • com.atproto.sync.notify_of_update
            • com.atproto.sync.request_crawl
            • com.atproto.sync.subscribe_repos
          • com.atproto.temp
            • com.atproto.temp.add_reserved_handle
            • com.atproto.temp.check_handle_availability
            • com.atproto.temp.check_signup_queue
            • com.atproto.temp.dereference_scope
            • com.atproto.temp.fetch_labels
            • com.atproto.temp.request_phone_verification
            • com.atproto.temp.revoke_account_credentials
        • com.germnetwork
          • com.germnetwork.declaration
      • chat
        • chat.bsky
          • chat.bsky.actor
            • chat.bsky.actor.declaration
            • chat.bsky.actor.defs
            • chat.bsky.actor.delete_account
            • chat.bsky.actor.export_account_data
            • chat.bsky.actor.get_status
          • chat.bsky.convo
            • chat.bsky.convo.accept_convo
            • chat.bsky.convo.add_reaction
            • chat.bsky.convo.defs
            • chat.bsky.convo.delete_message_for_self
            • chat.bsky.convo.get_convo
            • chat.bsky.convo.get_convo_availability
            • chat.bsky.convo.get_convo_for_members
            • chat.bsky.convo.get_convo_members
            • chat.bsky.convo.get_log
            • chat.bsky.convo.get_messages
            • chat.bsky.convo.get_unread_counts
            • chat.bsky.convo.leave_convo
            • chat.bsky.convo.list_convo_requests
            • chat.bsky.convo.list_convos
            • chat.bsky.convo.lock_convo
            • chat.bsky.convo.mute_convo
            • chat.bsky.convo.remove_reaction
            • chat.bsky.convo.send_message
            • chat.bsky.convo.send_message_batch
            • chat.bsky.convo.unlock_convo
            • chat.bsky.convo.unmute_convo
            • chat.bsky.convo.update_all_read
            • chat.bsky.convo.update_read
          • chat.bsky.embed
            • chat.bsky.embed.join_link
          • chat.bsky.group
            • chat.bsky.group.add_members
            • chat.bsky.group.approve_join_request
            • chat.bsky.group.create_group
            • chat.bsky.group.create_join_link
            • chat.bsky.group.defs
            • chat.bsky.group.disable_join_link
            • chat.bsky.group.edit_group
            • chat.bsky.group.edit_join_link
            • chat.bsky.group.enable_join_link
            • chat.bsky.group.get_join_link_previews
            • chat.bsky.group.list_join_requests
            • chat.bsky.group.list_mutual_groups
            • chat.bsky.group.reject_join_request
            • chat.bsky.group.remove_members
            • chat.bsky.group.request_join
            • chat.bsky.group.update_join_requests_read
            • chat.bsky.group.withdraw_join_request
          • chat.bsky.moderation
            • chat.bsky.moderation.defs
            • chat.bsky.moderation.get_actor_metadata
            • chat.bsky.moderation.get_convo
            • chat.bsky.moderation.get_convo_members
            • chat.bsky.moderation.get_convos
            • chat.bsky.moderation.get_message_context
            • chat.bsky.moderation.subscribe_mod_events
            • chat.bsky.moderation.update_actor_access
      • site
        • site.standard
          • site.standard.graph
            • site.standard.graph.recommend
            • site.standard.graph.subscription
          • site.standard.theme
            • site.standard.theme.basic
            • site.standard.theme.color
          • site.standard.document
          • site.standard.publication
      • tools
        • tools.ozone
          • tools.ozone.communication
            • tools.ozone.communication.create_template
            • tools.ozone.communication.defs
            • tools.ozone.communication.delete_template
            • tools.ozone.communication.list_templates
            • tools.ozone.communication.update_template
          • tools.ozone.hosting
            • tools.ozone.hosting.get_account_history
          • tools.ozone.moderation
            • tools.ozone.moderation.cancel_scheduled_actions
            • tools.ozone.moderation.defs
            • tools.ozone.moderation.emit_event
            • tools.ozone.moderation.get_account_timeline
            • tools.ozone.moderation.get_event
            • tools.ozone.moderation.get_record
            • tools.ozone.moderation.get_records
            • tools.ozone.moderation.get_repo
            • tools.ozone.moderation.get_reporter_stats
            • tools.ozone.moderation.get_repos
            • tools.ozone.moderation.get_subjects
            • tools.ozone.moderation.list_scheduled_actions
            • tools.ozone.moderation.query_events
            • tools.ozone.moderation.query_statuses
            • tools.ozone.moderation.schedule_action
            • tools.ozone.moderation.search_repos
          • tools.ozone.queue
            • tools.ozone.queue.assign_moderator
            • tools.ozone.queue.create_queue
            • tools.ozone.queue.defs
            • tools.ozone.queue.delete_queue
            • tools.ozone.queue.get_assignments
            • tools.ozone.queue.list_queues
            • tools.ozone.queue.route_reports
            • tools.ozone.queue.unassign_moderator
            • tools.ozone.queue.update_queue
          • tools.ozone.report
            • tools.ozone.report.assign_moderator
            • tools.ozone.report.create_activity
            • tools.ozone.report.defs
            • tools.ozone.report.get_assignments
            • tools.ozone.report.get_historical_stats
            • tools.ozone.report.get_latest_report
            • tools.ozone.report.get_live_stats
            • tools.ozone.report.get_report
            • tools.ozone.report.list_activities
            • tools.ozone.report.query_reports
            • tools.ozone.report.reassign_queue
            • tools.ozone.report.refresh_stats
            • tools.ozone.report.unassign_moderator
          • tools.ozone.safelink
            • tools.ozone.safelink.add_rule
            • tools.ozone.safelink.defs
            • tools.ozone.safelink.query_events
            • tools.ozone.safelink.query_rules
            • tools.ozone.safelink.remove_rule
            • tools.ozone.safelink.update_rule
          • tools.ozone.server
            • tools.ozone.server.get_config
          • tools.ozone.set
            • tools.ozone.set.add_values
            • tools.ozone.set.defs
            • tools.ozone.set.delete_set
            • tools.ozone.set.delete_values
            • tools.ozone.set.get_values
            • tools.ozone.set.query_sets
            • tools.ozone.set.upsert_set
          • tools.ozone.setting
            • tools.ozone.setting.defs
            • tools.ozone.setting.list_options
            • tools.ozone.setting.remove_options
            • tools.ozone.setting.upsert_option
          • tools.ozone.signature
            • tools.ozone.signature.defs
            • tools.ozone.signature.find_correlation
            • tools.ozone.signature.find_related_accounts
            • tools.ozone.signature.search_accounts
          • tools.ozone.team
            • tools.ozone.team.add_member
            • tools.ozone.team.defs
            • tools.ozone.team.delete_member
            • tools.ozone.team.list_members
            • tools.ozone.team.update_member
          • tools.ozone.verification
            • tools.ozone.verification.defs
            • tools.ozone.verification.grant_verifications
            • tools.ozone.verification.list_verifications
            • tools.ozone.verification.revoke_verifications
      • languages
      • blob_ref
      • dot_dict
      • utils
      • string_formats
    • Auth
    • Timeouts
    • String Formats
    • Utils
      • Text Builder (rich text)
  • Core
    • NSID (NameSpaced ID)
    • CID decoder
    • AT URI Scheme
    • CAR reader
    • DAG-CBOR
    • DID Document
  • Firehose (data streaming)
    • Frame models
  • 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
Back to top
View this page
Edit this page

internal¶

Subpackages¶

  • internal.bsky
    • Subpackages
      • internal.bsky.actor
        • Submodules
Copyright © 2023-2026 Ilya (Marshal) <https://github.com/MarshalX>
Made with Sphinx and @pradyunsg's Furo
On this page
  • internal
    • Subpackages