API / Space guide

API reference

Space is in development. These guides describe the current development version and the intended workflow. Public sign-ups and hosted agent connections are not available yet.

Every route a personal API key can call, with its parameters, fields, errors and an example request.

New to the API? Start with Build with the API to create a key and make a first request, then read API concepts. This reference describes version 0.3.0 of the API.

Build your own client for Space.

Create a personal API key in Settings → API keys and send it on every request as Authorization: Bearer spk_.... A key acts as you in the one Space it was created for, with your current role there. A read-only key can read and search; a read-write key can also create, change and delete content. Keys cannot manage agents, keys, members, billing, restores or webhooks, and they do not work on the MCP endpoint.

Errors are JSON objects with an error message. Writes take an expected_revision or a command_id where shown, so a retry never applies twice. Treat a key like a password: keep it out of public web pages and revoke it in Settings if it leaks.

Authentication

A personal API key (spk_...) created in Settings for one Space. Send it as a bearer token in the Authorization header of every request. Keys start with spk_.

Authorization: Bearer spk_...

Base URL

Requests go to your Space API URL, not to this website. Every path in this reference is relative to it. If the Agents page shows https://<api-host>/mcp/, your API URL is https://<api-host>. Find your API URL.

Errors

Errors return a status code and a JSON body. API concepts explains each status and how to retry.

Error

  • errorstringRequired

    A human-readable explanation of what went wrong.

{
  "error": "This API key is read-only."
}

Space

The key's Space, its map, usage and activity.

Documents and tasks

Documents, tasks and task columns.

Projects, folders and databases

Workspace items and records.

Memory

Memory claims, links and extraction jobs.

Search and recall

Full-text search and cited recall.

Export

Paged export of everything in the Space.

Operations

Service liveness.