This repository contains developer documentation for the Bluesky API (api.bsky.app
), which is available to read at docs.bsky.app.
The atproto.com website, including the AT Protocol specifications, is versioned separately at https://github.com/bluesky-social/atproto-website.
This website is built using Docusaurus, a modern static website generator.
For live-reloading development:
npm install
npm start
To output a build:
npm run build
This command generates static content into the build
directory and can be served using any static contents hosting service.
We use a forked version of atproto-openapi-types
to generate an OpenAPI schema from atproto lexicons. We use the docusaurus-openapi-docs
plugin.
To generate OpenAPI types from atproto lexicons:
deno task run
to generate a fresh OpenAPI spec to atproto-openapi-types/spec/api.json
.npx docusaurus-mdx-checker
to see MDX compatibility.npm run docusaurus gen-api-docs <id>
to generate MDX docs from an OpenAPI spec. In this case, npm run docusaurus gen-api-docs bskyApi
.If you want to regenerate MDX docs from an updated api.json
file, run npm run clear-and-gen-api-docs
. This command clears the existing docs and replaces them with freshly generated docs.
The OpenAPI docs auto-update with the latest lexicon changes once a day.
Bluesky is an open social network built on the AT Protocol, a flexible technology that will never lock developers out of the ecosystems that they help build. With atproto, third-party can be as seamless as first-party through custom feeds, federated services, clients, and more.
Documentation text is under Creative Commons Attribution (CC-BY).
Inline code examples, example data, and regular expressions are under Creative Commons Zero (CC-0, aka Public Domain) and copy/pasted without attribution.
Please see [LICENSE.txt]() with reminders about derivative works, and [LICENSE-CC-BY.txt]() for a copy of license legal text.