API v2
Pre-release
API v2 can change without a new API version. For production integrations that need a stable contract, use API v1.
API v2 exposes an object as one editable AnyBlock JSON document. A single
GET reads its properties and content; a single PATCH applies a batch of
edits. It is designed for agents, scripts, and integrations that need to work
with whole documents.
Both API majors run in the same Anytype process, on the same port, and accept
the same API keys. v2 routes start with /v2/ and do not require the
Anytype-Version request header.
Start building
- Connect and authenticate to obtain an API key and check its access.
- Read and search using whole documents, outlines, or selected properties.
- Edit with a batch of operations, with concurrency checks, retries, and dry runs.
- Discover schemas to construct and validate requests.
The Introduction explains the shared conventions, errors, streams, and file downloads. Browse Objects for the document endpoints.
For agents
Download the API skill, or install it with:
npx skills add https://developers.anytype.io --skill anytype-api