curl

Every any client is an HTTP client. This page is the whole loop in raw JSON, so you know exactly what the CLI and the language recipes are sending.

Assumes any run is up on 127.0.0.1:7001 (Install) and jq is installed.

API=http://127.0.0.1:7001/v1
curl -fsS "$API/auth" | jq -e '.authorized == true'   # an account is booted

-f makes curl exit non-zero on a 4xx/5xx, so a broken step stops a script instead of feeding "" into the next one. If the check prints false, finish Create an account first.

1. Create a space

SPACE=$(curl -fsS -X POST $API/spaces -H 'content-type: application/json' \
  -d '{"name":"Notebook","description":"first space"}' | jq -er .id)

The reply is the space; jq keeps its id:

{ "id": "bafyreig…", "spaceType": "any.space", "name": "Notebook",
  "description": "first space", "status": "active", "ownRole": "owner",
  "createdAt": "2026-08-24T10:00:00Z", "spaceIndexObjectId": "bafyreia…" }

2. Create an object

A document is an object whose type has a part declaring the editor module. The built-in page type is the plain one — hidden from the picker, present in every space, no properties — so "type": "page" is all it takes; a client that needs columns declares its own document type, normally registered as a bundle so every device agrees on it. type is required on create; collections (what the object is filed under) is optional. Properties always ride initialProperties keyed by owner; the universal any group owns name / description.

OBJ=$(curl -fsS -X POST $API/spaces/$SPACE/objects -H 'content-type: application/json' \
  -d '{"type":"page","initialProperties":{"any":{"name":"Reading list"}}}' | jq -er .objectId)

{ "objectId": "bafyreib…" }

The three body keys type, collections, initialProperties are the whole vocabulary; anything else is 400 request.unknown_field. The object gets exactly the type and the collections it names — a place in the space's tree is one of those collections, the wiki usecase's (Objects).

3. Query

Reads are POSTs with a Mongo-style body. The cross-object query reads the space's objects storage collection — one row per object with its property values and derived stamps:

curl -fsS -X POST $API/spaces/$SPACE/objects/query -H 'content-type: application/json' \
  -d '{"filter":{"any.type":"page"},"sort":["-modifiedAt","id"],"limit":20,"includeTotal":true}'

{ "records": [
    { "id": "bafyreib…",
      "any": { "type": "page", "name": "Reading list" },
      "author": "A8tR…", "spaceId": "bafyreig…",
      "createdAt": { "$date": "2026-08-24T10:01:00.000Z" },
      "modifiedAt": { "$date": "2026-08-24T10:01:00.000Z" },
      "modifiedBy": "A8tR…",
      "_ver": { "…": "…" } } ],
  "total": 1, "hasNext": false }

any.type is a scalar, so filtering by type is plain equality ({"any.type":"<typeId>"}); any.collections is an array, where a scalar is the "contains" spelling ({"any.collections":"<collectionId>"}). The trailing id in sort breaks timestamp ties, so a window stays stable across pages and subscriptions. Timestamps are {"$date": …} instants and must be written the same way in filters (Reading data).

Same body, sibling path, -N to keep the stream open. The response is text/event-stream:

curl -fsS -N -X POST $API/spaces/$SPACE/objects/query/subscribe -H 'content-type: application/json' \
  -d '{"filter":{"any.type":"page"},"sort":["-modifiedAt","id"],"limit":20}'

event: ready
data: {}

event: snapshot
data: {"records":[{"id":"bafyreib…", …}]}

: keepalive

Now, from another terminal (with API, SPACE and OBJ set there too), rename the object:

curl -fsS -X POST $API/spaces/$SPACE/properties/$OBJ/set/any \
  -H 'content-type: application/json' -d '{"patch":{"name":"Reading list 2026"}}'

The stream prints the delta:

event: changes
data: [{"versionId":"…",
        "updated":[{"id":"bafyreib…","doc":{…"name":"Reading list 2026"…},
                    "ops":[{"type":"$set","path":["any","name"],"payload":"Reading list 2026"}]}]}]

Wait for ready, integrate snapshot, then apply each changes batch to your window. A batch carries only the non-empty lists among added / updated / removed, and each removed entry names its reason (deleted, filtered-out, displaced). A terminal event: closed (server_shutdown, deauthorized, sdk_closed, overflow, drifted) means "open a fresh POST" — there is no replay (Subscriptions).

A write's reply

Dataset writes never return the record — only the change:

{ "versionId": "…", "changeId": "bafyreic…", "recordIds": ["bafyreib…"] }

Read it back with a query; that is the one read path for every dataset (The zen of any).

Errors

Every non-2xx has one shape:

curl -sS $API/spaces/nope

{ "error": { "code": "space.not_found", "message": "space not found", "details": { "spaceId": "nope" } } }

Without -f curl prints the body and exits 0; with it, the body is dropped — recent curl has --fail-with-body for both. 401 auth.required means the server has no account booted yet — any init was skipped, or the data dir holds several accounts and none was selected. POST $API/auth with {} generates one in place (Accounts).

Next: the same four steps as CLI commands, or in JavaScript / Python.