Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AT Protocol server API

Server management, session creation, account administration

AT Protocol server API is one of 9 APIs that AT Protocol publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include server. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 8 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://public.api.bsky.app/xrpc, https://api.bsky.app/xrpc.

8 operations 8 paths 8 schemas 3 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://bsky.social/xrpc
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

AT Protocol server API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated, though some operations may also be called without credentials.

  • bearerAuth — Access JWT obtained from com.atproto.server.createSession

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 3 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

server 8

Server management, session creation, account administration

GET
/com.atproto.server.describeServer
Describe Server
com_atproto_server_describeServer → 200400
POST
/com.atproto.server.createSession
Create Session
com_atproto_server_createSession body → 200400401
POST
/com.atproto.server.deleteSession
Delete Session
com_atproto_server_deleteSession → 200400401
GET
/com.atproto.server.getSession
Get Session
com_atproto_server_getSession → 200400401
POST
/com.atproto.server.refreshSession
Refresh Session
com_atproto_server_refreshSession → 200400401
POST
/com.atproto.server.createAccount
Create Account
com_atproto_server_createAccount body → 200400
POST
/com.atproto.server.deleteAccount
Delete Account
com_atproto_server_deleteAccount body → 200400401
GET
/com.atproto.server.checkAccountStatus
Check Account Status
com_atproto_server_checkAccountStatus → 200401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Session (10 properties), AccountStatus (9 properties), SessionInfo (8 properties), CreateAccountInput (8 properties). Each schema is shown below with its type and property counts.

CreateAccountInput
object
8 properties 1 required
CreateAccountOutput
object
5 properties 4 required
CreateSessionInput
object
4 properties 2 required
AccountStatus
object
9 properties 9 required
Session
object
10 properties 4 required
Error
object
2 properties 2 required
SessionInfo
object
8 properties 2 required
ServerDescription
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atproto-server-api-openapi.yml Raw ↑

Other APIs AT Protocol publishes across the network.

AT Protocol Firehose (Event Stream)
AT Protocol actor API
AT Protocol feed API
AT Protocol graph API
AT Protocol identity API
AT Protocol notification API
AT Protocol repo API
AT Protocol sync API