Quickstart

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).

API=http://127.0.0.1:7001/v1

1. Create a space

curl -s -X POST $API/spaces -H 'content-type: application/json' \
  -d '{"name":"Notebook","description":"first space"}'

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

Keep the id:

SPACE=bafyreig…

2. Create an object

Bind the built-in page type and set a name. Properties always ride initialProperties keyed by type; the universal any type owns name / description.

curl -s -X POST $API/spaces/$SPACE/objects -H 'content-type: application/json' \
  -d '{"types":["page"],"initialProperties":{"any":{"name":"Reading list"}}}'

{ "objectId": "bafyreib…" }

nav is stamped automatically — every object gets nav.parentId / nav.pos so clients can render a tree (Objects). The three body keys types, initialProperties, nav are the whole vocabulary; anything else is 400 request.unknown_field.

3. Query

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

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

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

A scalar against an array field is the "contains" spelling ({"any.types":"page"}). Timestamps are {"$date": …} instants and must be written the same way in filters (Reading data).

4. Subscribe

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

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

event: ready
data: {}

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

: keepalive

Now, from another terminal, rename the object:

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

The stream prints the delta:

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

Wait for ready, integrate snapshot, then apply each changes batch to your window. A terminal event: closed (server_shutdown, 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 -s $API/spaces/nope

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

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.