Share via

Bluesky Social (Independent Publisher) (Preview)

Specification for the Bluesky Social endpoints. Includes endpoints for soprocial interaction, admin, chat, ATProto, and ozone.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Dan Romano
Email dan.romano@swolcat.com
Connector Metadata
Publisher krautrocker
Website https://docs.bsky.app/
Privacy policy https://example.com/privacy-policy
Categories Social Media

Bluesky API Connector

  • **This custom connector allows Power Platform apps to interact with Bluesky's API, supporting operations for managing feeds, conversations, notifications, video uploads, and account data.

Publisher: Dan Romano

Prerequisites

  • **To use this connector, you will need:

    • **A Bluesky account.
    • **API access to Bluesky with App Password.

Supported Operations

  • **This connector includes the following operations:

Feed Endpoints

  • **GET /app.bsky.feed.getTimeline � Retrieve a user's timeline posts.
  • **GET /app.bsky.feed.getFeed � Retrieve posts from a specific feed or tag.
  • **GET /app.bsky.feed.searchPosts � Search for posts matching a query.
  • **GET /app.bsky.feed.getActorFeeds � Retrieve feeds posted by a specific actor.
  • **GET /app.bsky.feed.getActorLikes � Retrieve posts liked by a specific actor.
  • **GET /app.bsky.feed.getAuthorFeed � Retrieve posts from a specific author's feed.
  • **GET /app.bsky.feed.getFeedGenerator � Retrieve a generated feed for a user.
  • **GET /app.bsky.feed.getFeedGenerators � Retrieve metadata about all feed generators.
  • **GET /app.bsky.feed.getFeedSkeleton � Retrieve a minimal skeletal version of a feed.
  • **GET /app.bsky.feed.getListFeed � Retrieve posts from a specific list.
  • **GET /app.bsky.feed.getPosts � Retrieve a list of specific posts by their IDs.
  • **GET /app.bsky.feed.getPostThread � Retrieve the thread of posts related to a specific post.
  • **GET /app.bsky.feed.getLikes � Retrieve users who liked a specific post.
  • **GET /app.bsky.feed.getQuotes � Retrieve posts that quote a specific post.
  • **GET /app.bsky.feed.getRepostedBy � Retrieve users who reposted a specific post.
  • **GET /app.bsky.feed.getSuggestedFeeds � Retrieve suggested feeds for the user.
  • **POST /app.bsky.feed.sendInteractions � Send interactions (like or repost) for a post.

Actor Endpoints

  • **GET /app.bsky.actor.getPreferences � Retrieve the user's preferences.
  • **GET /app.bsky.actor.getProfile � Retrieve the profile of a specific user.
  • **GET /app.bsky.actor.getProfiles � Retrieve multiple user profiles.
  • **GET /app.bsky.actor.getSuggestions � Retrieve account suggestions for the user.
  • **POST /app.bsky.actor.putPreferences � Update the user's preferences.
  • **GET /app.bsky.actor.searchActors � Search for user accounts by query.
  • **GET /app.bsky.actor.searchActorsTypeahead � Retrieve search suggestions for user accounts.

Graph Endpoints

  • **GET /app.bsky.graph.getActorStarterPacks � Retrieve starter packs of accounts for a new user.
  • **GET /app.bsky.graph.getKnownFollowers � Get followers known to the authenticated user.
  • **GET /app.bsky.graph.getFollowers � Retrieve a list of followers for a user.
  • **GET /app.bsky.graph.getFollows � Retrieve users followed by a specific user.
  • **GET /app.bsky.graph.getBlocks � Retrieve users blocked by the authenticated user.
  • **GET /app.bsky.graph.getList � Retrieve a specific list of users.
  • **GET /app.bsky.graph.getLists � Retrieve all lists for the authenticated user.
  • **GET /app.bsky.graph.getListBlocks � Retrieve users blocked within a specific list.
  • **GET /app.bsky.graph.getListMutes � Retrieve muted lists for the authenticated user.
  • **GET /app.bsky.graph.getMutes � Retrieve muted users.
  • **GET /app.bsky.graph.getRelationships � Retrieve relationships between the authenticated user and specified accounts.
  • **GET /app.bsky.graph.getStarterPack � Retrieve a single starter pack for a new user.
  • **GET /app.bsky.graph.getStarterPacks � Retrieve all starter packs for new users.
  • **GET /app.bsky.graph.getSuggestedFollowsByActor � Retrieve suggested accounts to follow, filtered by an actor.
  • **POST /app.bsky.graph.muteActor � Mute a specific actor.
  • **POST /app.bsky.graph.unmuteActor � Unmute a specific actor.
  • **POST /app.bsky.graph.muteActorList � Mute a specific list of actors.
  • **POST /app.bsky.graph.unmuteActorList � Unmute a specific list of actors.
  • **POST /app.bsky.graph.muteThread � Mute an entire thread of posts.
  • **POST /app.bsky.graph.unmuteThread � Unmute an entire thread of posts.

Labeler Endpoints

  • **GET /app.bsky.labeler.getServices � Retrieve the list of labeler services available to the user.

Notification Endpoints

  • **GET /app.bsky.notification.getUnreadCount � Retrieve the count of unread notifications.
  • **GET /app.bsky.notification.listNotifications � List notifications for the authenticated user.
  • **POST /app.bsky.notification.putPreferences � Update notification preferences.
  • **POST /app.bsky.notification.registerPush � Register for push notifications.
  • **POST /app.bsky.notification.updateSeen � Mark notifications as seen.

Video Endpoints

  • **GET /app.bsky.video.getJobStatus � Retrieve the status of a video upload job.
  • **GET /app.bsky.video.getUploadLimits � Retrieve the video upload limits for the user.
  • **POST /app.bsky.video.uploadVideo � Upload a video file.

chat.bsky Endpoints

  • **DELETE /chat.bsky.actor.deleteAccount � Permanently delete an actor's account and associated data.
  • **GET /chat.bsky.actor.exportAccountData � Export account data for a specific actor.
  • **DELETE /chat.bsky.convo.deleteMessageForSelf � Delete a message from the user's view only.
  • **GET /chat.bsky.convo.getConvo � Retrieve a specific conversation.
  • **GET /chat.bsky.convo.getConvoForMembers � Get a conversation between specific members.
  • **GET /chat.bsky.convo.getLog � Retrieve the log of a conversation.
  • **GET /chat.bsky.convo.getMessages � Retrieve messages within a conversation.
  • **POST /chat.bsky.convo.leaveConvo � Leave a conversation.
  • **GET /chat.bsky.convo.listConvos � List all conversations for a user.
  • **POST /chat.bsky.convo.muteConvo � Mute notifications for a conversation.
  • **POST /chat.bsky.convo.sendMessage � Send a message in a conversation.
  • **POST /chat.bsky.convo.sendMessageBatch � Send multiple messages in a batch.
  • **POST /chat.bsky.convo.unmuteConvo � Unmute notifications for a conversation.
  • **POST /chat.bsky.convo.updateRead � Mark a conversation as read.
  • **GET /chat.bsky.moderation.getActorMetadata � Retrieve metadata associated with an actor's moderation status.
  • **GET /chat.bsky.moderation.getMessageContext � Retrieve context for a message's moderation.
  • **POST /chat.bsky.moderation.updateActorAccess � Update access permissions for a specified actor.

com.atproto.admin Endpoints

  • **DELETE /com.atproto.admin.deleteAccount � Permanently delete an account.
  • **POST /com.atproto.admin.disableAccountInvites � Disable invites for an account.
  • **POST /com.atproto.admin.disableInviteCodes � Disable invite codes.
  • **POST /com.atproto.admin.enableAccountInvites � Enable invites for an account.
  • **GET /com.atproto.admin.getAccountInfo � Get information about a specific account.
  • **GET /com.atproto.admin.getAccountInfos � Retrieve information about multiple accounts.
  • **GET /com.atproto.admin.getInviteCodes � Retrieve invite codes for an account.
  • **GET /com.atproto.admin.getSubjectStatus � Retrieve status information for a subject.
  • **GET /com.atproto.admin.searchAccounts � Search for accounts.
  • **POST /com.atproto.admin.sendEmail � Send an email to an account.
  • **POST /com.atproto.admin.updateAccountEmail � Update the email address associated with an account.
  • **POST /com.atproto.admin.updateAccountHandle � Update the handle associated with an account.
  • **POST /com.atproto.admin.updateAccountPassword � Update the password for an account.
  • **POST /com.atproto.admin.updateSubjectStatus � Update status for a subject.

com.atproto.identity Endpoints

  • **GET /com.atproto.identity.getRecommendedDidCredentials � Retrieve recommended DID credentials.
  • **POST /com.atproto.identity.requestPlcOperationSignature � Request a signature for a PLC operation.
  • **GET /com.atproto.identity.resolveHandle � Resolve an account handle.
  • **POST /com.atproto.identity.signPlcOperation � Sign a PLC operation.
  • **POST /com.atproto.identity.submitPlcOperation � Submit a PLC operation.
  • **POST /com.atproto.identity.updateHandle � Update the handle for an identity.

com.atproto.label Endpoints

  • **GET /com.atproto.label.queryLabels � Query labels for content or actors.

com.atproto.moderation Endpoints

  • **POST /com.atproto.moderation.createReport � Create a report for moderation.
  • **GET /com.atproto.moderation.getActorMetadata � Retrieve metadata for moderation purposes.

com.atproto.repo Endpoints

  • **POST /com.atproto.repo.applyWrites � Apply writes to a repository.
  • **POST /com.atproto.repo.createRecord � Create a record in a repository.
  • **DELETE /com.atproto.repo.deleteRecord � Delete a record from a repository.
  • **GET /com.atproto.repo.describeRepo � Describe a repository.
  • **GET /com.atproto.repo.getRecord � Retrieve a record by ID.
  • **POST /com.atproto.repo.importRepo � Import data into a repository.
  • **GET /com.atproto.repo.listMissingBlobs � List missing blobs.
  • **GET /com.atproto.repo.listRecords � List all records in a repository.
  • **POST /com.atproto.repo.putRecord � Update a record in the repository.
  • **POST /com.atproto.repo.uploadBlob � Upload a binary blob to a repository.

com.atproto.server Endpoints

  • **POST /com.atproto.server.activateAccount � Activate an account.
  • **GET /com.atproto.server.checkAccountStatus � Check account status.
  • **POST /com.atproto.server.confirmEmail � Confirm an email address.
  • **POST /com.atproto.server.createAccount � Create a new account.
  • **POST /com.atproto.server.createAppPassword � Create an app-specific password.
  • **POST /com.atproto.server.createInviteCode � Create a single invite code.
  • **POST /com.atproto.server.createInviteCodes � Create multiple invite codes.
  • **POST /com.atproto.server.createSession � Create a session.
  • **POST /com.atproto.server.deactivateAccount � Deactivate an account.
  • **DELETE /com.atproto.server.deleteAccount � Permanently delete an account.
  • **DELETE /com.atproto.server.deleteSession � Delete a session.
  • **GET /com.atproto.server.describeServer � Describe server information.
  • **GET /com.atproto.server.getAccountInviteCodes � Retrieve invite codes for an account.
  • **GET /com.atproto.server.getServiceAuth � Retrieve service authentication info.
  • **GET /com.atproto.server.getSession � Retrieve session information.
  • **GET /com.atproto.server.listAppPasswords � List app-specific passwords.
  • **POST /com.atproto.server.refreshSession � Refresh a session.
  • **POST /com.atproto.server.requestAccountDelete � Request deletion of an account.
  • **POST /com.atproto.server.requestEmailConfirmation � Request email confirmation.
  • **POST /com.atproto.server.requestEmailUpdate � Request email update.
  • **POST /com.atproto.server.requestPasswordReset � Request password reset.
  • **POST /com.atproto.server.reserveSigningKey � Reserve a signing key.
  • **POST /com.atproto.server.resetPassword � Reset password.
  • **POST /com.atproto.server.revokeAppPassword � Revoke an app-specific password.
  • **POST /com.atproto.server.updateEmail � Update the email associated with an account.

com.atproto.sync Endpoints

  • **GET /com.atproto.sync.getBlob � Retrieve a blob by ID.
  • **GET /com.atproto.sync.getBlocks � Retrieve blocks by ID.
  • **GET /com.atproto.sync.getLatestCommit � Get the latest commit.
  • **GET /com.atproto.sync.getRecord � Retrieve a record for synchronization.
  • **GET /com.atproto.sync.getRepo � Retrieve repository data for sync.
  • **GET /com.atproto.sync.getRepoStatus � Retrieve repository status.
  • **GET /com.atproto.sync.listBlobs � List blobs in a repository.
  • **GET /com.atproto.sync.listRepos � List repositories for synchronization.
  • **POST /com.atproto.sync.notifyOfUpdate � Notify of an update in the system.
  • **POST /com.atproto.sync.requestCrawl � Request a crawl for synchronization.

tools.ozone.communication Endpoints

  • **POST /tools.ozone.communication.createTemplate � Create a communication template.
  • **DELETE /tools.ozone.communication.deleteTemplate � Delete a communication template.
  • **GET /tools.ozone.communication.listTemplates � List communication templates.
  • **POST /tools.ozone.communication.updateTemplate � Update a communication template.

tools.ozone.moderation Endpoints

  • **POST /tools.ozone.moderation.emitEvent � Emit a moderation event.
  • **GET /tools.ozone.moderation.getEvent � Retrieve a specific moderation event.
  • **GET /tools.ozone.moderation.getRecord � Retrieve a moderation record.
  • **GET /tools.ozone.moderation.getRecords � List moderation records.
  • **GET /tools.ozone.moderation.getRepo � Retrieve moderation information for a repository.
  • **GET /tools.ozone.moderation.getRepos � Retrieve moderation data for multiple repositories.
  • **GET /tools.ozone.moderation.queryEvents � Query moderation events.
  • **GET /tools.ozone.moderation.queryStatuses � Query moderation statuses.
  • **POST /tools.ozone.moderation.searchRepos � Search repositories for moderation.

tools.ozone.server Endpoints

  • **GET /tools.ozone.server.getConfig � Retrieve server configuration information.

tools.ozone.set Endpoints

  • **POST /tools.ozone.set.addValues � Add values to a set.
  • **DELETE /tools.ozone.set.deleteSet � Delete a specified set.
  • **DELETE /tools.ozone.set.deleteValues � Delete specific values from a set.
  • **GET /tools.ozone.set.getValues � Retrieve values from a set.
  • **GET /tools.ozone.set.querySets � Query sets based on filters.
  • **POST /tools.ozone.set.upsertSet � Create or update a set.

tools.ozone.signature Endpoints

  • **GET /tools.ozone.signature.findCorrelation � Find correlations related to a signature.
  • **GET /tools.ozone.signature.findRelatedAccounts � Find accounts related to a signature.
  • **GET /tools.ozone.signature.searchAccounts � Search for accounts by signature.

tools.ozone.team Endpoints

  • **POST /tools.ozone.team.addMember � Add a member to a team.
  • **DELETE /tools.ozone.team.deleteMember � Remove a member from a team.
  • **GET /tools.ozone.team.listMembers � List members in a team.
  • **POST /tools.ozone.team.updateMember � Update team member information.

Unspecced Endpoints

  • **POST /app.bsky.unspecced.uploadBlob � Upload a binary blob to the user's account.
  • **GET /app.bsky.unspecced.getBlob � Retrieve a binary blob from the user's account.

Obtaining Credentials

  • Go to the Bluesky Developer Portal.
  • Generate an App Password under "Account Settings."
  • Save the App Password for use in connector setup.

Getting Started

  • **Some endpoints require specific parameters (such as actor/user Ids for examples).

    • **Authenticate: Start by authenticating with your Bluesky credentials.
    • **Choose Endpoint: Select the desired endpoint, such as retrieving a feed or listing notifications.
    • **Set Parameters: Provide the required parameters like user IDs, limits, or query strings.
    • **Execute Request: Run the request to retrieve data or perform actions within your Power Platform app.

Known Issues and Limitations

Frequently Asked Questions

  • Q: How do I generate an App Password?
    A: Visit the Bluesky Developer Portal and generate a new App Password. Use the password to generate a token.

  • Q: What are the API rate limits?
    A: Bluesky imposes a rate limit of 100 requests per minute per account.

  • Q: What are some useful terms and definitions, such as actor or DID?
    A: Useful terms to know:

    • Actor: An entity, typically a user, that interacts with the system. This can represent a person, organization, or automated system.
    • Starter Pack: A curated set of suggested accounts or content designed to help new users get started on the platform.
    • Signature: A cryptographic proof used to verify the authenticity and integrity of a transaction or operation within the system.
    • PLC (Personal Linked Chain): A blockchain-like structure used to maintain a verifiable history of account operations (e.g., handle updates, key rotations). It ensures transparency and trustworthiness.
    • DID (Decentralized Identifier): A globally unique identifier for an actor that is not tied to a centralized registry. DIDs are foundational to the decentralized nature of Bluesky.

Support

  • **dan.romano@swolcat.com or torin@imp.sh (original owner)

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Activate Account

Activates a currently deactivated account.
Add a team member

Add a member to the ozone team.
Add values to a set

Add values to a specific set.
Apply repository writes

Apply a batch transaction of repository creates, updates, and deletes.
Check Account Status

Returns the status of an account, especially as pertaining to import or recovery.
Confirm Email

Confirm an email using a token generated by the requestEmailConfirmation process.
Count the number of unread notifications for the requesting account

Count the number of unread notifications for the requesting account.
Create a reusable communication template

Admin action to create a new, reusable comm. template.
Create a single new repository record

Create a single new repository record.
Create Account

Create an account with the provided details.
Create App Password

Create an App Password.
Create Authentication Session

Create an authentication session
Create Invite Code

Create an invite code for specified use cases.
Create Invite Codes

Create multiple invite codes with specified usage limits.
Create or update set metadata

Create or update set metadata.
Create Report

Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.
Deactivate Account

Deactivates a currently active account after migration is finalized.
Delete a communication template

Delete a communication template by its unique ID.
Delete a member from ozone team

Delete a member from ozone team.
Delete a repository record or ensure it doesnt exist

Delete a repository record, or ensure it doesn't exist.
Delete a set

Delete an entire set.
Delete Account

Delete a user account as an administrator.
Delete Account

Delete an actor's account with a token and password.
Delete Account

Delete an account.
Delete Message for Self

Delete a message for the user who sent it.
Delete Session

Delete the current session.
Delete values from a set

Delete values from a specific set.
Describe Server

Describes the server's account creation requirements and capabilities.
Disable Invite Codes

Disable specific invite codes to prevent further usage.
Download repository export

Download a repository export as CAR file.
Enable Account Invites

Re-enable an account's ability to receive invite codes.
Export Account Data

Export account data.
Find actors (profiles) matching search criteria

Find actors (profiles) matching search criteria.
Find Correlation of Threat Signatures

Find all correlated threat signatures between 2 or more accounts.
Find labels relevant to the provided AT-URI patterns

Find labels relevant to the provided AT-URI patterns.
Find Related Accounts

Get accounts that share some matching threat signatures with the root account.
Find repositories based on a search term

Find repositories based on a search term.
Get a blob associated with an account

Get a blob associated with a given account.
Get a list of posts liked by an actor

Get a list of posts liked by an actor.
Get a list of starter packs created by the actor

Get a list of starter packs created by the actor.
Get a record from the repo

Retrieve a record from the repo by its unique identifier.
Get a single record from a repository

Get a single record from a repository.
Get Account Info

Get details about an account.
Get Account Infos

Get details about some accounts.
Get Account Invite Codes

Get all invite codes for the current account.
Get Actor Feeds

Get a list of feeds created by the actor.
Get Actor Metadata

Fetch moderation-related metadata for an actor via DID
Get Author Feed

Get a view of an actor's 'author feed.'
Get Blocked Lists

Get mod lists that the requesting account (actor) is blocking.
Get Conversation

Get a conversation based on the provided conversation ID.
Get Convo for Members

Get a conversation for one or many members.
Get Current Session Info

Get information about the authenticated session.
Get data blocks from a repo

Get data blocks from a given repo, by CID.
Get details about a moderation event

Get details about a moderation event.
Get details about a record

Get details about a record.
Get details about a repository

Get details about a repository.
Get details about some records

Get details about some records.
Get Feed

Get a hydrated feed from an actor's selected feed generator.
Get Feed Generator Information

Get information about a feed generator.
Get Feed Generators Information

Get information about a list of feed generators.
Get Feed Skeleton

Get a skeleton of a feed provided by a feed generator.
Get Followers

Enumerate accounts that follow a specified actor.
Get Follows

Enumerates accounts that a specified actor follows.
Get information about a feed

Get information about a feed generator.
Get information about a list of labeler services

Get information about a list of labeler services.
Get information about an account and repository

Get information about an account and repository, including the list of collections.
Get Invite Codes

Get an admin view of invite codes.
Get Known Followers

Retrieve followers for a specific account that are also followed by the viewer.
Get Likes

Get like records which reference a subject (by AT-URI and CID).
Get List Feed

Get a feed of recent posts from a list.
Get list of communication templates

Retrieve a list of all available communication templates.
Get List View

Gets a 'view' (with additional context) of a specified list.
Get Lists

Enumerates the lists created by a specified account.
Get Log

Retrieve the log of actions and messages in a conversation.
Get Message Context

Fetch surrounding messages from a conversation
Get Messages

Get a list of messages from a specific conversation.
Get Moderation Repositories

Get a list of all moderation repositories.
Get Muted Lists

Get mod lists that the requesting account currently has muted.
Get Mutes

Enumerates accounts that the requesting account currently has muted.
Get Post Thread

Get posts in a thread.
Get Posts

Gets post views for a specified list of posts.
Get preferences

Get private preferences attached to the current account.
Get Profile

Retrieve a detailed profile view of an actor using their handle or DID.
Get Profiles

Get detailed profile views of multiple actors.
Get public relationships between one account, and a list of other accounts

Get public relationships between one account, and a list of other accounts.
Get Quotes

Get a list of quotes for a given post.
Get repository hosting status

Get the hosting status for a repository, on this server.
Get Reposted By

Get a list of reposts for a given post.
Get Server Configuration

Get details about ozone's server configuration.
Get Service Authentication Token

Get a signed token on behalf of the requesting DID for the requested service.
Get set values

Get a specific set and its values.
Get Starter Pack

Gets a view of a starter pack based on the provided reference (AT-URI).
Get Starter Packs

Get detailed views for a list of starter packs based on the provided URIs.
Get status details for a video processing job

Get status details for a video processing job.
Get Suggested Actors

Get a list of suggested actors.
Get Suggested Feeds

Retrieve a list of suggested feeds for the requesting account.
Get Suggested Follows by Actor

Enumerates follows similar to a given account.
Get the current commit of a repo

Get the current commit CID & revision of the specified repo.
Get Timeline

Get a view of the requesting account's home timeline.
Get video upload limits for the authenticated user

Get video upload limits for the authenticated user.
GetRecommendedDidCredentials

Describe the credentials that should be included in the DID doc of an account that is migrating to this service.
Import a repo in the form of a CAR file

Import a repo in the form of a CAR file. Content-Length header required.
Leave Conversation

Leave a conversation by specifying its ID.
List account blob CIDs

List account blob CIDs since a repo revision.
List all members with access to the ozone service

List all members with access to the ozone service.
List App Passwords

List all App Passwords.
List Conversations

List conversations.
List missing blobs for the requesting account

Returns a list of missing blobs for the requesting account.
List moderation events related to a subject

List moderation events related to a subject.
List Notifications

Enumerate notifications for the requesting account.
List records in a repository

List a range of records in a repository, matching a specific collection.
List repositories

Enumerates all the DID, rev, and commit CID for all repos
Mute Actor

Creates a mute relationship for the specified account.
Mute Actor List

Creates a mute relationship for the specified list of accounts.
Mute Conversation

Mute a conversation.
Mute Thread

Mutes a thread preventing notifications from the thread and any of its children.
Notify of Update

Notify a crawling service of a recent update, and that crawling should resume.
Notify server that the requesting account has seen notifications

Notify server that the requesting account has seen notifications.
Query available sets

Query available sets.
Refresh Authentication Session

Refresh an authentication session to obtain a new access token and refresh token.
Register to receive push notifications

Register to receive push notifications.
Request Account Deletion

Initiate a user account deletion via email.
Request Crawl

Request a service to persistently crawl hosted repos.
Request Email Confirmation

Request an email with a code to confirm ownership of email.
Request Email Update

Request a token in order to update email.
Request Password Reset

Initiate a user account password reset via email.
RequestPlcOperationSignature

Request an email with a code to in order to request a signed PLC operation.
Reserve Signing Key

Reserve a repo signing key for use with account creation.
Reset Password

Reset a user account password using a token.
ResolveHandle

Resolves a handle (domain name) to a DID.
Retrieve record view

Returns dynamic schema information for the record view.
Revoke App Password

Revoke an App Password by name.
Search Accounts

Get a list of accounts that matches your search query.
Search Actors for Typeahead

Retrieve account suggestions for typeahead search.
Search Posts

Find posts matching search criteria, returning views of those posts.
Send Batch Messages

Send a batch of messages to multiple conversations.
Send email to a user's account email address

Send email to a user's account email address.
Send Interactions

Send information about interactions.
Send Message

Send a single message to a specific conversation.
Set Account Preferences

Set the private preferences attached to the account.
Set Notification Preferences

Set notification-related preferences for an account.
SignPlcOperation

Signs a PLC operation to update some value(s) in the requesting DID's document.
SubmitPlcOperation

Validates a PLC operation to ensure that it doesn't violate a service's constraints.
Take a moderation action on an actor

Take a moderation action on an actor
Unmute Actor

Unmutes the specified account.
Unmute Actor List

Unmutes the specified list of accounts.
Unmute Conversation

Unmute a conversation.
Unmute Thread

Unmutes the specified thread.
Update a member in the ozone service

Update a member in the ozone service.
Update Account Email

Administrative action to update an account's email.
Update Account Handle

Administrative action to update an account's handle.
Update Account Password

Update the password for a user account as an administrator.
Update Actor Access

Update an actor's access permissions.
Update an existing communication template

Administrative action to update an existing communication template.
Update Conversation Read Status

Update an item in a conversation to mark it as read.
Update Email

Update an account's email.
Update Subject Status

Update the service-specific admin status of a subject.
UpdateHandle

Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary.
Upload a new blob

Upload a new blob.
Upload Video

Upload a video to be processed and stored on the PDS.
View moderation statuses of subjects

View moderation statuses of subjects (record or repo).
Write a repository record

Write a repository record, creating or updating it as needed.

Activate Account

Operation ID:
ActivateAccount

Activates a currently deactivated account.

Add a team member

Operation ID:
AddTeamMember

Add a member to the ozone team.

Parameters

Name Key Required Type Description
did
 did True string

The DID of the member to add.
role
 role True string

Role of the member to add.

Returns

Body
member

Add values to a set

Operation ID:
AddValuesToSet

Add values to a specific set.

Parameters

Name Key Required Type Description
name
 name True string

Name of the set to add values to
values
 values True array of string

Values to add to the set

Apply repository writes

Operation ID:
ApplyWrites

Apply a batch transaction of repository creates, updates, and deletes.

Returns

Name Path Type Description
commit
 commit commitMeta
results
 results array of applyWrites.result

Check Account Status

Operation ID:
CheckAccountStatus

Returns the status of an account, especially as pertaining to import or recovery.

Returns

Name Path Type Description
activated
 activated boolean

Indicates whether the account is activated.
validDid
 validDid boolean

Indicates whether the DID is valid.
repoCommit
 repoCommit string

Commit identifier for the account's repository.
repoRev
 repoRev string

Repository revision information.
repoBlocks
 repoBlocks integer

Number of repository blocks.
indexedRecords
 indexedRecords integer

Number of indexed records in the account.
privateStateValues
 privateStateValues integer

Number of private state values.
expectedBlobs
 expectedBlobs integer

Expected number of blobs.
importedBlobs
 importedBlobs integer

Number of imported blobs.

Confirm Email

Operation ID:
ConfirmEmail

Confirm an email using a token generated by the requestEmailConfirmation process.

Parameters

Name Key Required Type Description
email
 email True string

The email address to confirm.
token
 token True string

The confirmation token sent to the user's email.

Count the number of unread notifications for the requesting account

Operation ID:
GetUnreadCount

Count the number of unread notifications for the requesting account.

Parameters

Name Key Required Type Description
Priority
 priority boolean

Specifies if only high-priority notifications should be counted.
Seen at
 seenAt date-time

Count notifications seen after the provided timestamp.

Returns

Name Path Type Description
count
 count integer

The number of unread notifications.

Create a reusable communication template

Operation ID:
CreateTemplate

Admin action to create a new, reusable comm. template.

Parameters

Name Key Required Type Description
name
 name True string

Name of the template.
contentMarkdown
 contentMarkdown True string

Content of the template, markdown supported, can contain variable placeholders.
subject
 subject True string

Subject of the message, used in emails.
lang
 lang string

Message language.
createdBy
 createdBy string

DID of the user who is creating the template.

Returns

Body
templateView

Create a single new repository record

Operation ID:
CreateRecord

Create a single new repository record.

Parameters

Name Key Required Type Description
repo
 repo True string

The handle or DID of the repo (aka, current account).
collection
 collection True string

The NSID of the record collection.
rkey
 rkey string

The Record Key.
validate
 validate boolean

True or false value set for skipping Lexicon schema validation.
record
 record True object

The record object.
swapCommit
 swapCommit string

Compare and swap with the previous commit by CID.

Returns

Name Path Type Description
uri
 uri string

The URI of the created record.
cid
 cid string

The CID of the created record.
commit
 commit commitMeta
validationStatus
 validationStatus string

Create Account

Operation ID:
CreateAccount

Create an account with the provided details.

Parameters

Name Key Required Type Description
email
 email string

Email address for the account.
handle
 handle True string

Requested handle for the account.
did
 did string

Pre-existing atproto DID, being imported to a new account.
inviteCode
 inviteCode string

Invite code for account creation.
verificationCode
 verificationCode string

Code for verifying the email or phone.
verificationPhone
 verificationPhone string

Phone number for account verification.
password
 password string

Initial account password. May need to meet instance-specific password strength requirements.
recoveryKey
 recoveryKey string

DID PLC rotation key (recovery key) to be included in the PLC creation operation.
plcOp
 plcOp object

Optional PLC operation data.

Returns

Name Path Type Description
accessJwt
 accessJwt string

Access JWT token for authentication.
refreshJwt
 refreshJwt string

Refresh JWT token for session renewal.
handle
 handle string

Handle of the new account.
did
 did string

DID of the new account.
didDoc
 didDoc object

DID document associated with the new account.

Create App Password

Operation ID:
ServerCreateAppPassword

Create an App Password.

Parameters

Name Key Required Type Description
name
 name True string

A short name for the App Password, to help distinguish them.
privileged
 privileged boolean

If an app password has 'privileged' access to possibly sensitive account state. Meant for use with trusted clients.

Returns

Body
createAppPassword

Create Authentication Session

Operation ID:
CreateSession

Create an authentication session

Parameters

Name Key Required Type Description
Host
 pdshost True string

Bluesky host
Username
 identifier True string

Handle or other identifier
Password
 password True string

Password of the authenticating user
Auth Factor Token
 authFactorToken string

Optional token for multi-factor authentication

Returns

Name Path Type Description
accessJwt
 accessJwt string

JWT access token.
refreshJwt
 refreshJwt string

JWT refresh token.
handle
 handle string

User's handle.
did
 did string

Decentralized Identifier (DID) of the user.
didDoc
 didDoc object

Optional DID document.
email
 email string

Email address of the user.
emailConfirmed
 emailConfirmed boolean

Indicator if the email is confirmed.
emailAuthFactor
 emailAuthFactor boolean

Indicator if email is used for authentication.
active
 active boolean

Indicates if the session is active.
status
 status string

Status of the user account.

Create Invite Code

Operation ID:
CreateInviteCode

Create an invite code for specified use cases.

Parameters

Name Key Required Type Description
useCount
 useCount True integer

The number of times the invite code can be used.
forAccount
 forAccount string

The DID of the account for which the invite code is being generated.

Returns

Name Path Type Description
code
 code string

The generated invite code.

Create Invite Codes

Operation ID:
CreateInviteCodes

Create multiple invite codes with specified usage limits.

Parameters

Name Key Required Type Description
codeCount
 codeCount True integer

The number of invite codes to generate.
useCount
 useCount True integer

The number of times each invite code can be used.
forAccounts
 forAccounts array of string

An array of DIDs for accounts the invite codes are for.

Returns

Name Path Type Description
codes
 codes array of object

The generated invite codes.
account
 codes.account string

The DID of the account associated with the invite code.
code
 codes.code string

The generated invite code.

Create or update set metadata

Operation ID:
UpsertSet

Create or update set metadata.

Parameters

Name Key Required Type Description
name
 name True string
description
 description string

Returns

Body
setView

Create Report

Operation ID:
CreateReport

Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.

Parameters

Name Key Required Type Description
reasonSpam
 reasonSpam string

Spam: frequent unwanted promotion, replies, mentions
reasonViolation
 reasonViolation string

Direct violation of server rules, laws, terms of service
reasonMisleading
 reasonMisleading string

Misleading identity, affiliation, or content
reasonSexual
 reasonSexual string

Unwanted or mislabeled sexual content
reasonRude
 reasonRude string

Rude, harassing, explicit, or otherwise unwelcoming behavior
reasonOther
 reasonOther string

Other: reports not falling under another report category
reasonAppeal
 reasonAppeal string

Appeal: appeal a previously taken moderation action
reason
 reason string

Additional context about the content and violation.
did
 did True string
uri
 uri True string

The URI of the strong reference.
cid
 cid True string

The CID of the strong reference.

Returns

Name Path Type Description
id
 id integer

Unique identifier for the report.
reasonType
 reasonType reasonType

Reason type for the moderation report. One of the predefined reasons.
reason
 reason string

Additional context about the content and violation.
repoRef
 subject.repoRef repoRef
strongRef
 subject.strongRef strongRef

Defines a strong reference with a URI and CID.
reportedBy
 reportedBy string

DID of the user who submitted the report.
createdAt
 createdAt date-time

Timestamp when the report was created.

Deactivate Account

Operation ID:
DeactivateAccount

Deactivates a currently active account after migration is finalized.

Parameters

Name Key Required Type Description
deleteAfter
 deleteAfter date-time

Time window for retaining the deactivated account.

Delete a communication template

Operation ID:
DeleteTemplate

Delete a communication template by its unique ID.

Parameters

Name Key Required Type Description
id
 id True string

The unique identifier of the template to be deleted.

Delete a member from ozone team

Operation ID:
DeleteMemberTeam

Delete a member from ozone team.

Parameters

Name Key Required Type Description
did
 did True string

The DID of the member.

Delete a repository record or ensure it doesnt exist

Operation ID:
DeleteRecord

Delete a repository record, or ensure it doesn't exist.

Parameters

Name Key Required Type Description
repo
 repo True string

The handle or DID of the repo (aka, current account).
collection
 collection True string

The NSID of the record collection.
rkey
 rkey True string

The Record Key.
swapRecord
 swapRecord string

Compare and swap with the previous record by CID.
swapCommit
 swapCommit string

Compare and swap with the previous commit by CID.

Returns

Name Path Type Description
commit
 commit commitMeta

Delete a set

Operation ID:
DeleteSet

Delete an entire set.

Parameters

Name Key Required Type Description
name
 name True string

Name of the set to delete

Returns

Delete Account

Operation ID:
AdminDeleteAccount

Delete a user account as an administrator.

Parameters

Name Key Required Type Description
Decentralized Identifier (DID)
 did True string

Returns

Name Path Type Description
success
 success boolean

Indicates whether the account was deleted successfully.
message
 message string

Optional message detailing the result.

Delete Account

Operation ID:
ServerDeleteAccount

Delete an actor's account with a token and password.

Parameters

Name Key Required Type Description
did
 did True string

Decentralized Identifier (DID) of the account to be deleted.
password
 password True string

Password of the account.
token
 token True string

Token associated with the account.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the account deletion was successful.
message
 message string

Optional success message.

Delete Account

Operation ID:
ActorDeleteAccount

Delete an account.

Returns

Delete Message for Self

Operation ID:
DeleteMessageForSelf

Delete a message for the user who sent it.

Parameters

Name Key Required Type Description
convoId
 convoId True string

The ID of the conversation containing the message to be deleted.
messageId
 messageId True string

The ID of the message to be deleted.

Returns

Body
deletedMessageView

Delete Session

Operation ID:
ServerDeleteSession

Delete the current session.

Delete values from a set

Operation ID:
DeleteValues

Delete values from a specific set.

Parameters

Name Key Required Type Description
name
 name True string

Name of the set to delete values from.
values
 values True array of string

Describe Server

Operation ID:
ServerDescribeServer

Describes the server's account creation requirements and capabilities.

Returns

Name Path Type Description
inviteCodeRequired
 inviteCodeRequired boolean

If true, an invite code must be supplied to create an account on this instance.
phoneVerificationRequired
 phoneVerificationRequired boolean

If true, a phone verification token must be supplied to create an account on this instance.
availableUserDomains
 availableUserDomains array of string
links
 links describeServerLinks
contact
 contact describeServerContact
did
 did string

Decentralized Identifier (DID) of the server.

Disable Invite Codes

Operation ID:
DisableInviteCodes

Disable specific invite codes to prevent further usage.

Parameters

Name Key Required Type Description
inviteCodes
 inviteCodes array of string

A list of invite codes to disable.

Returns

Name Path Type Description
success
 success boolean

Indicates successful operation.

Download repository export

Operation ID:
SyncGetRepo

Download a repository export as CAR file.

Parameters

Name Key Required Type Description
Repo DID
 did True string

The DID of the repo.
Revision
 since string

The revision ('rev') of the repo to create a diff from.

Returns

response
binary

Enable Account Invites

Operation ID:
AdminEnableAccountInvites

Re-enable an account's ability to receive invite codes.

Parameters

Name Key Required Type Description
Account Identifier
 account True string

The account/DID for which invites are being enabled.
Reason for Enable
 note string

Optional reason for enabling invites.

Returns

Name Path Type Description
success
 success boolean

Indicates if the operation was successful.
message
 message string

Optional message detailing the result.

Export Account Data

Operation ID:
ActorExportAccountData

Export account data.

Returns

response
file

Find actors (profiles) matching search criteria

Operation ID:
SearchActors

Find actors (profiles) matching search criteria.

Parameters

Name Key Required Type Description
Search Query
 q string

Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.
Result Limit
 limit integer

The maximum number of actors to return.
Pagination Cursor
 cursor string

Cursor for pagination to fetch the next set of results.

Returns

Name Path Type Description
cursor
 cursor string

Cursor for pagination.
actors
 actors array of profileView

List of matching actor profiles.

Find Correlation of Threat Signatures

Operation ID:
FindCorrelation

Find all correlated threat signatures between 2 or more accounts.

Parameters

Name Key Required Type Description
Account DIDs
 dids True array

List of DIDs for accounts to find correlated signatures.

Returns

Name Path Type Description
details
 details array of sigDetail

Find labels relevant to the provided AT-URI patterns

Operation ID:
QueryLabels

Find labels relevant to the provided AT-URI patterns.

Parameters

Name Key Required Type Description
List of AT URI patterns to match
 uriPatterns True array

List of AT URI patterns to match (boolean 'OR').
DIDs to filter on
 sources array

Optional list of label sources (DIDs) to filter on.
Limit
 limit integer

The maximum number of labels to return.
Pagination cursor
 cursor string

A cursor for pagination.

Returns

Name Path Type Description
cursor
 cursor string

Cursor for pagination.
labels
 labels array of label
Operation ID:
FindRelatedAccounts

Get accounts that share some matching threat signatures with the root account.

Parameters

Name Key Required Type Description
Account DID
 did True string

The DID of the root account.
Pagination Cursor
 cursor string

Pagination cursor for the next set of results.
Result Limit
 limit integer

The maximum number of results to return.

Returns

Name Path Type Description
cursor
 cursor string
accounts
 accounts array of findRelatedAccounts.relatedAccount

Find repositories based on a search term

Operation ID:
SearchReposModeration

Find repositories based on a search term.

Parameters

Name Key Required Type Description
Search term
 q string

The search term to find repositories.
Limit results
 limit integer

The maximum number of results to return.
Pagination cursor
 cursor string

Cursor for paginating results.

Returns

Name Path Type Description
cursor
 cursor string

Pagination cursor for the next page of results.
repos
 repos array of repoView

Get a blob associated with an account

Operation ID:
GetBlob

Get a blob associated with a given account.

Parameters

Name Key Required Type Description
Account DID
 did True string

The DID of the account.
Blob CID
 cid True string

The CID of the blob to fetch.

Returns

Name Path Type Description
blob
 blob string

Base64-encoded blob content.

Get a list of posts liked by an actor

Operation ID:
GetActorLikes

Get a list of posts liked by an actor.

Parameters

Name Key Required Type Description
Actor Identifier
 actor True string

Identifier of the actor whose likes are being retrieved.
Result Limit
 limit integer

Maximum number of results to return.
Pagination Cursor
 cursor string

Cursor for pagination.

Returns

Name Path Type Description
cursor
 cursor string

Cursor for the next page of results.
feed
 feed array of feedViewPost

List of posts liked by the actor.

Get a list of starter packs created by the actor

Operation ID:
GetActorStarterPacks

Get a list of starter packs created by the actor.

Parameters

Name Key Required Type Description
Actor Identifier
 actor True string

The actor identifier for which to retrieve starter packs.
Result Limit
 limit integer

The maximum number of starter packs to return.
Pagination Cursor
 cursor string

Cursor for pagination to fetch the next set of results.

Returns

Name Path Type Description
cursor
 cursor string

Cursor for pagination.
starterPacks
 starterPacks array of starterPackViewBasic

Get a record from the repo

Operation ID:
SyncGetRecord

Retrieve a record from the repo by its unique identifier.

Parameters

Name Key Required Type Description
Record ID
 did True string

Unique identifier of the record.

Returns

Name Path Type Description
id
 record.id string

Unique identifier of the record.
content
 record.content string

The content of the record.

Get a single record from a repository

Operation ID:
RepoGetRecord

Get a single record from a repository.

Parameters

Name Key Required Type Description
The handle or DID of the repo
 repo True string

The handle or DID of the repo.
The NSID of the record collection
 collection True string

The NSID of the record collection.
The Record Key
 rkey True string

The Record Key.
The CID of the version of the record
 cid string

The CID of the version of the record.

Returns

Name Path Type Description
uri
 uri string

The URI of the record.
cid
 cid string

The CID of the record.
value
 value object

The value of the record.

Get Account Info

Operation ID:
AdminGetAccountInfo

Get details about an account.

Parameters

Name Key Required Type Description
Account Identifier
 did True string

Decentralized Identifier (DID) of the account.

Returns

Body
accountView

Get Account Infos

Operation ID:
AdminGetAccountInfos

Get details about some accounts.

Parameters

Name Key Required Type Description
Account Identifiers
 dids True array

Array of account identifiers (DIDs).

Returns

Name Path Type Description
infos
 infos array of accountView

Get Account Invite Codes

Operation ID:
ServerGetAccountInviteCodes

Get all invite codes for the current account.

Parameters

Name Key Required Type Description
Include Used
 includeUsed boolean

Include used invite codes in the response.
Create Available
 createAvailable boolean

Controls whether any new 'earned' but not 'created' invites should be created.

Returns

Name Path Type Description
codes
 codes array of inviteCode

Get Actor Feeds

Operation ID:
GetActorFeeds

Get a list of feeds created by the actor.

Parameters

Name Key Required Type Description
Actor Identifier
 actor True string

The handle or DID of the actor whose feeds are to be retrieved.
Limit
 limit integer

The maximum number of feeds to return (default: 50, max: 100).
Pagination cursor
 cursor string

Pagination cursor for retrieving the next set of results.

Returns

The outputs of this operation are dynamic.

Get Actor Metadata

Operation ID:
GetActorMetadata

Fetch moderation-related metadata for an actor via DID

Parameters

Name Key Required Type Description
DID
 actor True string

The Decentralized Identifier (DID) of the actor.

Returns

Name Path Type Description
day
 day ActorMetadata
month
 month ActorMetadata
all
 all ActorMetadata

Get Author Feed

Operation ID:
GetAuthorFeed

Get a view of an actor's 'author feed.'

Parameters

Name Key Required Type Description
Actor identifier
 actor True string

The identifier of the actor whose author feed to fetch.
Limit
 limit integer

Maximum number of items to fetch.
Pagination curose
 cursor string

Pagination cursor for fetching the next set of results.
Filter criteria
 filter string

Combinations of post/repost types to include in response.
Include pinned posts
 includePins boolean

Whether to include pinned posts in the response.

Returns

Name Path Type Description
cursor
 cursor string
feed
 feed array of feedViewPost

Get Blocked Lists

Operation ID:
GetListBlocks

Get mod lists that the requesting account (actor) is blocking.

Parameters

Name Key Required Type Description
Limit Results
 limit integer

Maximum number of results to return.
Pagination Cursor
 cursor string

Cursor to retrieve the next set of results.

Returns

Name Path Type Description
cursor
 cursor string

Cursor for the next set of results.
lists
 lists array of listView

Get Conversation

Operation ID:
GetConvo

Get a conversation based on the provided conversation ID.

Parameters

Name Key Required Type Description
Conversation ID
 convoId True string

The ID of the conversation to retrieve.

Returns

Name Path Type Description
Conversation View
 convo convoView

Represents a view of a conversation.

Get Convo for Members

Operation ID:
GetConvoForMembers

Get a conversation for one or many members.

Parameters

Name Key Required Type Description
Members DID Identifiers
 members True array

List of DID identifiers for the members of the conversation.

Returns

Name Path Type Description
Conversation View
 convo convoView

Represents a view of a conversation.

Get Current Session Info

Operation ID:
GetSession

Get information about the authenticated session.

Returns

Name Path Type Description
handle
 handle string

User's handle.
did
 did string

Decentralized Identifier (DID) of the user.
email
 email string

Email address of the user.
emailConfirmed
 emailConfirmed boolean

Indicates if the email is confirmed.
emailAuthFactor
 emailAuthFactor boolean

Indicates if email is used as an authentication factor.
didDoc
 didDoc object

Optional DID document.
active
 active boolean

Indicates if the session is active.
status
 status string

The status of the user account.

Get data blocks from a repo

Operation ID:
GetBlocks

Get data blocks from a given repo, by CID.

Parameters

Name Key Required Type Description
Repo DID
 did True string

The DID of the repo.
Block CIDs
 cids True array

The CIDs of the blocks to fetch.

Returns

Name Path Type Description
blocks
 blocks array of string

List of blocks fetched.

Get details about a moderation event

Operation ID:
GetEvent

Get details about a moderation event.

Parameters

Name Key Required Type Description
The ID of the moderation event to retrieve
 id True integer

The ID of the moderation event to retrieve.

Returns

Body
modEventViewDetail

Get details about a record

Operation ID:
GetRecordModeration

Get details about a record.

Parameters

Name Key Required Type Description
URI of the record to retrieve
 uri True string

The URI of the record.
CID of the specific version
 cid string

The CID of the version of the record.

Returns

Body
recordViewDetail

Get details about a repository

Operation ID:
GetRepoModeration

Get details about a repository.

Parameters

Name Key Required Type Description
DID of the repository
 did True string

The DID of the repository.

Returns

Body
repoViewDetail

Get details about some records

Operation ID:
GetRecordsModeration

Get details about some records.

Parameters

Name Key Required Type Description
URIs of the records to retrieve
 uris True array

A list of URIs for the records.

Returns

Name Path Type Description
records
 records array of object
items
 records object

Get Feed

Operation ID:
GetFeed

Get a hydrated feed from an actor's selected feed generator.

Parameters

Name Key Required Type Description
Feed Generator URI
 feed True string

The URI of the feed generator.
Actor identifier
 actor True string

The handle or DID of the actor requesting the feed.
Limit
 limit integer

The maximum number of posts to return (default: 50, max: 100).
Pagination cursor
 cursor string

Pagination cursor for retrieving the next set of results.

Returns

The outputs of this operation are dynamic.

Get Feed Generator Information

Operation ID:
GetFeedGenerator

Get information about a feed generator.

Parameters

Name Key Required Type Description
Feed Generator AT-URI
 feed True string

AT-URI of the feed generator record.

Returns

Name Path Type Description
view
 view generatorView
isOnline
 isOnline boolean

Indicates whether the feed generator service has been online recently.
isValid
 isValid boolean

Indicates whether the feed generator service is compatible with the record declaration.

Get Feed Generators Information

Operation ID:
GetFeedGenerators

Get information about a list of feed generators.

Parameters

Name Key Required Type Description
List of Feed Generator AT-URIs
 feeds True array

A list of AT-URIs representing the feed generators to retrieve information for.

Returns

Name Path Type Description
feeds
 feeds array of generatorView

Get Feed Skeleton

Operation ID:
GetFeedSkeleton

Get a skeleton of a feed provided by a feed generator.

Parameters

Name Key Required Type Description
Feed generator reference.
 feed True string

Reference to feed generator record describing the specific feed being requested.
Number of results to retrieve.
 limit integer

Limit
Pagination cursor.
 cursor string

Pagination cursor

Returns

Name Path Type Description
cursor
 cursor string
feed
 feed array of skeletonFeedPost

Get Followers

Operation ID:
GetFollowers

Enumerate accounts that follow a specified actor.

Parameters

Name Key Required Type Description
Actor Identifier
 actor True string

The handle or DID of the actor whose followers are being retrieved.
Pagination Limit
 limit integer

The maximum number of followers to return (default: 50, max: 100).
Pagination Cursor
 cursor string

Pagination cursor for retrieving the next set of results.

Returns

The outputs of this operation are dynamic.

Get Follows

Operation ID:
GetFollows

Enumerates accounts that a specified actor follows.

Parameters

Name Key Required Type Description
Actor Identifier
 actor True string

The handle or DID of the actor whose follows are being retrieved.
Maximum Accounts to Retrieve
 limit integer

The maximum number of accounts to return (default: 50, max: 100).
Pagination Cursor
 cursor string

Pagination cursor for retrieving the next set of results.

Returns

The outputs of this operation are dynamic.

Get information about a feed

Operation ID:
DescribeFeedGenerator

Get information about a feed generator.

Returns

Name Path Type Description
did
 did string
feeds
 feeds array of describeFeedGeneratorFeed
links
 links describeFeedGeneratorLinks

Get information about a list of labeler services

Operation ID:
GetServices

Get information about a list of labeler services.

Parameters

Name Key Required Type Description
DIDs
 dids True array

DIDs
Detailed
 detailed boolean

Detailed

Returns

Name Path Type Description
views
 views array of labelerView

Get information about an account and repository

Operation ID:
DescribeRepo

Get information about an account and repository, including the list of collections.

Parameters

Name Key Required Type Description
The handle or DID of the repo.
 repo True string

The handle or DID of the repo.

Returns

Name Path Type Description
handle
 handle string
did
 did string
didDoc
 didDoc object
collections
 collections array of string
handleIsCorrect
 handleIsCorrect boolean

Indicates if handle is currently valid.

Get Invite Codes

Operation ID:
AdminGetInviteCodes

Get an admin view of invite codes.

Parameters

Name Key Required Type Description
Sort Method
 sort string

Sorting method for invite codes.
Limit
 limit integer

Maximum number of results to return.
Pagination Cursor
 cursor string

Cursor for pagination.

Returns

Name Path Type Description
Cursor for pagination.
 cursor string
codes
 codes array of inviteCode

Get Known Followers

Operation ID:
GetKnownFollowers

Retrieve followers for a specific account that are also followed by the viewer.

Parameters

Name Key Required Type Description
Actor Identifier
 actor True string

The handle or DID of the actor whose followers are being retrieved.
Followers Limit
 limit integer

The maximum number of followers to return (default: 50, max: 100).
Pagination Cursor
 cursor string

Pagination cursor for retrieving the next set of results.

Returns

The outputs of this operation are dynamic.

Get Likes

Operation ID:
GetLikes

Get like records which reference a subject (by AT-URI and CID).

Parameters

Name Key Required Type Description
AT-URI of the subject.
 uri True string

AT-URI of the subject (e.g., a post record).
CID of the subject record.
 cid string

CID of the subject record (specific version of record), to filter likes.
Limit number of results.
 limit integer

Limit
Pagination cursor.
 cursor string

Pagination cursor

Returns

Name Path Type Description
uri
 uri string
cid
 cid string
cursor
 cursor string
likes
 likes array of getLikesLike

Get List Feed

Operation ID:
GetListFeed

Get a feed of recent posts from a list.

Parameters

Name Key Required Type Description
List Reference
 list True string

Reference (AT-URI) to the list record.
Result Limit
 limit integer

Maximum number of posts to retrieve.
Pagination Cursor
 cursor string

Optional pagination mechanism.

Returns

Name Path Type Description
cursor
 cursor string

Pagination cursor for the next set of results.
feed
 feed array of feedViewPost

Array of posts in the feed.

Get list of communication templates

Operation ID:
ListTemplates

Retrieve a list of all available communication templates.

Returns

Name Path Type Description
communicationTemplates
 communicationTemplates array of templateView

Get List View

Operation ID:
GetList

Gets a 'view' (with additional context) of a specified list.

Parameters

Name Key Required Type Description
List Reference
 list True string

Reference (AT-URI) of the list record to hydrate.
Limit Results
 limit integer

The maximum number of results to return.
Cursor for Pagination
 cursor string

Cursor to retrieve the next set of results.

Returns

Name Path Type Description
cursor
 cursor string

Cursor for the next set of results.
list
 list listView
items
 items array of listItemView

Get Lists

Operation ID:
GetLists

Enumerates the lists created by a specified account.

Parameters

Name Key Required Type Description
Account Identifier
 actor True string

The account (actor) to enumerate lists from.
Limit Results
 limit integer

Maximum number of results to return.
Pagination Cursor
 cursor string

Cursor to retrieve the next set of results.

Returns

Name Path Type Description
cursor
 cursor string

Cursor for the next set of results.
lists
 lists array of listView

Get Log

Operation ID:
GetLog

Retrieve the log of actions and messages in a conversation.

Parameters

Name Key Required Type Description
Pagination Cursor
 cursor string

Pagination cursor for retrieving the next set of logs.

Returns

The outputs of this operation are dynamic.

Get Message Context

Operation ID:
GetMessageContext

Fetch surrounding messages from a conversation

Parameters

Name Key Required Type Description
Conversation Id
 convoId string

Conversation that the message is from.
Message Id
 messageId True string

The ID of the message.
Number of messages to include before the specified message.
 before integer

Number of messages to include before the specified message.
Number of messages to include after the specified message.
 after integer

Number of messages to include after the specified message.

Returns

The outputs of this operation are dynamic.

Get Messages

Operation ID:
GetMessages

Get a list of messages from a specific conversation.

Parameters

Name Key Required Type Description
Conversation ID
 convoId True string

The ID of the conversation to retrieve messages from.
Pagination Limit
 limit integer

The maximum number of messages to return (default: 50, max: 100).
Pagination Cursor
 cursor string

Pagination cursor for retrieving the next set of messages.

Returns

The outputs of this operation are dynamic.

Get Moderation Repositories

Operation ID:
GetRepos

Get a list of all moderation repositories.

Returns

Name Path Type Description
repositories
 repositories array of object

List of moderation repositories.
id
 repositories.id string

Unique identifier of the repository.
status
 repositories.status string

The status of the repository.

Get Muted Lists

Operation ID:
GetListMutes

Get mod lists that the requesting account currently has muted.

Parameters

Name Key Required Type Description
Limit Results
 limit integer

Maximum number of results to return.
Pagination Cursor
 cursor string

Cursor to retrieve the next set of results.

Returns

Name Path Type Description
cursor
 cursor string

Cursor for the next set of results.
lists
 lists array of listView

Get Mutes

Operation ID:
GetMutes

Enumerates accounts that the requesting account currently has muted.

Parameters

Name Key Required Type Description
Limit Results
 limit integer

Maximum number of results to return.
Pagination Cursor
 cursor string

Cursor to retrieve the next set of results.

Returns

Name Path Type Description
cursor
 cursor string

Cursor for the next set of results.
mutes
 mutes array of profileView

Get Post Thread

Operation ID:
GetPostThread

Get posts in a thread.

Parameters

Name Key Required Type Description
Post AT-URI
 uri True string

Reference (AT-URI) to post record.
Reply Depth
 depth integer

How many levels of reply depth should be included in response.
Parent Post Levels
 parentHeight integer

How many levels of parent (and grandparent, etc) post to include.

Returns

Name Path Type Description
status
 thread.status string
threadgate
 threadgate threadgateView

Get Posts

Operation ID:
GetPosts

Gets post views for a specified list of posts.

Parameters

Name Key Required Type Description
Post AT-URIs
 uris True array

List of post AT-URIs to return hydrated views for.

Returns

Name Path Type Description
posts
 posts array of postView

Get preferences

Operation ID:
GetPreferences

Get private preferences attached to the current account.

Returns

Name Path Type Description
preferences
 preferences preferences

Get Profile

Operation ID:
GetProfile

Retrieve a detailed profile view of an actor using their handle or DID.

Parameters

Name Key Required Type Description
Actor Identifier
 actor True string

Handle or DID of the account to fetch the profile of.

Returns

The outputs of this operation are dynamic.

Get Profiles

Operation ID:
GetProfiles

Get detailed profile views of multiple actors.

Parameters

Name Key Required Type Description
List of actor identifiers
 actors True array

Actor Identifier

Returns

Name Path Type Description
profiles
 profiles array of profileViewDetailed

Get public relationships between one account, and a list of other accounts

Operation ID:
GetRelationships

Get public relationships between one account, and a list of other accounts.

Parameters

Name Key Required Type Description
Primary Account
 actor True string

Primary account requesting relationships for.
Other Accounts
 others string

List of 'other' accounts to be related back to the primary.

Returns

Name Path Type Description
actor
 actor string

The DID of the primary account.
relationships
 relationships array of object

List of relationships between the actor and other accounts.
type
 relationships.type string

The type of relationship or status.

Get Quotes

Operation ID:
GetQuotes

Get a list of quotes for a given post.

Parameters

Name Key Required Type Description
Post Reference URI
 uri True string

Reference (AT-URI) of the post record.
Specific Version CID
 cid string

If supplied, filters to quotes of specific version (by CID) of the post record.
Result Limit
 limit integer

Maximum number of quotes to retrieve.
Pagination Cursor
 cursor string

Optional pagination mechanism.

Returns

Name Path Type Description
uri
 uri string

Reference (AT-URI) of the post record.
cid
 cid string

Specific version (CID) of the post record.
cursor
 cursor string

Pagination cursor for the next set of results.
posts
 posts array of postView

Array of post views for quotes.

Get repository hosting status

Operation ID:
GetRepoStatus

Get the hosting status for a repository, on this server.

Parameters

Name Key Required Type Description
Repo DID
 did True string

The DID of the repo.

Returns

Name Path Type Description
did
 did string
active
 active boolean
status
 status string

True or false value indicating activity status.
rev
 rev string

Optional field, the current rev of the repo, if active=true

Get Reposted By

Operation ID:
GetRepostedBy

Get a list of reposts for a given post.

Parameters

Name Key Required Type Description
Post Reference URI
 uri True string

Reference (AT-URI) of the post record.
Specific Version CID
 cid string

If supplied, filters to reposts of specific version (by CID) of the post record.
Result Limit
 limit integer

Maximum number of reposts to retrieve.
Pagination Cursor
 cursor string

Optional pagination mechanism.

Returns

Name Path Type Description
uri
 uri string

Reference (AT-URI) of the post record.
cid
 cid string

Specific version (CID) of the post record.
cursor
 cursor string

Pagination cursor for the next set of results.
repostedBy
 repostedBy array of profileView

Array of profiles who reposted the post.

Get Server Configuration

Operation ID:
ServerGetConfig

Get details about ozone's server configuration.

Returns

Name Path Type Description
appview
 appview serviceConfig
pds
 pds serviceConfig
blobDivert
 blobDivert serviceConfig
chat
 chat serviceConfig
viewer
 viewer viewerConfig

Get Service Authentication Token

Operation ID:
GetServiceAuth

Get a signed token on behalf of the requesting DID for the requested service.

Parameters

Name Key Required Type Description
DID
 aud True string

The DID of the service that the token will be used to authenticate with.
Expiration
 exp integer

The time in Unix Epoch seconds that the JWT expires. Defaults = 60 seconds
Lexicon method
 lxm string

Lexicon (XRPC) method to bind the requested token to.

Returns

Name Path Type Description
token
 token string

The signed authentication token.

Get set values

Operation ID:
GetValues

Get a specific set and its values.

Parameters

Name Key Required Type Description
Set name
 name True string

The name of the set to retrieve.
Result limit
 limit integer

Maximum number of values to return.
Pagination cursor
 cursor string

Cursor for pagination.

Returns

Name Path Type Description
set
 set setView
values
 values array of string
cursor
 cursor string

Get Starter Pack

Operation ID:
GetStarterPack

Gets a view of a starter pack based on the provided reference (AT-URI).

Parameters

Name Key Required Type Description
Starter Pack Identifier
 starterPack True string

Reference (AT-URI) of the starter pack record.

Returns

Name Path Type Description
starterPack
 starterPack starterPackView

Get Starter Packs

Operation ID:
GetStarterPacks

Get detailed views for a list of starter packs based on the provided URIs.

Parameters

Name Key Required Type Description
Starter Pack URIs
 uris True string

List of AT-URIs for the starter packs (maximum 25 items).

Returns

The outputs of this operation are dynamic.

Get status details for a video processing job

Operation ID:
GetjobStatus

Get status details for a video processing job.

Parameters

Name Key Required Type Description
Job ID
 jobId True string

The ID of the video processing job to retrieve the status for.

Returns

Name Path Type Description
jobStatus
 jobStatus jobStatus

Get Suggested Actors

Operation ID:
GetSuggestions

Get a list of suggested actors.

Parameters

Name Key Required Type Description
Limit
 limit integer

The maximum number of results to return.
Cursor
 cursor string

A cursor for pagination.

Returns

Name Path Type Description
cursor
 cursor string

Pagination cursor for the next set of results.
actors
 actors array of profileView

List of suggested actor profiles.

Get Suggested Feeds

Operation ID:
GetSuggestedFeeds

Retrieve a list of suggested feeds for the requesting account.

Parameters

Name Key Required Type Description
Limit
 limit integer

The maximum number of suggested feeds to return (default: 50, max: 100).
Pagination cursor
 cursor string

Pagination cursor for retrieving the next set of results.

Returns

The outputs of this operation are dynamic.

Get Suggested Follows by Actor

Operation ID:
GetSuggestedFollowsByActor

Enumerates follows similar to a given account.

Parameters

Name Key Required Type Description
Actor
 actor True string

The account identifier for which similar follows are suggested.

Returns

Name Path Type Description
suggestions
 suggestions array of profileView

List of suggested profiles to follow.
isFallback
 isFallback boolean

Indicates if the results are fallback generic suggestions.

Get the current commit of a repo

Operation ID:
GetLatestCommit

Get the current commit CID & revision of the specified repo.

Parameters

Name Key Required Type Description
Repo DID
 did True string

The DID of the repo.

Returns

Name Path Type Description
cid
 cid string
rev
 rev string

Revision identifier of the repo.

Get Timeline

Operation ID:
GetTimeline

Get a view of the requesting account's home timeline.

Parameters

Name Key Required Type Description
Algorithm variant
 algorithm string

Variant 'algorithm' for the timeline.
Limit
 limit integer

The maximum number of posts to return (default: 50, max: 100).
Pagination cursor
 cursor string

Pagination cursor for retrieving the next set of results.

Returns

The outputs of this operation are dynamic.

Get video upload limits for the authenticated user

Operation ID:
GetUploadLimits

Get video upload limits for the authenticated user.

Returns

Name Path Type Description
canUpload
 canUpload boolean

Indicates if the user can upload videos.
remainingDailyVideos
 remainingDailyVideos integer

Number of videos the user can still upload today.
remainingDailyBytes
 remainingDailyBytes integer

Remaining data size in bytes available for uploads today.
message
 message string

Additional information regarding the upload limits.
error
 error string

Error message if applicable.

GetRecommendedDidCredentials

Operation ID:
GetRecommendedDidCredentials

Describe the credentials that should be included in the DID doc of an account that is migrating to this service.

Returns

Name Path Type Description
rotationKeys
 rotationKeys array of string
alsoKnownAs
 alsoKnownAs array of string
verificationMethods
 verificationMethods object
services
 services object

Import a repo in the form of a CAR file

Operation ID:
ImportRepo

Import a repo in the form of a CAR file. Content-Length header required.

Parameters

Name Key Required Type Description
CAR file details
 body True string

The CAR file to import.

Returns

Name Path Type Description
message
 message string

Success message indicating the repo was imported.
repoId
 repoId string

The unique identifier of the imported repo.

Leave Conversation

Operation ID:
LeaveConvo

Leave a conversation by specifying its ID.

Parameters

Name Key Required Type Description
convoId
 convoId True string

The ID of the conversation to leave.

Returns

Name Path Type Description
convoId
 convoId string

The ID of the conversation that was left.
rev
 rev string

The revision identifier of the conversation.

List account blob CIDs

Operation ID:
ListBlobs

List account blob CIDs since a repo revision.

Parameters

Name Key Required Type Description
Repo DID
 did True string

The DID of the repo.
Revision
 since string

Optional revision of the repo to list blobs since.
Result Limit
 limit integer

The maximum number of results to return.
Cursor
 cursor string

Pagination cursor for the next set of results.

Returns

Name Path Type Description
cursor
 cursor string
cids
 cids array of string

List all members with access to the ozone service

Operation ID:
ListMembersTeam

List all members with access to the ozone service.

Parameters

Name Key Required Type Description
Limit results
 limit integer

The maximum number of results to return.
Pagination cursor
 cursor string

Cursor for paginating results.

Returns

Name Path Type Description
cursor
 cursor string

Pagination cursor for the next page of results.
members
 members array of member

List App Passwords

Operation ID:
ServerListAppPasswords

List all App Passwords.

Returns

Name Path Type Description
passwords
 passwords array of listAppPassword

List Conversations

Operation ID:
ListConvos

List conversations.

Parameters

Name Key Required Type Description
Pagination Limit
 limit integer

The maximum number of conversations to return (default: 50, max: 100).
Pagination Cursor
 cursor string

Pagination cursor for retrieving the next set of results.

Returns

Name Path Type Description
cursor
 cursor string

Cursor for pagination.
convos
 convos array of object
id
 convos.id string

The unique identifier of the conversation.
rev
 convos.rev string

The revision identifier of the conversation.
members
 convos.members array of chatProfileViewBasic

List of members in the conversation.
lastMessage
 convos.lastMessage lastMessage

Represents the last message in a conversation.
muted
 convos.muted boolean

Indicates whether the conversation is muted.
opened
 convos.opened boolean

Indicates whether the conversation has been opened.
unreadCount
 convos.unreadCount integer

The count of unread messages in the conversation.

List missing blobs for the requesting account

Operation ID:
ListMissingBlobs

Returns a list of missing blobs for the requesting account.

Parameters

Name Key Required Type Description
Limit results
 limit integer

The maximum number of results to return.
Pagination cursor
 cursor string

Cursor for paginating results.

Returns

Name Path Type Description
cursor
 cursor string

Pagination cursor for the next page of results.
blobs
 blobs array of listMissingBlobs.recordBlob
Operation ID:
QueryEvents

List moderation events related to a subject.

Parameters

Name Key Required Type Description
Event type for filtering
 types array

Event type to filter by: defs#modEvent<name>
Created by
 createdBy string

Created by user
Sort order
 sortDirection string

Sort direction for the events.
Events created after a timestamp
 createdAfter date-time

Retrieve events created after a given timestamp.
Events created before a timestamp
 createdBefore date-time

Retrieve events created before a given timestamp.
Subject
 subject string

Subject
Event collection
 collections array

Returns events where the subject belongs to the given collections.
Subject Type
 subjectType string

Returns events where the subject is account or record.
Returns events of all types
 includeAllUserRecords boolean

Returns events on all record type from given 'collections' param.
Limit
 limit integer

Limit
Has comment, yes/no
 hasComment boolean

If true, only events with comments are returned.
Comment
 comment string

Returns events with comments containing the keyword.
Addedl labels
 addedLabels array

Returns events where all of these labels were added are returned.
Events with removed labels
 removedLabels array

Returns events where labels were removed.
Removed labels
 addedTags array

Returns events where labels were removed.
Removed tags
 removedTags array

Returns events where tags were removed.
Report types
 reportTypes array

Report type for moderation event
Pagination cursor
 cursor string

Pagination cursor

Returns

Name Path Type Description
cursor
 cursor string
events
 events array of modEventView

List Notifications

Operation ID:
ListNotifications

Enumerate notifications for the requesting account.

Parameters

Name Key Required Type Description
Limit
 limit integer

The maximum number of notifications to return.
Priority
 priority boolean

Filter notifications by priority status.
Cursor
 cursor string

Pagination cursor for retrieving the next set of notifications.
Seen At
 seenAt date-time

Filter notifications seen at or after the specified date-time.

Returns

Name Path Type Description
cursor
 cursor string

Pagination cursor for the next set of results.
notifications
 notifications array of notification

List of notifications.
priority
 priority boolean

Indicates if priority notifications are included.
seenAt
 seenAt date-time

Timestamp indicating when notifications were last seen.

List records in a repository

Operation ID:
ListRecords

List a range of records in a repository, matching a specific collection.

Parameters

Name Key Required Type Description
Repository identifier
 repo True string

The handle or DID of the repo.
Collection type
 collection True string

The NSID of the record type.
Limit results
 limit integer

The number of records to return.
Pagination cursor
 cursor string

Cursor for paginating results.
Reverse order
 reverse boolean

Flag to reverse the order of the returned records.

Returns

Name Path Type Description
cursor
 cursor string

Pagination cursor for the next page of results.
records
 records array of listRecords.record

List repositories

Operation ID:
ListRepos

Enumerates all the DID, rev, and commit CID for all repos

Parameters

Name Key Required Type Description
Result Limit
 limit integer

The maximum number of results to return.
Cursor
 cursor string

Pagination cursor for the next set of results.

Returns

Name Path Type Description
cursor
 cursor string
repos
 repos array of listRepos.repo

Mute Actor

Operation ID:
MuteActor

Creates a mute relationship for the specified account.

Parameters

Name Key Required Type Description
Account Identifier
 actor True string

Identifier of the account to be muted.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the operation was successful.

Mute Actor List

Operation ID:
MuteActorList

Creates a mute relationship for the specified list of accounts.

Parameters

Name Key Required Type Description
List URI
 list True string

URI reference to the list of accounts to be muted.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the operation was successful.

Mute Conversation

Operation ID:
MuteConvo

Mute a conversation.

Parameters

Name Key Required Type Description
convoId
 convoId True string

The ID of the conversation to be muted.

Returns

Name Path Type Description
Conversation View
 convo convoView

Represents a view of a conversation.

Mute Thread

Operation ID:
MuteThread

Mutes a thread preventing notifications from the thread and any of its children.

Parameters

Name Key Required Type Description
Root URI
 root True string

URI reference to the root of the thread to mute.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the operation was successful.

Notify of Update

Operation ID:
NotifyOfUpdate

Notify a crawling service of a recent update, and that crawling should resume.

Parameters

Name Key Required Type Description
hostname
 hostname True string

Hostname of the current service notifying of update.

Notify server that the requesting account has seen notifications

Operation ID:
UpdateSeen

Notify server that the requesting account has seen notifications.

Parameters

Name Key Required Type Description
seenAt
 seenAt True date-time

Timestamp indicating when notifications were seen.

Returns

Name Path Type Description
success
 success boolean

Indicates if the operation was successful.

Query available sets

Operation ID:
QuerySets

Query available sets.

Parameters

Name Key Required Type Description
Result limit
 limit integer

Maximum number of sets to return.
Pagination cursor
 cursor string

Cursor for pagination.
Name prefix
 namePrefix string

Filter sets by a name prefix.
Sort by field
 sortBy string

Field to sort results by.
Sort direction
 sortDirection string

Sort direction, defaults to ascending order of the name field.

Returns

Name Path Type Description
sets
 sets array of setView
cursor
 cursor string

Refresh Authentication Session

Operation ID:
RefreshSession

Refresh an authentication session to obtain a new access token and refresh token.

Parameters

Name Key Required Type Description
refreshJwt
 refreshJwt True string

The refresh token provided during session creation

Returns

Name Path Type Description
accessJwt
 accessJwt string

JWT access token.
refreshJwt
 refreshJwt string

JWT refresh token.
handle
 handle string

The user's handle.
did
 did string

Decentralized Identifier (DID).
didDoc
 didDoc object

Optional DID document.
active
 active boolean

Indicates if the session is active.
status
 status string

Hosting status of the account.

Register to receive push notifications

Operation ID:
RegisterPush

Register to receive push notifications.

Parameters

Name Key Required Type Description
serviceDid
 serviceDid True string

The DID of the push notification service.
token
 token True string

Push notification token.
platform
 platform True string

The platform for the push notification.
appId
 appId True string

Identifier for the app requesting push notifications.

Returns

Name Path Type Description
success
 success boolean

Indicates if the registration was successful.

Request Account Deletion

Operation ID:
ServerRequestAccountDelete

Initiate a user account deletion via email.

Request Crawl

Operation ID:
RequestCrawl

Request a service to persistently crawl hosted repos.

Parameters

Name Key Required Type Description
hostname
 hostname True string

Hostname of the current service requesting to be crawled.

Request Email Confirmation

Operation ID:
ServerRequestEmailConfirmation

Request an email with a code to confirm ownership of email.

Request Email Update

Operation ID:
ServerRequestEmailUpdate

Request a token in order to update email.

Returns

Name Path Type Description
tokenRequired
 tokenRequired boolean

Indicates if a token is required for the email update.

Request Password Reset

Operation ID:
RequestPasswordReset

Initiate a user account password reset via email.

Parameters

Name Key Required Type Description
email
 email True string

The email address associated with the user account.

RequestPlcOperationSignature

Operation ID:
RequestPlcOperationSignature

Request an email with a code to in order to request a signed PLC operation.

Returns

Name Path Type Description
success
 success boolean

Indicates if the request was successful.

Reserve Signing Key

Operation ID:
ReserveSigningKey

Reserve a repo signing key for use with account creation.

Parameters

Name Key Required Type Description
did
 did string

The Decentralized Identifier (DID) to reserve a signing key for.

Returns

Name Path Type Description
signingKey
 signingKey string

The public key for the reserved signing key.

Reset Password

Operation ID:
ResetPassword

Reset a user account password using a token.

Parameters

Name Key Required Type Description
token
 token True string

The token provided for password reset.
password
 password True string

The new password for the user account.

ResolveHandle

Operation ID:
ResolveHandle

Resolves a handle (domain name) to a DID.

Parameters

Name Key Required Type Description
The handle to resolve.
 handle True string

The handle to resolve.

Returns

Name Path Type Description
did
 did string

The resolved DID.

Retrieve record view

Operation ID:
EmbedRecordView

Returns dynamic schema information for the record view.

Parameters

Name Key Required Type Description
Record Id
 recordId True string

Identifier for the record.

Returns

Name Path Type Description
record
 record object

Details of the record view.

Revoke App Password

Operation ID:
ServerRevokeAppPassword

Revoke an App Password by name.

Parameters

Name Key Required Type Description
name
 name True string

The name of the App Password to revoke.

Search Accounts

Operation ID:
AdminSearchAccounts

Get a list of accounts that matches your search query.

Parameters

Name Key Required Type Description
Email address to search.
 email string

The email address to search for.
Pagination cursor for next results.
 cursor string

Pagination cursor for the next set of results.
Maximum number of results to retrieve.
 limit integer

The maximum number of results to retrieve

Returns

Name Path Type Description
cursor
 cursor string

Cursor to retrieve the next set of results.
accounts
 accounts array of accountView

List of matching accounts.

Search Actors for Typeahead

Operation ID:
SearchActorsTypeahead

Retrieve account suggestions for typeahead search.

Parameters

Name Key Required Type Description
Search Term
 q string

The search term used for typeahead results.
Limit
 limit integer

Maximum number of results to retrieve.

Returns

Name Path Type Description
actors
 actors array of appProfileViewBasic

An array of minimal actor details matching the typeahead search.

Search Posts

Operation ID:
SearchPosts

Find posts matching search criteria, returning views of those posts.

Parameters

Name Key Required Type Description
Search Query
 q True string

Search query string.
Sort Order
 sort string

Specifies the ranking order of results.
Since Datetime
 since string

Filter results for posts after the indicated datetime (inclusive).
Until Datetime
 until string

Filter results for posts before the indicated datetime (not inclusive).
Mentions Account
 mentions string

Filter to posts which mention the given account.
Author Account
 author string

Filter to posts by the given account. Handles are resolved to DID before query-time.
Language Filter
 lang string

Filter to posts in the given language.
Domain Filter
 domain string

Filter to posts with URLs.
URL Filter
 url string

Filter to posts with links.
Hashtag Filter
 tag array

Filter to posts with the given tag (hashtag).
Result Limit
 limit integer

Maximum number of results to return.
Pagination Cursor
 cursor string

Optional pagination mechanism.

Returns

Name Path Type Description
cursor
 cursor string
hitsTotal
 hitsTotal integer
posts
 posts array of postView

Send Batch Messages

Operation ID:
SendMessageBatch

Send a batch of messages to multiple conversations.

Parameters

Name Key Required Type Description
convoId
 convoId True string
text
 text True string
byteStart
 byteStart True integer

The starting byte of the range.
byteEnd
 byteEnd True integer

The ending byte of the range.
featureType
 featureType string

Type of the feature.
details
 details object

Details about the feature.
uri
 uri True string

The URI of the strong reference.
cid
 cid True string

The CID of the strong reference.

Returns

The outputs of this operation are dynamic.

Send email to a user's account email address

Operation ID:
SendEmail

Send email to a user's account email address.

Parameters

Name Key Required Type Description
Recipient DID
 recipientDid True string

Decentralized Identifier (DID) of the recipient.
Content
 content True string

Content of the email.
Subject
 subject string

Subject of the email.
Sender DID
 senderDid True string

DID of the sender.
Additional comment
 comment string

Additional comment by the sender that won't be used in the email itself.

Returns

Name Path Type Description
sent
 sent boolean

Indicates whether the email was successfully sent.

Send Interactions

Operation ID:
SendInteractions

Send information about interactions.

Parameters

Name Key Required Type Description
item
 item string
event
 event string
feedContext
 feedContext string

Context on a feed item originally supplied by the feed generator on getFeedSkeleton.

Returns

Send Message

Operation ID:
SendMessage

Send a single message to a specific conversation.

Parameters

Name Key Required Type Description
convoId
 convoId True string

The ID of the conversation.
text
 text True string
byteStart
 byteStart True integer

The starting byte of the range.
byteEnd
 byteEnd True integer

The ending byte of the range.
featureType
 featureType string

Type of the feature.
details
 details object

Details about the feature.
uri
 uri True string

The URI of the strong reference.
cid
 cid True string

The CID of the strong reference.

Returns

The outputs of this operation are dynamic.

Set Account Preferences

Operation ID:
PutPreferences

Set the private preferences attached to the account.

Parameters

Name Key Required Type Description
enabled
 enabled True boolean
labelerDid
 labelerDid string

Which labeler does this preference apply to?
label
 label True string
visibility
 visibility True string
pinned
 pinned True array of string
saved
 saved True array of string
timelineIndex
 timelineIndex integer
id
 id True string
type
 type True string
value
 value True string
pinned
 pinned True boolean
birthDate
 birthDate date-time

The birth date of account owner.
feed
 feed True string

The URI of the feed, or an identifier which describes the feed.
hideReplies
 hideReplies boolean

Hide replies in the feed.
hideRepliesByUnfollowed
 hideRepliesByUnfollowed boolean

Hide replies in the feed if they are not by followed users.
hideRepliesByLikeCount
 hideRepliesByLikeCount integer
hideReposts
 hideReposts boolean

Hide reposts in the feed.
hideQuotePosts
 hideQuotePosts boolean

Hide quote posts in the feed.
sort
 sort string

Sorting mode for threads.
prioritizeFollowedUsers
 prioritizeFollowedUsers boolean

Show followed users at the top of all replies.
tags
 tags True array of string
id
 id string
value
 value True string

The muted word itself.
targets
 targets string
actorTarget
 actorTarget string

Groups of users to apply the muted word to. If undefined, applies to all users.
expiresAt
 expiresAt date-time

The date and time at which the muted word will expire and no longer be applied.
items
 items True array of string
guide
 guide True string
queuedNudges
 queuedNudges array of string
id
 id True string
completed
 completed True boolean
data
 data string

Arbitrary data for the NUX. 300-character limit.
expiresAt
 expiresAt date-time

The date and time at which the NUX will expire and completed.
did
 did True string

Returns

Name Path Type Description
success
 success boolean

Indicates whether the operation was successful.
message
 message string

Optional success message.

Set Notification Preferences

Operation ID:
PutNotificationPreferences

Set notification-related preferences for an account.

Parameters

Name Key Required Type Description
priority
 priority True boolean

Indicates if priority notifications should be enabled.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the operation was successful.
message
 message string

Optional success message.

SignPlcOperation

Operation ID:
SignPlcOperation

Signs a PLC operation to update some value(s) in the requesting DID's document.

Parameters

Name Key Required Type Description
token
 token True string

A token received through com.atproto.identity.requestPlcOperationSignature.
rotationKeys
 rotationKeys array of string
alsoKnownAs
 alsoKnownAs array of string
verificationMethods
 verificationMethods object
services
 services object

Returns

Name Path Type Description
operation
 operation object

SubmitPlcOperation

Operation ID:
SubmitPlcOperation

Validates a PLC operation to ensure that it doesn't violate a service's constraints.

Parameters

Name Key Required Type Description
operation
 operation True object

The PLC operation to be validated.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the operation was successfully validated.

Take a moderation action on an actor

Operation ID:
EmitEvent

Take a moderation action on an actor

Parameters

Name Key Required Type Description
event
 event True string

The moderation event to emit.
subject
 subject True string

The subject of the moderation event.
subjectBlobCids
 subjectBlobCids array of string
createdBy
 createdBy True string

Returns

Body
modEventView

Unmute Actor

Operation ID:
UnmuteActor

Unmutes the specified account.

Parameters

Name Key Required Type Description
Actor ID
 actor True string

The identifier (AT-identifier) of the actor to unmute.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the operation was successful.

Unmute Actor List

Operation ID:
UnmuteActorList

Unmutes the specified list of accounts.

Parameters

Name Key Required Type Description
List URI
 list True string

The URI of the list to unmute.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the operation was successful.

Unmute Conversation

Operation ID:
UnmuteConvo

Unmute a conversation.

Parameters

Name Key Required Type Description
convoId
 convoId True string

The ID of the conversation to be unmuted.

Returns

Name Path Type Description
Conversation View
 convo convoView

Represents a view of a conversation.

Unmute Thread

Operation ID:
UnmuteThread

Unmutes the specified thread.

Parameters

Name Key Required Type Description
Root Thread URI
 root True string

The URI of the root thread to unmute.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the operation was successful.

Update a member in the ozone service

Operation ID:
UpdateMemberTeam

Update a member in the ozone service.

Parameters

Name Key Required Type Description
did
 did True string

The DID of the member.
disabled
 disabled boolean

Indicates if the member is disabled.
role
 role string

The role assigned to the member.

Returns

Body
member

Update Account Email

Operation ID:
UpdateAccountEmail

Administrative action to update an account's email.

Parameters

Name Key Required Type Description
account
 account True string

The handle or DID of the repo.
email
 email True string

The new email address for the account.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the update was successful.
message
 message string

Optional message providing additional information.

Update Account Handle

Operation ID:
UpdateAccountHandle

Administrative action to update an account's handle.

Parameters

Name Key Required Type Description
did
 did True string

The DID of the account.
handle
 handle True string

The new handle for the account.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the update was successful.
message
 message string

Optional message providing additional information.

Update Account Password

Operation ID:
UpdateAccountPassword

Update the password for a user account as an administrator.

Parameters

Name Key Required Type Description
did
 did True string

The DID of the account to update.
password
 password True string

The new password for the account.

Returns

Name Path Type Description
success
 success boolean

Indicates if the operation was successful.
message
 message string

Additional details about the operation result.

Update Actor Access

Operation ID:
UpdateActorAccess

Update an actor's access permissions.

Parameters

Name Key Required Type Description
Actor Identifier
 actor True string
Allow Access
 allowAccess True boolean
Reference ID
 ref string

Returns

Name Path Type Description
success
 success boolean

Indicates if the access update was successful.
message
 message string

Optional message detailing the result.

Update an existing communication template

Operation ID:
UpdateTemplate

Administrative action to update an existing communication template.

Parameters

Name Key Required Type Description
id
 id True string

ID of the template to be updated.
name
 name string

Name of the template.
lang
 lang string

Message language.
contentMarkdown
 contentMarkdown string

Content of the template, markdown supported, can contain variable placeholders.
subject
 subject string

Subject of the message, used in emails.
updatedBy
 updatedBy string

DID of the user who is updating the template.
disabled
 disabled boolean

Whether the template is disabled.

Returns

Body
templateView

Update Conversation Read Status

Operation ID:
UpdateRead

Update an item in a conversation to mark it as read.

Parameters

Name Key Required Type Description
convoId
 convoId True string

The ID of the conversation.
messageId
 messageId string

The ID of the message to mark as read.

Returns

Name Path Type Description
Conversation View
 convo convoView

Represents a view of a conversation.

Update Email

Operation ID:
ServerUpdateEmail

Update an account's email.

Parameters

Name Key Required Type Description
email
 email True string

The new email address to update the account with.
emailAuthFactor
 emailAuthFactor boolean

Whether email is used as an authentication factor.
token
 token string

A token from requestEmailUpdate if the account's email has been confirmed.

Update Subject Status

Operation ID:
UpdateSubjectStatus

Update the service-specific admin status of a subject.

Parameters

Name Key Required Type Description
did
 did True string
uri
 uri True string

The URI of the strong reference.
cid
 cid True string

The CID of the strong reference.
did
 did True string
cid
 cid True string
recordUri
 recordUri string
applied
 applied True boolean
ref
 ref string
applied
 applied True boolean
ref
 ref string

Returns

Name Path Type Description
repoRef
 subject.repoRef repoRef
strongRef
 subject.strongRef strongRef

Defines a strong reference with a URI and CID.
repoBlobRef
 subject.repoBlobRef repoBlobRef
takedown
 takedown statusAttr

UpdateHandle

Operation ID:
UpdateHandle

Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary.

Parameters

Name Key Required Type Description
handle
 handle True string

The new handle.

Returns

Name Path Type Description
success
 success boolean

Indicates whether the handle was successfully updated.
message
 message string

Additional information about the operation.

Upload a new blob

Operation ID:
UploadBlob

Upload a new blob.

Parameters

Name Key Required Type Description
File to upload
 file True file

The blob file to upload.

Returns

Name Path Type Description
blob
 blob string

The uploaded blob ID.

Upload Video

Operation ID:
UploadVideo

Upload a video to be processed and stored on the PDS.

Parameters

Name Key Required Type Description
Video file
 file True file

Binary video file to be uploaded and processed.

Returns

The outputs of this operation are dynamic.

View moderation statuses of subjects

Operation ID:
QueryStatusesModeration

View moderation statuses of subjects (record or repo).

Parameters

Name Key Required Type Description
Include all user records
 includeAllUserRecords boolean

Returns subjects, or subjects from 'collections' param, belonging to the account specified.
Subject URI
 subject string

The subject to get the status for.
Comment keyword
 comment string

Search subjects by keyword from comments.
Reported after timestamp
 reportedAfter date-time

Search subjects reported after a given timestamp.
Reported before timestamp
 reportedBefore date-time

Search subjects reported before a given timestamp.
Reviewed after timestamp
 reviewedAfter date-time

Search subjects reviewed after a given timestamp.
Reviewed before timestamp
 reviewedBefore date-time

Search subjects reviewed before a given timestamp.
Hosting deleted after timestamp
 hostingDeletedAfter date-time

Search subjects where the associated record/account was deleted after timestamp.
Hosting deleted before timestamp
 hostingDeletedBefore date-time

Search subjects where the associated record/account was deleted before timestamp.
Hosting updated after timestamp
 hostingUpdatedAfter date-time

Search subjects where the associated record/account was updated after timestamp.
Hosting updated before timestamp
 hostingUpdatedBefore date-time

Search subjects where the associated record/account was updated before timestamp.
Hosting statuses
 hostingStatuses array

Search subjects by the status of the associated record/account.
Include muted subjects
 includeMuted boolean

By default, we don't include muted subjects in the results.
Review state
 reviewState string

Specify when fetching subjects in a certain state.
Limit results
 limit integer

The maximum number of results to return.

Returns

Name Path Type Description
cursor
 cursor string

Pagination cursor for the next page of results.
subjectStatuses
 subjectStatuses array of subjectStatusView

Write a repository record

Operation ID:
PutRecord

Write a repository record, creating or updating it as needed.

Parameters

Name Key Required Type Description
repo
 repo True string

The handle or DID of the repo (aka, current account).
collection
 collection True string

The NSID of the record collection.
rkey
 rkey True string

The Record Key.
validate
 validate boolean

True/false value for skipping Lexicon schema validation.
record
 record True object

The content of the record.
swapRecord
 swapRecord string

Compare and swap with the previous record by CID.
swapCommit
 swapCommit string

Compare and swap with the previous commit by CID.

Returns

Name Path Type Description
uri
 uri string
cid
 cid string
commit
 commit commitMeta
validationStatus
 validationStatus string

Definitions

preferences

Name Path Type Description
adultContentPref
 adultContentPref adultContentPref
contentLabelPref
 contentLabelPref contentLabelPref
savedFeedsPref
 savedFeedsPref savedFeedsPref
savedFeedsPrefV2
 savedFeedsPrefV2 savedFeedsPrefV2
personalDetailsPref
 personalDetailsPref personalDetailsPref
feedViewPref
 feedViewPref feedViewPref
threadViewPref
 threadViewPref threadViewPref
interestsPref
 interestsPref interestsPref
mutedWordsPref
 mutedWordsPref mutedWordsPref
hiddenPostsPref
 hiddenPostsPref hiddenPostsPref
bskyAppStatePref
 bskyAppStatePref bskyAppStatePref

A grab bag of state that's specific to the bsky.app program.
labelersPref
 labelersPref labelersPref

adultContentPref

Name Path Type Description
enabled
 enabled boolean

contentLabelPref

Name Path Type Description
labelerDid
 labelerDid string

Which labeler does this preference apply to?
label
 label string
visibility
 visibility string

savedFeed

Name Path Type Description
id
 id string
type
 type string
value
 value string
pinned
 pinned boolean

savedFeedsPrefV2

Name Path Type Description
items
 items array of savedFeed

savedFeedsPref

Name Path Type Description
pinned
 pinned array of string
saved
 saved array of string
timelineIndex
 timelineIndex integer

personalDetailsPref

Name Path Type Description
birthDate
 birthDate date-time

The birth date of account owner.

feedViewPref

Name Path Type Description
feed
 feed string

The URI of the feed, or an identifier which describes the feed.
hideReplies
 hideReplies boolean

Hide replies in the feed.
hideRepliesByUnfollowed
 hideRepliesByUnfollowed boolean

Hide replies in the feed if they are not by followed users.
hideRepliesByLikeCount
 hideRepliesByLikeCount integer
hideReposts
 hideReposts boolean

Hide reposts in the feed.
hideQuotePosts
 hideQuotePosts boolean

Hide quote posts in the feed.

threadViewPref

Name Path Type Description
sort
 sort string

Sorting mode for threads.
prioritizeFollowedUsers
 prioritizeFollowedUsers boolean

Show followed users at the top of all replies.

interestsPref

Name Path Type Description
tags
 tags array of string

mutedWordTarget

string

mutedWord

A word that the account owner has muted.

Name Path Type Description
id
 id string
value
 value string

The muted word itself.
targets
 targets array of mutedWordTarget
actorTarget
 actorTarget string

Groups of users to apply the muted word to. If undefined, applies to all users.
expiresAt
 expiresAt date-time

The date and time at which the muted word will expire and no longer be applied.

mutedWordsPref

Name Path Type Description
items
 items array of mutedWord

hiddenPostsPref

Name Path Type Description
items
 items array of string

labelersPref

Name Path Type Description
labelers
 labelers array of labelerPrefItem

labelerPrefItem

Name Path Type Description
did
 did string

starterPackView

Name Path Type Description
uri
 uri string
cid
 cid string
record
 record
creator
 creator appProfileViewBasic
list
 list listViewBasic
listItemsSample
 listItemsSample array of listItemView
feeds
 feeds array of generatorView
joinedWeekCount
 joinedWeekCount integer
joinedAllTimeCount
 joinedAllTimeCount integer
labels
 labels array of label
indexedAt
 indexedAt date-time

starterPackViewBasic

Name Path Type Description
uri
 uri string
cid
 cid string
record
 record
creator
 creator appProfileViewBasic
listItemCount
 listItemCount integer
joinedWeekCount
 joinedWeekCount integer
joinedAllTimeCount
 joinedAllTimeCount integer
labels
 labels array of label
indexedAt
 indexedAt date-time

bskyAppStatePref

A grab bag of state that's specific to the bsky.app program.

Name Path Type Description
activeProgressGuide
 activeProgressGuide bskyAppProgressGuide

If set, an active progress guide.
queuedNudges
 queuedNudges array of string
nuxs
 nuxs array of nux

bskyAppProgressGuide

If set, an active progress guide.

Name Path Type Description
guide
 guide string

nux

A new user experiences (NUX) storage object

Name Path Type Description
id
 id string
completed
 completed boolean
data
 data string

Arbitrary data for the NUX. 300-character limit.
expiresAt
 expiresAt date-time

The date and time at which the NUX will expire and completed.

profileViewDetailed

Name Path Type Description
did
 did string
handle
 handle string
displayName
 displayName string
description
 description string
avatar
 avatar string
banner
 banner string
followersCount
 followersCount integer
followsCount
 followsCount integer
postsCount
 postsCount integer
associated
 associated profileAssociated
joinedViaStarterPack
 joinedViaStarterPack starterPackViewBasic
indexedAt
 indexedAt date-time
createdAt
 createdAt date-time
viewer
 viewer appViewerState

Metadata about the requesting account's relationship with the subject account.
labels
 labels array of label
pinnedPost
 pinnedPost strongRef

Defines a strong reference with a URI and CID.

profileView

Basic information about a profile.

Name Path Type Description
did
 did string

Decentralized Identifier (DID) of the profile.
handle
 handle string

The handle of the profile.
displayName
 displayName string

Display name of the profile.
avatar
 avatar string

Avatar URL of the profile.
associated
 associated associatedMetadata

Associated metadata for a profile.
viewer
 viewer viewerMetadata

Metadata about the viewer's relationship to the actor.
labels
 labels array of label

Labels associated with the profile.
createdAt
 createdAt date-time

Timestamp when the profile was created.

associatedMetadata

Associated metadata for a profile.

Name Path Type Description
lists
 lists integer

Number of associated lists.
feedgens
 feedgens integer

Number of associated feed generators.
starterPacks
 starterPacks integer

Number of starter packs.
labeler
 labeler boolean

Indicates if the profile is a labeler.
allowIncoming
 chat.allowIncoming string

Allowed incoming chat settings (e.g., "all").

mutedByList

Details of a list that muted the actor.

Name Path Type Description
uri
 uri string

URI of the list that muted the actor.
cid
 cid string

Content Identifier (CID) of the list.
name
 name string

Name of the list.
purpose
 purpose string

Purpose of the list.
avatar
 avatar string

Avatar image URI for the list.
listItemCount
 listItemCount integer

Number of items in the list.
labels
 labels array of label

Labels associated with the list.
viewer
 viewer viewerMetadata

Metadata about the viewer's relationship to the actor.
indexedAt
 indexedAt date-time

The timestamp when the list was indexed.

blockingByList

Details of a list that blocks the actor.

Name Path Type Description
uri
 uri string

URI of the list that blocks the actor.
cid
 cid string

Content Identifier (CID) of the list.
name
 name string

Name of the list.
purpose
 purpose string

Purpose of the list.
avatar
 avatar string

Avatar image URI for the list.
listItemCount
 listItemCount integer

Number of items in the list.
labels
 labels array of label

Labels associated with the list.
viewer
 viewer viewerMetadata

Metadata about the viewer's relationship to the actor.
indexedAt
 indexedAt date-time

The timestamp when the list was indexed.

viewerMetadata

Metadata about the viewer's relationship to the actor.

Name Path Type Description
muted
 muted boolean

Indicates if the actor is muted by the viewer.
blockedBy
 blockedBy boolean

Indicates if the actor is blocked by the viewer.
blocking
 blocking string

Indicates if the viewer is blocking the actor.
following
 following string

Indicates if the viewer is following the actor.
followedBy
 followedBy string

Indicates if the actor is following the viewer.
mutedByList
 mutedByList mutedByList

Details of a list that muted the actor.
blockingByList
 blockingByList blockingByList

Details of a list that blocks the actor.

postView

Name Path Type Description
object

feedReplyRef

Name Path Type Description
root
 root object

Root post reference, which can be a postView, notFoundPost, or blockedPost.
parent
 parent object

Parent post reference, which can be a postView, notFoundPost, or blockedPost.
grandparentAuthor
 grandparentAuthor appProfileViewBasic

strongRef

Defines a strong reference with a URI and CID.

Name Path Type Description
uri
 uri string

The URI of the strong reference.
cid
 cid string

The CID of the strong reference.

profileAssociated

Name Path Type Description
lists
 lists integer
feedgens
 feedgens integer
starterPacks
 starterPacks integer
labeler
 labeler boolean
chat
 chat profileAssociatedChat

appViewerState

Metadata about the requesting account's relationship with the subject account.

Name Path Type Description
muted
 muted boolean
mutedByList
 mutedByList listViewBasic
blockedBy
 blockedBy boolean
blocking
 blocking string
blockingByList
 blockingByList listViewBasic
following
 following string
followedBy
 followedBy string
knownFollowers
 knownFollowers knownFollowers

The subject's followers whom you also follow.

profileAssociatedChat

Name Path Type Description
allowIncoming
 allowIncoming string

listView

Name Path Type Description
uri
 uri string
cid
 cid string
creator
 creator profileView

Basic information about a profile.
name
 name string
purpose
 purpose listPurpose

Defines the purpose of the list.
description
 description string
descriptionFacets
 descriptionFacets array of richtextFacet
avatar
 avatar string
listItemCount
 listItemCount integer
labels
 labels array of label
viewer
 viewer listViewerState
indexedAt
 indexedAt date-time

listItemView

Name Path Type Description
uri
 uri string
subject
 subject profileView

Basic information about a profile.

listViewBasic

Name Path Type Description
uri
 uri string
cid
 cid string
name
 name string
purpose
 purpose listPurpose

Defines the purpose of the list.
avatar
 avatar string
listItemCount
 listItemCount integer
labels
 labels array of label
viewer
 viewer listViewerState
indexedAt
 indexedAt string

label

Metadata tag on an atproto resource (eg, repo or record).

Name Path Type Description
ver
 ver integer
src
 src string

DID of the actor who created this label.
uri
 uri string

AT URI of the record, repo (account), or other resource that this label applies to.
cid
 cid string

Optionally, CID specifying the specific version of 'uri' resource this label applies to.
val
 val string

The short string name of the value or type of this label.
neg
 neg boolean

If true, this is a negation label, overwriting a previous label.
cts
 cts date-time

Timestamp when this label was created.
exp
 exp date-time

Timestamp at which this label expires (no longer applies).
sig
 sig byte

Signature of dag-cbor encoded label.

ActorMetadata

Name Path Type Description
messagesSent
 messagesSent integer

The number of messages sent by the actor.
messagesReceived
 messagesReceived integer

The number of messages received by the actor.
convos
 convos integer

The total number of conversations the actor has participated in.
convosStarted
 convosStarted integer

The number of conversations started by the actor.

knownFollowers

The subject's followers whom you also follow.

Name Path Type Description
count
 count integer
followers
 followers array of appProfileViewBasic

appProfileViewBasic

Name Path Type Description
did
 did string

Decentralized Identifier (DID) of the actor.
handle
 handle string

Unique handle of the actor.
displayName
 displayName string

Display name of the actor.
avatar
 avatar string

URI of the actor's avatar image.
createdAt
 createdAt date-time

The timestamp of the actor's profile creation.

chatProfileViewBasic

Name Path Type Description
did
 did string
handle
 handle string

Handle of the actor.
displayName
 displayName string

Display name of the actor.
avatar
 avatar string

URI of the actor's avatar.
associated
 associated profileAssociated
viewer
 viewer appViewerState

Metadata about the requesting account's relationship with the subject account.
labels
 labels array of label

Array of labels associated with the actor.
chatDisabled
 chatDisabled boolean

Indicates if the actor cannot actively participate in conversations.

listPurpose

Defines the purpose of the list.

Name Path Type Description
type
 type string

The type of the list purpose.
Modlist Property
 modlistProperty string

A property specific to modlist.
Curatelist Property
 curatelistProperty string

A property specific to curatelist.
Referencelist Property
 referencelistProperty string

A property specific to referencelist.

listViewerState

Name Path Type Description
muted
 muted boolean
blocked
 blocked string

convoView

Represents a view of a conversation.

Name Path Type Description
Conversation ID
 id string

The unique identifier of the conversation.
Conversation Revision
 rev string

The revision identifier of the conversation.
Conversation Members
 members array of chatProfileViewBasic

List of members in the conversation.
id
 lastMessage.id string

The unique identifier of the message.
content
 lastMessage.content string

The content of the last message.
timestamp
 lastMessage.timestamp date-time

The time when the last message was sent.
Is Conversation Muted
 muted boolean

Indicates whether the conversation is muted.
Is Conversation Opened
 opened boolean

Indicates whether the conversation has been opened.
Unread Message Count
 unreadCount integer

The count of unread messages in the conversation.

messageViewSender

Name Path Type Description
did
 did string

Decentralized Identifier of the sender.

richtextFacet

Annotation of a sub-string within rich text.

Name Path Type Description
index
 index richTextFacetByteSlice

Specifies the sub-string range a facet feature applies to.
features
 features array of object
featureType
 features.featureType string

Type of the feature.
details
 features.details object

Details about the feature.

richTextFacetByteSlice

Specifies the sub-string range a facet feature applies to.

Name Path Type Description
byteStart
 byteStart integer

The starting byte of the range.
byteEnd
 byteEnd integer

The ending byte of the range.

deletedMessageView

Name Path Type Description
id
 id string

The ID of the deleted message.
rev
 rev string

The revision ID of the deleted message.
sender
 sender messageViewSender
sentAt
 sentAt date-time

The timestamp when the message was sent.

lastMessage

Represents the last message in a conversation.

Name Path Type Description
id
 id string

The unique identifier of the message.
text
 text string

The text content of the message.
sender
 sender string

The identifier of the message sender.
sentAt
 sentAt date-time

The time at which the message was sent.

accountView

Name Path Type Description
did
 did string
handle
 handle string
email
 email string
relatedRecords
 relatedRecords array of
indexedAt
 indexedAt date-time
invitedBy
 invitedBy inviteCode
invites
 invites array of inviteCode
invitesDisabled
 invitesDisabled boolean
emailConfirmedAt
 emailConfirmedAt date-time
inviteNote
 inviteNote string
deactivatedAt
 deactivatedAt date-time
threatSignatures
 threatSignatures array of threatSignature

inviteCode

Name Path Type Description
code
 code string
available
 available integer
disabled
 disabled boolean
forAccount
 forAccount string
createdBy
 createdBy string
createdAt
 createdAt date-time
uses
 uses array of inviteCodeUse

threatSignature

Name Path Type Description
property
 property string
value
 value string

inviteCodeUse

Name Path Type Description
usedBy
 usedBy string
usedAt
 usedAt date-time

statusAttr

Name Path Type Description
applied
 applied boolean
ref
 ref string

createAppPassword

Name Path Type Description
name
 name string
password
 password string
createdAt
 createdAt date-time
privileged
 privileged boolean

listAppPassword

Name Path Type Description
name
 name string
createdAt
 createdAt string
privileged
 privileged boolean
Name Path Type Description
privacyPolicy
 privacyPolicy string
termsOfService
 termsOfService string

serviceConfig

Name Path Type Description
url
 url string

viewerConfig

Name Path Type Description
role
 role string

describeServerContact

Name Path Type Description
email
 email string

describeFeedGeneratorFeed

Name Path Type Description
uri
 uri string
Name Path Type Description
privacyPolicy
 privacyPolicy string
termsOfService
 termsOfService string

feedViewPost

Name Path Type Description
post
 post postView
reply
 reply feedReplyRef
type
 reason.type string
details
 reason.details object

Additional details specific to the reason type. Matches either reasonRepost or reasonPin.
feedContext
 feedContext string

Context provided by feed generator that may be passed back alongside interactions.

generatorView

Name Path Type Description
uri
 uri string
cid
 cid string
did
 did string
creator
 creator profileView

Basic information about a profile.
displayName
 displayName string
description
 description string
descriptionFacets
 descriptionFacets array of richtextFacet
avatar
 avatar string
likeCount
 likeCount integer
acceptsInteractions
 acceptsInteractions boolean
labels
 labels array of label
viewer
 viewer generatorViewerState
indexedAt
 indexedAt date-time

generatorViewerState

Name Path Type Description
like
 like string

threadgateView

Name Path Type Description
uri
 uri string
cid
 cid string
record
 record
lists
 lists array of listViewBasic

getLikesLike

Name Path Type Description
indexedAt
 indexedAt date-time
createdAt
 createdAt date-time
actor
 actor profileView

Basic information about a profile.

skeletonFeedPost

Name Path Type Description
post
 post string

The AT-URI of the post.
reasonRepost
 reasonRepost skeletonReasonRepost
reasonPin
 reasonPin skeletonReasonPin
feedContext
 feedContext string

Context passed through to the client and returned to the feed generator alongside interactions.

skeletonReasonRepost

Name Path Type Description
repost
 repost string

skeletonReasonPin

reasonType

Reason type for the moderation report. One of the predefined reasons.

Name Path Type Description
reasonSpam
 reasonSpam reasonSpam

Spam: frequent unwanted promotion, replies, mentions
reasonViolation
 reasonViolation reasonViolation

Direct violation of server rules, laws, terms of service
reasonMisleading
 reasonMisleading reasonMisleading

Misleading identity, affiliation, or content
reasonSexual
 reasonSexual reasonSexual

Unwanted or mislabeled sexual content
reasonRude
 reasonRude reasonRude

Rude, harassing, explicit, or otherwise unwelcoming behavior
reasonOther
 reasonOther reasonOther

Other: reports not falling under another report category
reasonAppeal
 reasonAppeal reasonAppeal

Appeal: appeal a previously taken moderation action

reasonSpam

Spam: frequent unwanted promotion, replies, mentions

Spam: frequent unwanted promotion, replies, mentions

string

reasonViolation

Direct violation of server rules, laws, terms of service

Direct violation of server rules, laws, terms of service

string

reasonMisleading

Misleading identity, affiliation, or content

Misleading identity, affiliation, or content

string

reasonSexual

Unwanted or mislabeled sexual content

Unwanted or mislabeled sexual content

string

reasonRude

Rude, harassing, explicit, or otherwise unwelcoming behavior

Rude, harassing, explicit, or otherwise unwelcoming behavior

string

reasonOther

Other: reports not falling under another report category

Other: reports not falling under another report category

string

reasonAppeal

Appeal: appeal a previously taken moderation action

Appeal: appeal a previously taken moderation action

string

repoRef

Name Path Type Description
did
 did string

repoBlobRef

Name Path Type Description
did
 did string
cid
 cid string
recordUri
 recordUri string

notification

Name Path Type Description
uri
 uri string
cid
 cid string
author
 author profileView

Basic information about a profile.
reason
 reason string

Expected values are 'like', 'repost', 'follow', 'mention', 'reply', 'quote', and 'starterpack-joined'.
reasonSubject
 reasonSubject string
record
 record
isRead
 isRead boolean
indexedAt
 indexedAt date-time
labels
 labels array of label

labelerView

Name Path Type Description
uri
 uri string
cid
 cid string
creator
 creator profileView

Basic information about a profile.
likeCount
 likeCount integer
viewer
 viewer labelerViewerState
indexedAt
 indexedAt date-time
labels
 labels array of label

labelerViewerState

Name Path Type Description
like
 like string

jobStatus

Name Path Type Description
jobId
 jobId string
did
 did string
state
 state string

The state of the video processing job.
progress
 progress integer
blob
 blob binary
error
 error string
message
 message string

templateView

Name Path Type Description
id
 id string
name
 name string

Name of the template.
subject
 subject string

Content of the template, can contain markdown and variable placeholders.
contentMarkdown
 contentMarkdown string

Subject of the message, used in emails.
disabled
 disabled boolean
lang
 lang string

Message language.
lastUpdatedBy
 lastUpdatedBy string

DID of the user who last updated the template.
createdAt
 createdAt date-time
updatedAt
 updatedAt date-time

repoView

Name Path Type Description
did
 did string
handle
 handle string
email
 email string
relatedRecords
 relatedRecords array of
indexedAt
 indexedAt date-time
moderation
 moderation moderation
invitedBy
 invitedBy inviteCode
invitesDisabled
 invitesDisabled boolean
inviteNote
 inviteNote string
deactivatedAt
 deactivatedAt date-time
threatSignatures
 threatSignatures array of threatSignature

moderation

Name Path Type Description
subjectStatus
 subjectStatus subjectStatusView

subjectStatusView

Name Path Type Description
id
 id integer

The unique identifier of the subject status.
type
 subject.type string

The type of subject reference.
repoRef
 subject.repoRef repoRef
strongRef
 subject.strongRef strongRef

Defines a strong reference with a URI and CID.
type
 hosting.type string

The type of hosting.
status
 hosting.accountHosting.status string
updatedAt
 hosting.accountHosting.updatedAt date-time
createdAt
 hosting.accountHosting.createdAt date-time
status
 hosting.recordHosting.status string
updatedAt
 hosting.recordHosting.updatedAt date-time
createdAt
 hosting.recordHosting.createdAt date-time
createdAt
 createdAt date-time

Timestamp of when the subject status was created.
updatedAt
 updatedAt date-time

Timestamp of when the subject status was last updated.
reviewState
 reviewState string

The review state of the subject.

modEventView

Name Path Type Description
id
 id integer
type
 event.type string
type
 subject.type string
subjectBlobCids
 subjectBlobCids array of string
createdBy
 createdBy string
createdAt
 createdAt date-time
creatorHandle
 creatorHandle string
subjectHandle
 subjectHandle string

applyWrites.result

Name Path Type Description
type
 type string

Type of result for the write operation.
createResult
 createResult applyWrites.createResult
updateResult
 updateResult applyWrites.updateResult
Delete operation result
 deleteResult applyWrites.deleteResult

applyWrites.createResult

Name Path Type Description
uri
 uri string
cid
 cid string
validationStatus
 validationStatus string

applyWrites.updateResult

Name Path Type Description
uri
 uri string
cid
 cid string
validationStatus
 validationStatus string

applyWrites.deleteResult

Name Path Type Description
id
 id string

Identifier of the deleted entity.
deletedAt
 deletedAt date-time

Timestamp of when the entity was deleted.

commitMeta

Name Path Type Description
cid
 cid string
rev
 rev string

modEventViewDetail

Name Path Type Description
id
 id integer

The unique identifier for the moderation event.
type
 event.type string

The type of event.
type
 subject.type string

The type of subject.
subjectBlobs
 subjectBlobs array of blobView

Details about the blobs associated with the subject.
createdBy
 createdBy string

The DID of the user who created the event.
createdAt
 createdAt date-time

The timestamp when the event was created.

blobView

Name Path Type Description
cid
 cid string

Content identifier for the blob.
mimeType
 mimeType string

MIME type of the blob.
size
 size integer

Size of the blob in bytes.
createdAt
 createdAt date-time

Timestamp when the blob was created.
type
 details.type string

Type of blob details.
imageDetails
 details.imageDetails imageDetails
videoDetails
 details.videoDetails videoDetails
moderation
 moderation moderation

imageDetails

Name Path Type Description
width
 width integer

Width of the image in pixels.
height
 height integer

Height of the image in pixels.

videoDetails

Name Path Type Description
width
 width integer

Width of the video in pixels.
height
 height integer

Height of the video in pixels.
length
 length integer

Length of the video in seconds.

recordViewDetail

Name Path Type Description
uri
 uri string
cid
 cid string
value
 value
blobs
 blobs array of blobView
labels
 labels array of label
indexedAt
 indexedAt date-time
moderation
 moderation moderationDetail
repo
 repo repoView

moderationDetail

Name Path Type Description
subjectStatus
 subjectStatus subjectStatusView

repoViewDetail

Name Path Type Description
did
 did string
handle
 handle string
email
 email string
relatedRecords
 relatedRecords array of
indexedAt
 indexedAt date-time
moderation
 moderation moderationDetail
labels
 labels array of label
invitedBy
 invitedBy inviteCode
invites
 invites array of inviteCode
invitesDisabled
 invitesDisabled boolean
inviteNote
 inviteNote string
emailConfirmedAt
 emailConfirmedAt date-time
deactivatedAt
 deactivatedAt date-time
threatSignatures
 threatSignatures array of threatSignature

member

Name Path Type Description
did
 did string
disabled
 disabled boolean
profile
 profile profileViewDetailed
createdAt
 createdAt date-time
updatedAt
 updatedAt date-time
lastUpdatedBy
 lastUpdatedBy string
role
 role string

listMissingBlobs.recordBlob

Name Path Type Description
cid
 cid string
recordUri
 recordUri string

listRecords.record

Name Path Type Description
uri
 uri string
cid
 cid string
value
 value

listRepos.repo

Name Path Type Description
did
 did string
head
 head string

Current repo commit CID
rev
 rev string
active
 active boolean
status
 status string

True or false value indicating why account is inactive..

setView

Name Path Type Description
name
 name string
description
 description string
setSize
 setSize integer
createdAt
 createdAt date-time
updatedAt
 updatedAt date-time

sigDetail

Name Path Type Description
property
 property string
value
 value string

findRelatedAccounts.relatedAccount

Name Path Type Description
account
 account accountView
similarities
 similarities array of sigDetail

binary

This is the basic data type 'binary'.

file

This is the basic data type 'file'.