Skip to content

Methods

Every method the server serves: each lexicon in spec/lexicons that defines one, as PDS.md says. Each is an XRPC method, an MCP tool and a pds command at once, named as COMMANDS.md says; a method with no tool answers or takes something other than JSON. This page is made from the lexicons, and the page linked under each method says what it does.

Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.

XRPC
GET /xrpc/app.bsky.actor.getPreferences
CLI
pds actor get-preferences
MCP
actor_get_preferences
Specified in
Proxying, service auth and preferences · lexicon

Output

NameTypeDescription
preferencesapp.bsky.actor.defs#preferences

Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.

XRPC
GET /xrpc/app.bsky.actor.getProfile
CLI
pds actor get-profile
MCP
actor_get_profile
Output
app.bsky.actor.defs#profileViewDetailed
Specified in
Proxying, service auth and preferences · lexicon

Parameters

NameTypeDescription
actorstring (at-identifier)Handle or DID of account to fetch profile of.

Get detailed profile views of multiple actors.

XRPC
GET /xrpc/app.bsky.actor.getProfiles
CLI
pds actor get-profiles
MCP
actor_get_profiles
Specified in
Proxying, service auth and preferences · lexicon

Parameters

NameTypeDescription
actorsarray of string (at-identifier), at most 25

Output

NameTypeDescription
profilesarray of app.bsky.actor.defs#profileViewDetailed

Set the private preferences attached to the account.

XRPC
POST /xrpc/app.bsky.actor.putPreferences
CLI
pds actor put-preferences
MCP
actor_put_preferences
Specified in
Proxying, service auth and preferences · lexicon

Input

NameTypeDescription
preferencesapp.bsky.actor.defs#preferences

Get a list of posts liked by an actor. Requires auth, actor must be the requesting account.

XRPC
GET /xrpc/app.bsky.feed.getActorLikes
CLI
pds feed get-actor-likes
MCP
feed_get_actor_likes
Errors
BlockedActor BlockedByActor
Specified in
Proxying, service auth and preferences · lexicon

Parameters

NameTypeDescription
actorstring (at-identifier)
limitinteger, 1 to 100, default 50, optional
cursorstring, optional

Output

NameTypeDescription
cursorstring, optional
feedarray of app.bsky.feed.defs#feedViewPost

Get a view of an actor’s ‘author feed’ (post and reposts by the author). Does not require auth.

XRPC
GET /xrpc/app.bsky.feed.getAuthorFeed
CLI
pds feed get-author-feed
MCP
feed_get_author_feed
Errors
BlockedActor BlockedByActor
Specified in
Proxying, service auth and preferences · lexicon

Parameters

NameTypeDescription
actorstring (at-identifier)
limitinteger, 1 to 100, default 50, optional
cursorstring, optional
filterstring, posts_with_replies, posts_no_replies, posts_with_media, posts_and_author_threads, posts_with_video, default "posts_with_replies", optionalCombinations of post/repost types to include in response.
includePinsboolean, default false, optional

Output

NameTypeDescription
cursorstring, optional
feedarray of app.bsky.feed.defs#feedViewPost

Get a hydrated feed from an actor’s selected feed generator. Implemented by App View.

XRPC
GET /xrpc/app.bsky.feed.getFeed
CLI
pds feed get-feed
MCP
feed_get_feed
Errors
UnknownFeed
Specified in
Proxying, service auth and preferences · lexicon

Parameters

NameTypeDescription
feedstring (at-uri)
limitinteger, 1 to 100, default 50, optional
cursorstring, optional

Output

NameTypeDescription
cursorstring, optional
feedarray of app.bsky.feed.defs#feedViewPost

Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.

XRPC
GET /xrpc/app.bsky.feed.getPostThread
CLI
pds feed get-post-thread
MCP
feed_get_post_thread
Errors
NotFound
Specified in
Proxying, service auth and preferences · lexicon

Parameters

NameTypeDescription
uristring (at-uri)Reference (AT-URI) to post record.
depthinteger, 0 to 1000, default 6, optionalHow many levels of reply depth should be included in response.
parentHeightinteger, 0 to 1000, default 80, optionalHow many levels of parent (and grandparent, etc) post to include.

Output

NameTypeDescription
threadone of app.bsky.feed.defs#threadViewPost, app.bsky.feed.defs#notFoundPost, app.bsky.feed.defs#blockedPost
threadgateapp.bsky.feed.defs#threadgateView, optional

Get a view of the requesting account’s home timeline. This is expected to be some form of reverse-chronological feed.

XRPC
GET /xrpc/app.bsky.feed.getTimeline
CLI
pds feed get-timeline
MCP
feed_get_timeline
Specified in
Proxying, service auth and preferences · lexicon

Parameters

NameTypeDescription
algorithmstring, optionalVariant ‘algorithm’ for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism.
limitinteger, 1 to 100, default 50, optional
cursorstring, optional
sincestring, optionalReturn only items newer than the position identified by this cursor value, newest first. Use the startCursor from a previous response. The item at that position is not returned because the caller already holds it. When the bounded range is exhausted, the returned cursor equals this value so that pagination continues below the boundary.

Output

NameTypeDescription
cursorstring, optional
startCursorstring, optionalCursor identifying the newest item in this page. Pass it as since on a later request to fetch only newer content.
feedarray of app.bsky.feed.defs#feedViewPost

Register to receive push notifications, via a specified service, for the requesting account. Requires auth.

XRPC
POST /xrpc/app.bsky.notification.registerPush
CLI
pds notification register-push
MCP
notification_register_push
Specified in
Proxying, service auth and preferences · lexicon

Input

NameTypeDescription
serviceDidstring (did)
tokenstring
platformstring, ios, android, web
appIdstring
ageRestrictedboolean, optionalSet to true when the actor is age restricted

The inverse of registerPush - inform a specified service that push notifications should no longer be sent to the given token for the requesting account. Requires auth.

XRPC
POST /xrpc/app.bsky.notification.unregisterPush
CLI
pds notification unregister-push
MCP
notification_unregister_push
Specified in
Proxying, service auth and preferences · lexicon

Input

NameTypeDescription
serviceDidstring (did)
tokenstring
platformstring, ios, android, web
appIdstring

Get the service-specific admin status of a subject (account, record, or blob).

XRPC
GET /xrpc/com.atproto.admin.getSubjectStatus
CLI
pds admin get-subject-status
MCP
admin_get_subject_status
Specified in
Account lifecycle · lexicon

Parameters

NameTypeDescription
didstring (did), optional
uristring (at-uri), optional
blobstring (cid), optional

Output

NameTypeDescription
subjectone of com.atproto.admin.defs#repoRef, com.atproto.repo.strongRef, com.atproto.admin.defs#repoBlobRef
takedowncom.atproto.admin.defs#statusAttr, optional
deactivatedcom.atproto.admin.defs#statusAttr, optional

Update the service-specific admin status of a subject (account, record, or blob).

XRPC
POST /xrpc/com.atproto.admin.updateSubjectStatus
CLI
pds admin update-subject-status
MCP
admin_update_subject_status
Specified in
Account lifecycle · lexicon

Input

NameTypeDescription
subjectone of com.atproto.admin.defs#repoRef, com.atproto.repo.strongRef, com.atproto.admin.defs#repoBlobRef
takedowncom.atproto.admin.defs#statusAttr, optional
deactivatedcom.atproto.admin.defs#statusAttr, optional

Output

NameTypeDescription
subjectone of com.atproto.admin.defs#repoRef, com.atproto.repo.strongRef, com.atproto.admin.defs#repoBlobRef
takedowncom.atproto.admin.defs#statusAttr, optional

com.atproto.identity.getRecommendedDidCredentials

Section titled “com.atproto.identity.getRecommendedDidCredentials”

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

XRPC
GET /xrpc/com.atproto.identity.getRecommendedDidCredentials
CLI
pds identity get-recommended-did-credentials
MCP
identity_get_recommended_did_credentials
Specified in
Identity · lexicon

Output

NameTypeDescription
rotationKeysarray of string, optionalRecommended rotation keys for PLC dids. Should be undefined (or ignored) for did:webs.
alsoKnownAsarray of string, optional
verificationMethodsunknown, optional
servicesunknown, optional

com.atproto.identity.requestPlcOperationSignature

Section titled “com.atproto.identity.requestPlcOperationSignature”

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

XRPC
POST /xrpc/com.atproto.identity.requestPlcOperationSignature
CLI
pds identity request-plc-operation-signature
MCP
identity_request_plc_operation_signature
Specified in
Moving an account between servers · lexicon

Resolves an atproto handle (hostname) to a DID. Does not necessarily bi-directionally verify against the the DID document.

XRPC
GET /xrpc/com.atproto.identity.resolveHandle
CLI
pds identity resolve-handle
MCP
identity_resolve_handle
Errors
HandleNotFound
Specified in
Identity · lexicon

Parameters

NameTypeDescription
handlestring (handle)The handle to resolve.

Output

NameTypeDescription
didstring (did)

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

XRPC
POST /xrpc/com.atproto.identity.signPlcOperation
CLI
pds identity sign-plc-operation
MCP
identity_sign_plc_operation
Specified in
Moving an account between servers · lexicon

Input

NameTypeDescription
tokenstring, optionalA token received through com.atproto.identity.requestPlcOperationSignature
rotationKeysarray of string, optional
alsoKnownAsarray of string, optional
verificationMethodsunknown, optional
servicesunknown, optional

Output

NameTypeDescription
operationunknownA signed DID PLC operation.

Validates a PLC operation to ensure that it doesn’t violate a service’s constraints or get the identity into a bad state, then submits it to the PLC registry

XRPC
POST /xrpc/com.atproto.identity.submitPlcOperation
CLI
pds identity submit-plc-operation
MCP
identity_submit_plc_operation
Specified in
Moving an account between servers · lexicon

Input

NameTypeDescription
operationunknown

Updates the current account’s handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.

XRPC
POST /xrpc/com.atproto.identity.updateHandle
CLI
pds identity update-handle
MCP
identity_update_handle
Specified in
Identity · lexicon

Input

NameTypeDescription
handlestring (handle)The new handle.

List the members of a space with a memberspace policy. Requires auth as the space authority, implemented by PDS.

XRPC
GET /xrpc/com.atproto.memberspace.listMembers
CLI
pds memberspace list-members
MCP
memberspace_list_members
Errors
SpaceNotFound NotAuthorized PolicyMismatch InvalidCursor
Specified in
Spaces: policies and the space lifecycle · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)
limitinteger, 1 to 1000, default 100, optional
cursorstring, optional

Output

NameTypeDescription
cursorstring, optional
membersarray of com.atproto.memberspace.defs#member

Add members to a space, or update existing members’ access, in a single commit. Requires auth as the space authority, implemented by PDS.

XRPC
POST /xrpc/com.atproto.memberspace.putMembers
CLI
pds memberspace put-members
MCP
memberspace_put_members
Errors
SpaceNotFound NotAuthorized PolicyMismatch
Specified in
Spaces: policies and the space lifecycle · lexicon

Input

NameTypeDescription
spacestring (space-ref)
membersarray of com.atproto.memberspace.defs#member, at most 100

Remove members from a space in a single commit. DIDs that are not members are ignored. Requires auth as the space authority, implemented by PDS.

XRPC
POST /xrpc/com.atproto.memberspace.removeMembers
CLI
pds memberspace remove-members
MCP
memberspace_remove_members
Errors
SpaceNotFound NotAuthorized PolicyMismatch
Specified in
Spaces: policies and the space lifecycle · lexicon

Input

NameTypeDescription
spacestring (space-ref)
didsarray of string (did), at most 100

Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.repo.applyWrites
CLI
pds repo apply-writes
MCP
repo_apply_writes
Errors
InvalidSwap
Specified in
The repository's records · lexicon

Input

NameTypeDescription
repostring (at-identifier)The handle or DID of the repo (aka, current account).
validateboolean, optionalCan be set to ‘false’ to skip Lexicon schema validation of record data across all operations, ‘true’ to require it, or leave unset to validate only for known Lexicons.
writesarray of one of create, update, delete
swapCommitstring (cid), optionalIf provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations.

Output

NameTypeDescription
commitcom.atproto.repo.defs#commitMeta, optional
resultsarray of one of createResult, updateResult, deleteResult, optional

Create a single new repository record. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.repo.createRecord
CLI
pds repo create-record
MCP
repo_create_record
Errors
InvalidSwap
Specified in
The repository's records · lexicon

Input

NameTypeDescription
repostring (at-identifier)The handle or DID of the repo (aka, current account).
collectionstring (nsid)The NSID of the record collection.
rkeystring (record-key), at most 512 bytes, optionalThe Record Key.
validateboolean, optionalCan be set to ‘false’ to skip Lexicon schema validation of record data, ‘true’ to require it, or leave unset to validate only for known Lexicons.
recordunknownThe record itself. Must contain a $type field.
swapCommitstring (cid), optionalCompare and swap with the previous commit by CID.

Output

NameTypeDescription
uristring (at-uri)
cidstring (cid)
commitcom.atproto.repo.defs#commitMeta, optional
validationStatusstring, valid, unknown, optional

Delete a repository record, or ensure it doesn’t exist. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.repo.deleteRecord
CLI
pds repo delete-record
MCP
repo_delete_record
Errors
InvalidSwap
Specified in
The repository's records · lexicon

Input

NameTypeDescription
repostring (at-identifier)The handle or DID of the repo (aka, current account).
collectionstring (nsid)The NSID of the record collection.
rkeystring (record-key)The Record Key.
swapRecordstring (cid), optionalCompare and swap with the previous record by CID.
swapCommitstring (cid), optionalCompare and swap with the previous commit by CID.

Output

NameTypeDescription
commitcom.atproto.repo.defs#commitMeta, optional

Get information about an account and repository, including the list of collections. Does not require auth.

XRPC
GET /xrpc/com.atproto.repo.describeRepo
CLI
pds repo describe-repo
MCP
repo_describe_repo
Specified in
The repository's records · lexicon

Parameters

NameTypeDescription
repostring (at-identifier)The handle or DID of the repo.

Output

NameTypeDescription
handlestring (handle)
didstring (did)
didDocunknownThe complete DID document for this account.
collectionsarray of string (nsid)List of all the collections (NSIDs) for which this repo contains at least one record.
handleIsCorrectbooleanIndicates if handle is currently valid (resolves bi-directionally)

Get a single record from a repository. Does not require auth.

XRPC
GET /xrpc/com.atproto.repo.getRecord
CLI
pds repo get-record
MCP
repo_get_record
Errors
RecordNotFound
Specified in
The repository's records · lexicon

Parameters

NameTypeDescription
repostring (at-identifier)The handle or DID of the repo.
collectionstring (nsid)The NSID of the record collection.
rkeystring (record-key)The Record Key.
cidstring (cid), optionalThe CID of the version of the record. If not specified, then return the most recent version.

Output

NameTypeDescription
uristring (at-uri)
cidstring (cid), optional
valueunknown

Import a repo in the form of a CAR file. Requires Content-Length HTTP header to be set.

XRPC
POST /xrpc/com.atproto.repo.importRepo
CLI
pds repo import-repo
MCP
none
Input
application/vnd.ipld.car
Specified in
Moving an account between servers · lexicon

Returns a list of missing blobs for the requesting account. Intended to be used in the account migration flow.

XRPC
GET /xrpc/com.atproto.repo.listMissingBlobs
CLI
pds repo list-missing-blobs
MCP
repo_list_missing_blobs
Specified in
Moving an account between servers · lexicon

Parameters

NameTypeDescription
limitinteger, 1 to 1000, default 500, optional
cursorstring, optional

Output

NameTypeDescription
cursorstring, optional
blobsarray of recordBlob

List a range of records in a repository, matching a specific collection. Does not require auth.

XRPC
GET /xrpc/com.atproto.repo.listRecords
CLI
pds repo list-records
MCP
repo_list_records
Specified in
The repository's records · lexicon

Parameters

NameTypeDescription
repostring (at-identifier)The handle or DID of the repo.
collectionstring (nsid)The NSID of the record type.
limitinteger, 1 to 100, default 50, optionalThe number of records to return.
cursorstring, optional
reverseboolean, optionalFlag to reverse the order of the returned records.

Output

NameTypeDescription
cursorstring, optional
recordsarray of record

Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.repo.putRecord
CLI
pds repo put-record
MCP
repo_put_record
Errors
InvalidSwap
Specified in
The repository's records · lexicon

Input

NameTypeDescription
repostring (at-identifier)The handle or DID of the repo (aka, current account).
collectionstring (nsid)The NSID of the record collection.
rkeystring (record-key), at most 512 bytesThe Record Key.
validateboolean, optionalCan be set to ‘false’ to skip Lexicon schema validation of record data, ‘true’ to require it, or leave unset to validate only for known Lexicons.
recordunknownThe record to write.
swapRecordstring (cid), optionalCompare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation
swapCommitstring (cid), optionalCompare and swap with the previous commit by CID.

Output

NameTypeDescription
uristring (at-uri)
cidstring (cid)
commitcom.atproto.repo.defs#commitMeta, optional
validationStatusstring, valid, unknown, optional

Upload a new blob, to be referenced from a repository record. The blob will be deleted if it is not referenced within a time window (eg, minutes). Blob restrictions (mimetype, size, etc) are enforced when the reference is created. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.repo.uploadBlob
CLI
pds repo upload-blob
MCP
none
Input
*/*
Specified in
Blobs · lexicon

Output

NameTypeDescription
blobblob

Activates a currently deactivated account. Used to finalize account migration after the account’s repo is imported and identity is setup.

XRPC
POST /xrpc/com.atproto.server.activateAccount
CLI
pds server activate-account
MCP
server_activate_account
Specified in
Account lifecycle · lexicon

Returns the status of an account, especially as pertaining to import or recovery. Can be called many times over the course of an account migration. Requires auth and can only be called pertaining to oneself.

XRPC
GET /xrpc/com.atproto.server.checkAccountStatus
CLI
pds server check-account-status
MCP
server_check_account_status
Specified in
Account lifecycle · lexicon

Output

NameTypeDescription
activatedboolean
validDidboolean
repoCommitstring (cid)
repoRevstring
repoBlocksinteger
indexedRecordsinteger
privateStateValuesinteger
expectedBlobsinteger
importedBlobsinteger

Confirm an email using a token from com.atproto.server.requestEmailConfirmation.

XRPC
POST /xrpc/com.atproto.server.confirmEmail
CLI
pds server confirm-email
MCP
server_confirm_email
Errors
AccountNotFound ExpiredToken InvalidToken InvalidEmail
Specified in
Email · lexicon

Input

NameTypeDescription
emailstring
tokenstring

Create an account. Implemented by PDS.

XRPC
POST /xrpc/com.atproto.server.createAccount
CLI
pds server create-account
MCP
server_create_account
Errors
InvalidHandle InvalidPassword InvalidInviteCode HandleNotAvailable UnsupportedDomain UnresolvableDid IncompatibleDidDoc
Specified in
Accounts · lexicon

Input

NameTypeDescription
emailstring, optional
handlestring (handle)Requested handle for the account.
didstring (did), optionalPre-existing atproto DID, being imported to a new account.
inviteCodestring, optional
verificationCodestring, optional
verificationPhonestring, optional
passwordstring, optionalInitial account password. May need to meet instance-specific password strength requirements.
recoveryKeystring, optionalDID PLC rotation key (aka, recovery key) to be included in PLC creation operation.
plcOpunknown, optionalA signed DID PLC operation to be submitted as part of importing an existing account to this instance. NOTE: this optional field may be updated when full account migration is implemented.

Output

NameTypeDescription
accessJwtstring
refreshJwtstring
handlestring (handle)
didstring (did)The DID of the new account.
didDocunknown, optionalComplete DID document.

Create an App Password.

XRPC
POST /xrpc/com.atproto.server.createAppPassword
CLI
pds server create-app-password
MCP
server_create_app_password
Output
appPassword
Errors
AccountTakedown
Specified in
Sessions · lexicon

Input

NameTypeDescription
namestringA short name for the App Password, to help distinguish them.
privilegedboolean, optionalIf an app password has ‘privileged’ access to possibly sensitive account state. Meant for use with trusted clients.

Create an invite code.

XRPC
POST /xrpc/com.atproto.server.createInviteCode
CLI
pds server create-invite-code
MCP
server_create_invite_code
Specified in
Limits · lexicon

Input

NameTypeDescription
useCountinteger
forAccountstring (did), optional

Output

NameTypeDescription
codestring

Create invite codes.

XRPC
POST /xrpc/com.atproto.server.createInviteCodes
CLI
pds server create-invite-codes
MCP
server_create_invite_codes
Specified in
Limits · lexicon

Input

NameTypeDescription
codeCountinteger, default 1
useCountinteger
forAccountsarray of string (did), optional

Output

NameTypeDescription
codesarray of accountCodes

Create an authentication session.

XRPC
POST /xrpc/com.atproto.server.createSession
CLI
pds server create-session
MCP
server_create_session
Errors
AccountTakedown AuthFactorTokenRequired
Specified in
Accounts · lexicon

Input

NameTypeDescription
identifierstringHandle or other identifier supported by the server for the authenticating user.
passwordstring
authFactorTokenstring, optional
allowTakendownboolean, optionalWhen true, instead of throwing error for takendown accounts, a valid response with a narrow scoped token will be returned

Output

NameTypeDescription
accessJwtstring
refreshJwtstring
handlestring (handle)
didstring (did)
didDocunknown, optional
emailstring, optional
emailConfirmedboolean, optional
emailAuthFactorboolean, optional
activeboolean, optional
statusstring, takendown, suspended, deactivated, optionalIf active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.

Deactivates a currently active account. Stops serving of repo, and future writes to repo until reactivated. Used to finalize account migration with the old host after the account has been activated on the new host.

XRPC
POST /xrpc/com.atproto.server.deactivateAccount
CLI
pds server deactivate-account
MCP
server_deactivate_account
Specified in
Account lifecycle · lexicon

Input

NameTypeDescription
deleteAfterstring (datetime), optionalA recommendation to server as to how long they should hold onto the deactivated account before deleting.

Delete an actor’s account with a token and password. Can only be called after requesting a deletion token. Requires auth.

XRPC
POST /xrpc/com.atproto.server.deleteAccount
CLI
pds server delete-account
MCP
server_delete_account
Errors
ExpiredToken InvalidToken
Specified in
Account lifecycle · lexicon

Input

NameTypeDescription
didstring (did)
passwordstring
tokenstring

Delete the current session. Requires auth using the ‘refreshJwt’ (not the ‘accessJwt’).

XRPC
POST /xrpc/com.atproto.server.deleteSession
CLI
pds server delete-session
MCP
server_delete_session
Errors
InvalidToken ExpiredToken
Specified in
Sessions · lexicon

Describes the server’s account creation requirements and capabilities. Implemented by PDS.

XRPC
GET /xrpc/com.atproto.server.describeServer
CLI
pds server describe-server
MCP
server_describe_server
Specified in
Accounts · lexicon

Output

NameTypeDescription
inviteCodeRequiredboolean, optionalIf true, an invite code must be supplied to create an account on this instance.
phoneVerificationRequiredboolean, optionalIf true, a phone verification token must be supplied to create an account on this instance.
blobUploadLimitinteger, optionalMaximum size of a blob that can be uploaded via com.atproto.repo.uploadBlob, in bytes.
availableUserDomainsarray of stringList of domain suffixes that can be used in account handles.
linkslinks, optionalURLs of service policy documents.
contactcontact, optionalContact information
didstring (did)

Get all invite codes for the current account. Requires auth.

XRPC
GET /xrpc/com.atproto.server.getAccountInviteCodes
CLI
pds server get-account-invite-codes
MCP
server_get_account_invite_codes
Errors
DuplicateCreate
Specified in
Limits · lexicon

Parameters

NameTypeDescription
includeUsedboolean, default true, optional
createAvailableboolean, default true, optionalControls whether any new ‘earned’ but not ‘created’ invites should be created.

Output

NameTypeDescription
codesarray of com.atproto.server.defs#inviteCode

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

XRPC
GET /xrpc/com.atproto.server.getServiceAuth
CLI
pds server get-service-auth
MCP
server_get_service_auth
Errors
BadExpiration
Specified in
Proxying, service auth and preferences · lexicon

Parameters

NameTypeDescription
audstring, at most 2048 bytesThe DID or did#serviceId reference of the service that the token will be used to authenticate with.
expinteger, optionalThe time in Unix Epoch seconds that the JWT expires. Defaults to 60 seconds in the future. The service may enforce certain time bounds on tokens depending on the requested scope.
lxmstring (nsid), optionalLexicon (XRPC) method to bind the requested token to

Output

NameTypeDescription
tokenstring

Get information about the current auth session. Requires auth.

XRPC
GET /xrpc/com.atproto.server.getSession
CLI
pds server get-session
MCP
server_get_session
Specified in
Accounts · lexicon

Output

NameTypeDescription
handlestring (handle)
didstring (did)
didDocunknown, optional
emailstring, optional
emailConfirmedboolean, optional
emailAuthFactorboolean, optional
activeboolean, optional
statusstring, takendown, suspended, deactivated, optionalIf active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.

List all App Passwords.

XRPC
GET /xrpc/com.atproto.server.listAppPasswords
CLI
pds server list-app-passwords
MCP
server_list_app_passwords
Errors
AccountTakedown
Specified in
Sessions · lexicon

Output

NameTypeDescription
passwordsarray of appPassword

Refresh an authentication session. Requires auth using the ‘refreshJwt’ (not the ‘accessJwt’).

XRPC
POST /xrpc/com.atproto.server.refreshSession
CLI
pds server refresh-session
MCP
server_refresh_session
Errors
AccountTakedown InvalidToken ExpiredToken
Specified in
Sessions · lexicon

Output

NameTypeDescription
accessJwtstring
refreshJwtstring
handlestring (handle)
didstring (did)
didDocunknown, optional
emailstring, optional
emailConfirmedboolean, optional
emailAuthFactorboolean, optional
activeboolean, optional
statusstring, takendown, suspended, deactivated, optionalHosting status of the account. If not specified, then assume ‘active’.

Initiate a user account deletion via email.

XRPC
POST /xrpc/com.atproto.server.requestAccountDelete
CLI
pds server request-account-delete
MCP
server_request_account_delete
Specified in
Account lifecycle · lexicon

com.atproto.server.requestEmailConfirmation

Section titled “com.atproto.server.requestEmailConfirmation”

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

XRPC
POST /xrpc/com.atproto.server.requestEmailConfirmation
CLI
pds server request-email-confirmation
MCP
server_request_email_confirmation
Specified in
Email · lexicon

Request a token in order to update email.

XRPC
POST /xrpc/com.atproto.server.requestEmailUpdate
CLI
pds server request-email-update
MCP
server_request_email_update
Specified in
Email · lexicon

Output

NameTypeDescription
tokenRequiredboolean

Initiate a user account password reset via email.

XRPC
POST /xrpc/com.atproto.server.requestPasswordReset
CLI
pds server request-password-reset
MCP
server_request_password_reset
Specified in
Email · lexicon

Input

NameTypeDescription
emailstring

Reset a user account password using a token.

XRPC
POST /xrpc/com.atproto.server.resetPassword
CLI
pds server reset-password
MCP
server_reset_password
Errors
ExpiredToken InvalidToken
Specified in
Email · lexicon

Input

NameTypeDescription
tokenstring
passwordstring

Revoke an App Password by name.

XRPC
POST /xrpc/com.atproto.server.revokeAppPassword
CLI
pds server revoke-app-password
MCP
server_revoke_app_password
Specified in
Sessions · lexicon

Input

NameTypeDescription
namestring

Update an account’s email.

XRPC
POST /xrpc/com.atproto.server.updateEmail
CLI
pds server update-email
MCP
server_update_email
Errors
ExpiredToken InvalidToken TokenRequired
Specified in
Email · lexicon

Input

NameTypeDescription
emailstring
emailAuthFactorboolean, optional
tokenstring, optionalRequires a token from com.atproto.sever.requestEmailUpdate if the account’s email has been confirmed.

Apply a batch transaction of creates, updates, and deletes to a space repo. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.applyWrites
CLI
pds space apply-writes
MCP
space_apply_writes
Errors
SpaceNotFound RecordNotFound RecordAlreadyExists
Specified in
The space repo · lexicon

Input

NameTypeDescription
spacestring (space-ref)
repostring (did)
validateboolean, optionalCan be set to ‘false’ to skip Lexicon schema validation of record data across all operations, ‘true’ to require it, or leave unset to validate only for known Lexicons.
writesarray of one of create, update, delete

Output

NameTypeDescription
resultsarray of one of createResult, updateResult, deleteResult, optional

Authorize syncing a space, returning a new credential for reading data across it and the space’s current revision, and optionally registering for notifications of updates to it. Depending on the space’s policy, a delegation token and/or client attestation may be required. Implemented by the space host.

XRPC
POST /xrpc/com.atproto.space.authorizeSpaceSync
CLI
pds space authorize-space-sync
MCP
space_authorize_space_sync
Errors
SpaceNotFound SpaceDeleted AccountNotAuthorized AppNotAuthorized NotAuthorized InvalidDelegationToken InvalidClientAttestation RegistrationNotConfirmed RepoTakendown RepoDeactivated
Specified in
Spaces: credentials · lexicon

Input

NameTypeDescription
spacestring (space-ref)
credentialKeystringP-256 did:key that the credential is bound to.
delegationTokenstring, optionalObtained from getDelegationToken.
clientAttestationstring, optional
notifynotify, optionalRegister an endpoint to be notified of updates to the space via notifySpaceUpdate. The registration stays active while this credential is valid. After it expires, the endpoint receives only a prompt to reauthorize, or notice of the space’s deletion.

Output

NameTypeDescription
credentialstring
spaceRevstring (tid), optionalThe space’s current revision. Omitted before the space’s first update.

Delete all records in the authenticated account’s space repo. In the space authority’s repo, records published from the space’s configuration (such as its policy) are kept. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.clearRecords
CLI
pds space clear-records
MCP
space_clear_records
Specified in
The space repo · lexicon

Input

NameTypeDescription
spacestring (space-ref)
repostring (did)

Create a single new record in a space repo. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.createRecord
CLI
pds space create-record
MCP
space_create_record
Errors
SpaceNotFound RecordAlreadyExists
Specified in
The space repo · lexicon

Input

NameTypeDescription
spacestring (space-ref)
repostring (did)
collectionstring (nsid)
rkeystring (record-key), optional
validateboolean, optionalCan be set to ‘false’ to skip Lexicon schema validation of record data, ‘true’ to require it, or leave unset to validate only for known Lexicons.
recordunknownThe record itself. Must contain a $type field.

Output

NameTypeDescription
uristring (at-uri)
cidstring (cid)
validationStatusstring, valid, unknown, optional

Create a new space, with the authenticated account as its authority. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.createSpace
CLI
pds space create-space
MCP
space_create_space
Errors
SpaceAlreadyExists UnsupportedPolicy
Specified in
Spaces: policies and the space lifecycle · lexicon

Input

NameTypeDescription
spaceTypestring (nsid)
skeystring (record-key), optionalSpace key. Generated as a TID if not provided.
policyone of com.atproto.personalspace.policy, com.atproto.memberspace.policy, com.atproto.managedspace.policyPDSes must support all of the listed policies. Other space hosts may support only some of them, and any host may support policies beyond those listed.

Output

NameTypeDescription
spacestring (space-ref)

Delete a record from a space repo, or ensure it doesn’t exist. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.deleteRecord
CLI
pds space delete-record
MCP
space_delete_record
Errors
SpaceNotFound
Specified in
The space repo · lexicon

Input

NameTypeDescription
spacestring (space-ref)
repostring (did)
collectionstring (nsid)
rkeystring (record-key)

Delete a space, along with the authority’s space repo. Requires auth as the space authority, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.deleteSpace
CLI
pds space delete-space
MCP
space_delete_space
Errors
SpaceNotFound NotAuthorized
Specified in
Spaces: policies and the space lifecycle · lexicon

Input

NameTypeDescription
spacestring (space-ref)

Export a space’s state, such as its policy and member list, as a STAR file for account migration. Requires auth as the space authority, implemented by PDS.

XRPC
GET /xrpc/com.atproto.space.exportSpaceMeta
CLI
pds space export-space-meta
MCP
none
Output
application/vnd.dasl.star
Errors
SpaceNotFound NotAuthorized
Specified in
Spaces: policies and the space lifecycle · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)

Get a blob referenced by a record in a space repo. Returns the full blob as originally uploaded. Requires auth as the repo’s account or with a space credential; implemented by PDS.

XRPC
GET /xrpc/com.atproto.space.getBlob
CLI
pds space get-blob
MCP
none
Output
*/*
Errors
BlobNotFound SpaceNotFound RepoNotFound RepoTakendown RepoSuspended RepoDeactivated
Specified in
Spaces: a repo whole, its blobs, and migration · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)
repostring (did)
cidstring (cid)

Get a delegation token for a space, to exchange with the space host for a space credential. Requires auth, implemented by PDS.

XRPC
GET /xrpc/com.atproto.space.getDelegationToken
CLI
pds space get-delegation-token
MCP
space_get_delegation_token
Specified in
Spaces: credentials · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)

Output

NameTypeDescription
tokenstring

Get the current commit of a space repo. Responses are authenticated with a MAC. Requires auth as the repo’s account or with a space credential; implemented by PDS.

XRPC
GET /xrpc/com.atproto.space.getLatestCommit
CLI
pds space get-latest-commit
MCP
space_get_latest_commit
Errors
InvalidSpaceMac SpaceNotFound RepoNotFound RepoTakendown RepoSuspended RepoDeactivated
Specified in
The space repo · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)
repostring (did)

Output

NameTypeDescription
commitcom.atproto.space.defs#commit

Get a single record from a space repo. Responses are authenticated with a MAC. Requires auth as the repo’s account or with a space credential; implemented by PDS.

XRPC
GET /xrpc/com.atproto.space.getRecord
CLI
pds space get-record
MCP
space_get_record
Errors
InvalidSpaceMac RecordNotFound SpaceNotFound RepoNotFound RepoTakendown RepoSuspended RepoDeactivated
Specified in
The space repo · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)
repostring (did)
collectionstring (nsid)
rkeystring (record-key)

Output

NameTypeDescription
uristring (at-uri)
cidstring (cid)
valueunknown

Download a space repo as a STAR file. Responses are authenticated with a MAC. Requires auth as the repo’s account or with a space credential; implemented by PDS.

XRPC
GET /xrpc/com.atproto.space.getRepo
CLI
pds space get-repo
MCP
none
Output
application/vnd.dasl.star
Errors
InvalidSpaceMac SpaceNotFound RepoNotFound RepoTakendown RepoSuspended RepoDeactivated
Specified in
Spaces: a repo whole, its blobs, and migration · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)
repostring (did)

Get a space and its policy. Requires auth as the space authority, implemented by PDS.

XRPC
GET /xrpc/com.atproto.space.getSpace
CLI
pds space get-space
MCP
space_get_space
Errors
SpaceNotFound NotAuthorized
Specified in
Spaces: policies and the space lifecycle · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)

Output

NameTypeDescription
spacestring (space-ref)
policyone of com.atproto.personalspace.policy, com.atproto.memberspace.policy, com.atproto.managedspace.policyPDSes must support all of the listed policies. Other space hosts may support only some of them, and any host may support policies beyond those listed.

Import the authenticated account’s space repo from a STAR file, for account migration. If the account is the space’s authority, the space must first be imported with importSpaceMeta. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.importRepo
CLI
pds space import-repo
MCP
none
Input
application/vnd.dasl.star
Errors
SpaceNotFound InvalidRepoFile RepoMismatch
Specified in
Spaces: a repo whole, its blobs, and migration · lexicon

Import a space’s state from an archive produced by exportSpaceMeta, for account migration. Must be called before importing the authority’s space repo with importRepo. Requires auth as the space authority, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.importSpaceMeta
CLI
pds space import-space-meta
MCP
none
Input
application/vnd.dasl.star
Errors
NotAuthorized UnsupportedPolicy InvalidSpaceMeta
Specified in
Spaces: policies and the space lifecycle · lexicon

List blob CIDs referenced by records in a space repo. Requires auth as the repo’s account or with a space credential; implemented by PDS.

XRPC
GET /xrpc/com.atproto.space.listBlobs
CLI
pds space list-blobs
MCP
space_list_blobs
Errors
SpaceNotFound RepoNotFound RepoTakendown RepoSuspended RepoDeactivated
Specified in
Spaces: a repo whole, its blobs, and migration · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)
repostring (did)
limitinteger, 1 to 1000, default 500, optional
cursorstring, optional

Output

NameTypeDescription
cursorstring, optional
cidsarray of string (cid)

List records in a space repo, optionally filtered by collection. Requires auth as the repo’s account or with a space credential; implemented by PDS.

XRPC
GET /xrpc/com.atproto.space.listRecords
CLI
pds space list-records
MCP
space_list_records
Errors
SpaceNotFound RepoNotFound RepoTakendown RepoSuspended RepoDeactivated InvalidCursor
Specified in
The space repo · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)
repostring (did)
collectionstring (nsid), optionalIf omitted, lists records across all collections.
limitinteger, 1 to 1000, default 50, optional
cursorstring, optional
excludeValuesboolean, default false, optional

Output

NameTypeDescription
cursorstring, optional
recordsarray of record

List operations on a space repo after a given revision. Used for incremental sync. Hosts may truncate the log, so use getRepo for a full sync. Responses are authenticated with a MAC. Requires auth as the repo’s account or with a space credential; implemented by PDS.

XRPC
GET /xrpc/com.atproto.space.listRepoOps
CLI
pds space list-repo-ops
MCP
space_list_repo_ops
Errors
InvalidSpaceMac SpaceNotFound RepoNotFound RepoTakendown RepoSuspended RepoDeactivated InvalidCursor
Specified in
The space repo · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)
repostring (did)
sincestring (tid), optional
limitinteger, 1 to 1000, default 100, optional
cursorstring, optional
excludeValuesboolean, default false, optional

Output

NameTypeDescription
opsarray of opEntry
commitcom.atproto.space.defs#commitThe repo’s current commit. A syncer compares it against its own set hash once it has applied the last page, which has no cursor.
cursorstring, optional

List spaces that the authenticated account has written to or is the authority for. Requires auth, implemented by PDS.

XRPC
GET /xrpc/com.atproto.space.listSpaces
CLI
pds space list-spaces
MCP
space_list_spaces
Errors
InvalidCursor
Specified in
The space repo · lexicon

Parameters

NameTypeDescription
spaceDidstring (did), optionalFilter to spaces with this DID as their authority.
spaceTypestring (nsid), optional
limitinteger, 1 to 100, default 50, optional
cursorstring, optional

Output

NameTypeDescription
cursorstring, optional
spacesarray of spaceView

List the repos in a space’s writer set, with the latest known state of each: its current revision, or its removal from the writer set. Requires a space credential, implemented by the space host.

XRPC
GET /xrpc/com.atproto.space.listWriters
CLI
pds space list-writers
MCP
space_list_writers
Errors
SpaceNotFound RepoTakendown RepoDeactivated
Specified in
Spaces: write notifications, the writer set and syncers · lexicon

Parameters

NameTypeDescription
spacestring (space-ref)
limitinteger, 1 to 1000, default 100, optional
cursorstring, optionalReturn repos updated after this space revision. Removed repos may be garbage collected after 72 hrs, so a syncer whose last seen space revision is older should list the whole writer set instead.

Output

NameTypeDescription
reposarray of one of com.atproto.space.defs#repoWrite, com.atproto.space.defs#repoRemovedThe latest update to each repo, ordered by spaceRev, ascending. prevSpaceRev is not set.
cursorstring, optional

com.atproto.space.notifyCredentialsRevoked

Section titled “com.atproto.space.notifyCredentialsRevoked”

Notify a repo host that space credentials have been revoked. Sent by the space host. Requires service auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.notifyCredentialsRevoked
CLI
pds space notify-credentials-revoked
MCP
space_notify_credentials_revoked
Specified in
Spaces: credentials · lexicon

Input

NameTypeDescription
spacestring (space-ref)
credentialsarray of string, at most 100The IDs (jti) of the revoked credentials.

Notify the space host that a space repo has been updated. Sent by repo hosts, with service auth.

XRPC
POST /xrpc/com.atproto.space.notifyRepoUpdate
CLI
pds space notify-repo-update
MCP
space_notify_repo_update
Errors
SpaceNotFound FutureRev
Specified in
Spaces: write notifications, the writer set and syncers · lexicon

Input

NameTypeDescription
spacestring (space-ref)
repostring (did)
repoRevstring (tid)
databytes

Write a record in a space repo, creating or updating it as needed. Requires auth, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.putRecord
CLI
pds space put-record
MCP
space_put_record
Errors
SpaceNotFound
Specified in
The space repo · lexicon

Input

NameTypeDescription
spacestring (space-ref)
repostring (did)
collectionstring (nsid)
rkeystring (record-key)
validateboolean, optionalCan be set to ‘false’ to skip Lexicon schema validation of record data, ‘true’ to require it, or leave unset to validate only for known Lexicons.
recordunknown

Output

NameTypeDescription
uristring (at-uri)
cidstring (cid)
validationStatusstring, valid, unknown, optional

Remove an account from a space’s writer set, as returned by listWriters. The removal is sent to registered syncers. The account is added back if it makes another authorized write to the space. Does nothing if the account is not in the writer set. Requires auth as the space authority, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.removeWriter
CLI
pds space remove-writer
MCP
space_remove_writer
Errors
SpaceNotFound NotAuthorized
Specified in
Spaces: policies and the space lifecycle · lexicon

Input

NameTypeDescription
spacestring (space-ref)
repostring (did)

Replace the policy of a space. Changing to a different policy type discards state held by the previous policy, such as a member list. Requires auth as the space authority, implemented by PDS.

XRPC
POST /xrpc/com.atproto.space.updateSpace
CLI
pds space update-space
MCP
space_update_space
Errors
SpaceNotFound NotAuthorized UnsupportedPolicy
Specified in
Spaces: policies and the space lifecycle · lexicon

Input

NameTypeDescription
spacestring (space-ref)
policyone of com.atproto.personalspace.policy, com.atproto.memberspace.policy, com.atproto.managedspace.policyPDSes must support all of the listed policies. Other space hosts may support only some of them, and any host may support policies beyond those listed.

Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.

XRPC
GET /xrpc/com.atproto.sync.getBlob
CLI
pds sync get-blob
MCP
none
Output
*/*
Errors
BlobNotFound RepoNotFound RepoTakendown RepoSuspended RepoDeactivated
Specified in
Blobs · lexicon

Parameters

NameTypeDescription
didstring (did)The DID of the account.
cidstring (cid)The CID of the blob to fetch

Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS.

XRPC
GET /xrpc/com.atproto.sync.getBlocks
CLI
pds sync get-blocks
MCP
none
Output
application/vnd.ipld.car
Errors
BlockNotFound RepoNotFound RepoTakendown RepoSuspended RepoDeactivated
Specified in
Federation: what a relay reads · lexicon

Parameters

NameTypeDescription
didstring (did)The DID of the repo.
cidsarray of string (cid)

Get the current commit CID & revision of the specified repo. Does not require auth.

XRPC
GET /xrpc/com.atproto.sync.getLatestCommit
CLI
pds sync get-latest-commit
MCP
sync_get_latest_commit
Errors
RepoNotFound RepoTakendown RepoSuspended RepoDeactivated
Specified in
Sync and the firehose · lexicon

Parameters

NameTypeDescription
didstring (did)The DID of the repo.

Output

NameTypeDescription
cidstring (cid)
revstring (tid)

Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.

XRPC
GET /xrpc/com.atproto.sync.getRecord
CLI
pds sync get-record
MCP
none
Output
application/vnd.ipld.car
Errors
RecordNotFound RepoNotFound RepoTakendown RepoSuspended RepoDeactivated
Specified in
Federation: what a relay reads · lexicon

Parameters

NameTypeDescription
didstring (did)The DID of the repo.
collectionstring (nsid)
rkeystring (record-key)Record Key

Download a repository export as CAR file. Optionally only a ‘diff’ since a previous revision. Does not require auth; implemented by PDS.

XRPC
GET /xrpc/com.atproto.sync.getRepo
CLI
pds sync get-repo
MCP
none
Output
application/vnd.ipld.car
Errors
RepoNotFound RepoTakendown RepoSuspended RepoDeactivated
Specified in
Sync and the firehose · lexicon

Parameters

NameTypeDescription
didstring (did)The DID of the repo.
sincestring (tid), optionalThe revision (‘rev’) of the repo to create a diff from.

Get the hosting status for a repository, on this server. Expected to be implemented by PDS and Relay.

XRPC
GET /xrpc/com.atproto.sync.getRepoStatus
CLI
pds sync get-repo-status
MCP
sync_get_repo_status
Errors
RepoNotFound
Specified in
Federation: what a relay reads · lexicon

Parameters

NameTypeDescription
didstring (did)The DID of the repo.

Output

NameTypeDescription
didstring (did)
activeboolean
statusstring, takendown, suspended, deleted, deactivated, desynchronized, throttled, optionalIf active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.
revstring (tid), optionalOptional field, the current rev of the repo, if active=true

List blob CIDs for an account, since some repo revision. Does not require auth; implemented by PDS.

XRPC
GET /xrpc/com.atproto.sync.listBlobs
CLI
pds sync list-blobs
MCP
sync_list_blobs
Errors
RepoNotFound RepoTakendown RepoSuspended RepoDeactivated
Specified in
Blobs · lexicon

Parameters

NameTypeDescription
didstring (did)The DID of the repo.
sincestring (tid), optionalOptional revision of the repo to list blobs since.
limitinteger, 1 to 1000, default 500, optional
cursorstring, optional

Output

NameTypeDescription
cursorstring, optional
cidsarray of string (cid)

Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay.

XRPC
GET /xrpc/com.atproto.sync.listRepos
CLI
pds sync list-repos
MCP
sync_list_repos
Specified in
Federation: what a relay reads · lexicon

Parameters

NameTypeDescription
limitinteger, 1 to 1000, default 500, optional
cursorstring, optional

Output

NameTypeDescription
cursorstring, optional
reposarray of repo

Repository event stream, aka Firehose endpoint. Outputs repo commits with diff data, and identity update events, for all repositories on the current server. See the atproto specifications for details around stream sequencing, repo versioning, CAR diff format, and more. Public and does not require auth; implemented by PDS and Relay.

XRPC
WS /xrpc/com.atproto.sync.subscribeRepos
CLI
none
MCP
none
Errors
FutureCursor ConsumerTooSlow
Specified in
Sync and the firehose · lexicon

Parameters

NameTypeDescription
cursorinteger, optionalThe last known event seq number to backfill from.