Space
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.
The key's Space, its map, usage and activity.
Send every request to your API URL with your key, as described in the reference overview. Read API concepts for paging, safe retries, revisions and errors.
GET / v1/ workspace
Get the key's Space
The Space this key was created for, with your role in it. Start here to learn the space_id every other route takes.
Responses
200Success
idstring (uuid)Requiredorganization_idstring (uuid)RequiredkindstringRequiredOne of
personal,teamrolestringRequiredOne of
owner,admin,member,viewervisibilitystringRequiredis_defaultbooleanRequirednamestringRequiredtasks_collection_idstring (uuid)Requiredmcp_urlstringRequiredThe agent (MCP) endpoint. The REST API shares its origin.
agent_idstring (uuid) or nullRequiredAlways null for an API key.
space_mapobjectRequired1 field in
space_maptoolstringRequired
Example response
{
"agent_id": null,
"id": "704ffc7a-8ef2-4be4-931d-35f4d4f21933",
"is_default": true,
"kind": "personal",
"mcp_url": "https://api.example.com/mcp/",
"name": "Private Space",
"organization_id": "118ab082-d79e-432d-b829-516b97ef04cf",
"role": "owner",
"space_map": {
"tool": "get_space_map"
},
"tasks_collection_id": "e8bbd593-9888-4271-b78e-2b1286710c70",
"visibility": "private"
}Errors
Example request
curl "https://<api-host>/v1/workspace" \
-H "Authorization: Bearer $SPACE_API_KEY"GET / v1/ spaces/ {space_id}/ read-version
Get the Space read version
A cheap opaque version of the Space. Poll it and refetch only when it changes.
Path parameters
space_idstring (uuid)Required
Responses
200Success
versionstringRequiredOpaque. It changes whenever content, your role or visibility changes.
Example response
{
"version": "1:0:owner:private"
}Errors
- 401The API key is missing, unknown, expired or revoked. Error
- 403Not allowed: a read-only key, a view-only role, or an operation keys cannot do. Error
- 404Not found. Other Spaces also look absent to a key. Error
- 422Invalid fields, revision or payload. Error
- 503Temporarily unavailable or busy. Retry with backoff, honouring Retry-After. Error
Example request
curl "https://<api-host>/v1/spaces/{space_id}/read-version" \
-H "Authorization: Bearer $SPACE_API_KEY"GET / v1/ spaces/ {space_id}/ usage
Get plan usage
Storage, item and monthly model-request usage against the Space's limits.
Path parameters
space_idstring (uuid)Required
Responses
200Success
retained_bytesintegerRequireditemsintegerRequiredstorage_limit_bytesintegerRequireditem_limitintegerRequiredmodel_requestsintegerRequiredModel requests used this calendar month (UTC).
model_request_limitintegerRequiredresets_atstring (date-time) or nullRequiredplanobject or nullRequired3 fields in
planplanstringRequiredstatusstringRequired{key}anyAny other key.
Example response
{
"item_limit": 10000,
"items": 0,
"model_request_limit": 2000,
"model_requests": 0,
"plan": null,
"resets_at": null,
"retained_bytes": 0,
"storage_limit_bytes": 536870912
}Errors
- 401The API key is missing, unknown, expired or revoked. Error
- 403Not allowed: a read-only key, a view-only role, or an operation keys cannot do. Error
- 404Not found. Other Spaces also look absent to a key. Error
- 422Invalid fields, revision or payload. Error
- 503Temporarily unavailable or busy. Retry with backoff, honouring Retry-After. Error
Example request
curl "https://<api-host>/v1/spaces/{space_id}/usage" \
-H "Authorization: Bearer $SPACE_API_KEY"GET / v1/ spaces/ {space_id}/ overview
Get activity overview
Activity over the last 7, 30 or 90 days: totals, a daily series, per-agent and per-strategy measures and the most recent events. Pass all_periods=true to get every window at once.
Path parameters
space_idstring (uuid)Required
Query parameters
daysintegerDefault
30all_periodsbooleanDefault
false
Responses
200Success
space_idstring (uuid)RequireddaysintegerRequiredOne of
7,30,90as_ofstring (date-time)Requiredperiod_startstring (date-time)Requiredtracking_started_atstring (date-time)RequiredtotalsobjectRequired5 fields in
totalsdocumentsintegerRequiredtasksintegerRequiredmemoriesintegerRequireddocument_linesintegerRequiredmeasured_documentsintegerRequired
summaryobjectRequired11 fields in
summarydocument_writesintegerRequireddocuments_createdintegerRequiredmemories_createdintegerRequiredmemory_writesintegerRequiredretrievalsintegerRequiredwith_resultsintegerRequiredemptyintegerRequirederrorsintegerRequiredp50_msnumber or nullRequiredp95_msnumber or nullRequiredreused_memoriesintegerRequired
activityarray of objectRequired5 fields in
activitydatestringRequiredA UTC calendar date, YYYY-MM-DD.
availablebooleanRequiredFalse before activity tracking started.
document_writesinteger or nullRequiredmemories_createdinteger or nullRequiredretrievalsinteger or nullRequired
agentsarray of objectRequired13 fields in
agentsdocument_writesintegerRequireddocuments_createdintegerRequiredmemories_createdintegerRequiredmemory_writesintegerRequiredretrievalsintegerRequiredwith_resultsintegerRequiredemptyintegerRequirederrorsintegerRequiredp50_msnumber or nullRequiredp95_msnumber or nullRequiredagent_idstring (uuid) or nullRequiredactor_typestringRequiredlast_active_atstring (date-time)Required
strategiesarray of objectRequired11 fields in
strategiesdocument_writesintegerRequireddocuments_createdintegerRequiredmemories_createdintegerRequiredmemory_writesintegerRequiredretrievalsintegerRequiredwith_resultsintegerRequiredemptyintegerRequirederrorsintegerRequiredp50_msnumber or nullRequiredp95_msnumber or nullRequiredstrategystringRequired
recentarray of objectRequired11 fields in
recentidstring (uuid)Requiredcreated_atstring (date-time)Requiredagent_idstring (uuid) or nullRequiredactor_typestringRequiredkindstringRequiredresource_idstring (uuid) or nullRequirednew_itemsintegerRequireditem_countintegerRequiredoutcomestringRequiredduration_msnumber or nullRequiredresource_existsbooleanRequired
usageobjectRequired8 fields in
usageretained_bytesintegerRequireditemsintegerRequiredstorage_limit_bytesintegerRequireditem_limitintegerRequiredmodel_requestsintegerRequiredModel requests used this calendar month (UTC).
model_request_limitintegerRequiredresets_atstring (date-time) or nullRequiredplanobject or nullRequired3 fields in
planplanstringRequiredstatusstringRequired{key}anyAny other key.
periodsobject or nullWith all_periods=true: the 7, 30 and 90 day windows.
1 field in
periods{key}objectAny other key.
4 fields in
{key}period_startstring (date-time)RequiredsummaryobjectRequired11 fields in
summarydocument_writesintegerRequireddocuments_createdintegerRequiredmemories_createdintegerRequiredmemory_writesintegerRequiredretrievalsintegerRequiredwith_resultsintegerRequiredemptyintegerRequirederrorsintegerRequiredp50_msnumber or nullRequiredp95_msnumber or nullRequiredreused_memoriesintegerRequired
agentsarray of objectRequired13 fields in
agentsdocument_writesintegerRequireddocuments_createdintegerRequiredmemories_createdintegerRequiredmemory_writesintegerRequiredretrievalsintegerRequiredwith_resultsintegerRequiredemptyintegerRequirederrorsintegerRequiredp50_msnumber or nullRequiredp95_msnumber or nullRequiredagent_idstring (uuid) or nullRequiredactor_typestringRequiredlast_active_atstring (date-time)Required
strategiesarray of objectRequired11 fields in
strategiesdocument_writesintegerRequireddocuments_createdintegerRequiredmemories_createdintegerRequiredmemory_writesintegerRequiredretrievalsintegerRequiredwith_resultsintegerRequiredemptyintegerRequirederrorsintegerRequiredp50_msnumber or nullRequiredp95_msnumber or nullRequiredstrategystringRequired
Example response
{
"activity": [
{
"available": false,
"date": "2026-07-11",
"document_writes": null,
"memories_created": null,
"retrievals": null
},
{
"available": false,
"date": "2026-07-12",
"document_writes": null,
"memories_created": null,
"retrievals": null
}
],
"agents": [
{
"actor_type": "website",
"agent_id": null,
"document_writes": 1,
"documents_created": 1,
"empty": 0,
"errors": 0,
"last_active_at": "2026-10-08T01:56:08.013024+00:00",
"memories_created": 4,
"memory_writes": 6,
"p50_ms": 36.92158401827328,
"p95_ms": 44.39330839959439,
"retrievals": 3,
"with_results": 3
}
],
"as_of": "2026-10-08T01:56:08.047603+00:00",
"days": 90,
"period_start": "2026-07-11T00:00:00+00:00",
"periods": {
"7": {
"agents": [
{
"actor_type": "website",
"agent_id": null,
"document_writes": 1,
"documents_created": 1,
"empty": 0,
"errors": 0,
"last_active_at": "2026-10-08T01:56:08.013024+00:00",
"memories_created": 4,
"memory_writes": 6,
"p50_ms": 36.92158401827328,
"p95_ms": 44.39330839959439,
"retrievals": 3,
"with_results": 3
}
],
"period_start": "2026-10-02T00:00:00+00:00",
"strategies": [
{
"document_writes": 0,
"documents_created": 0,
"empty": 0,
"errors": 0,
"memories_created": 0,
"memory_writes": 0,
"p50_ms": 41.07254200789612,
"p95_ms": 44.80840419855667,
"retrievals": 2,
"strategy": "lexical",
"with_results": 2
},
{
"document_writes": 0,
"documents_created": 0,
"empty": 0,
"errors": 0,
"memories_created": 0,
"memory_writes": 0,
"p50_ms": 14.102875022217631,
"p95_ms": 14.102875022217631,
"retrievals": 1,
"strategy": "resume",
"with_results": 1
}
],
"summary": {
"document_writes": 1,
"documents_created": 1,
"empty": 0,
"errors": 0,
"memories_created": 4,
"memory_writes": 6,
"p50_ms": 36.92158401827328,
"p95_ms": 44.39330839959439,
"retrievals": 3,
"reused_memories": 4,
"with_results": 3
}
},
"30": {
"agents": [
{
"actor_type": "website",
"agent_id": null,
"document_writes": 1,
"documents_created": 1,
"empty": 0,
"errors": 0,
"last_active_at": "2026-10-08T01:56:08.013024+00:00",
"memories_created": 4,
"memory_writes": 6,
"p50_ms": 36.92158401827328,
"p95_ms": 44.39330839959439,
"retrievals": 3,
"with_results": 3
}
],
"period_start": "2026-09-09T00:00:00+00:00",
"strategies": [
{
"document_writes": 0,
"documents_created": 0,
"empty": 0,
"errors": 0,
"memories_created": 0,
"memory_writes": 0,
"p50_ms": 41.07254200789612,
"p95_ms": 44.80840419855667,
"retrievals": 2,
"strategy": "lexical",
"with_results": 2
},
{
"document_writes": 0,
"documents_created": 0,
"empty": 0,
"errors": 0,
"memories_created": 0,
"memory_writes": 0,
"p50_ms": 14.102875022217631,
"p95_ms": 14.102875022217631,
"retrievals": 1,
"strategy": "resume",
"with_results": 1
}
],
"summary": {
"document_writes": 1,
"documents_created": 1,
"empty": 0,
"errors": 0,
"memories_created": 4,
"memory_writes": 6,
"p50_ms": 36.92158401827328,
"p95_ms": 44.39330839959439,
"retrievals": 3,
"reused_memories": 4,
"with_results": 3
}
},
"90": {
"agents": [
{
"actor_type": "website",
"agent_id": null,
"document_writes": 1,
"documents_created": 1,
"empty": 0,
"errors": 0,
"last_active_at": "2026-10-08T01:56:08.013024+00:00",
"memories_created": 4,
"memory_writes": 6,
"p50_ms": 36.92158401827328,
"p95_ms": 44.39330839959439,
"retrievals": 3,
"with_results": 3
}
],
"period_start": "2026-07-11T00:00:00+00:00",
"strategies": [
{
"document_writes": 0,
"documents_created": 0,
"empty": 0,
"errors": 0,
"memories_created": 0,
"memory_writes": 0,
"p50_ms": 41.07254200789612,
"p95_ms": 44.80840419855667,
"retrievals": 2,
"strategy": "lexical",
"with_results": 2
},
{
"document_writes": 0,
"documents_created": 0,
"empty": 0,
"errors": 0,
"memories_created": 0,
"memory_writes": 0,
"p50_ms": 14.102875022217631,
"p95_ms": 14.102875022217631,
"retrievals": 1,
"strategy": "resume",
"with_results": 1
}
],
"summary": {
"document_writes": 1,
"documents_created": 1,
"empty": 0,
"errors": 0,
"memories_created": 4,
"memory_writes": 6,
"p50_ms": 36.92158401827328,
"p95_ms": 44.39330839959439,
"retrievals": 3,
"reused_memories": 4,
"with_results": 3
}
}
},
"recent": [
{
"actor_type": "website",
"agent_id": null,
"created_at": "2026-10-08T01:56:08.013024+00:00",
"duration_ms": 45.22349999751896,
"id": "ce154afa-24f4-41f7-bb78-c5573f0fc1e5",
"item_count": 5,
"kind": "retrieval",
"new_items": 0,
"outcome": "success",
"resource_exists": false,
"resource_id": null
},
{
"actor_type": "website",
"agent_id": null,
"created_at": "2026-10-08T01:56:07.904882+00:00",
"duration_ms": null,
"id": "cddadb85-bae8-4725-a800-58ea9d43ae79",
"item_count": 1,
"kind": "memory",
"new_items": 1,
"outcome": "success",
"resource_exists": true,
"resource_id": "3bd12481-05da-4243-9c3b-cc453fd74a31"
}
],
"space_id": "704ffc7a-8ef2-4be4-931d-35f4d4f21933",
"strategies": [
{
"document_writes": 0,
"documents_created": 0,
"empty": 0,
"errors": 0,
"memories_created": 0,
"memory_writes": 0,
"p50_ms": 41.07254200789612,
"p95_ms": 44.80840419855667,
"retrievals": 2,
"strategy": "lexical",
"with_results": 2
},
{
"document_writes": 0,
"documents_created": 0,
"empty": 0,
"errors": 0,
"memories_created": 0,
"memory_writes": 0,
"p50_ms": 14.102875022217631,
"p95_ms": 14.102875022217631,
"retrievals": 1,
"strategy": "resume",
"with_results": 1
}
],
"summary": {
"document_writes": 1,
"documents_created": 1,
"empty": 0,
"errors": 0,
"memories_created": 4,
"memory_writes": 6,
"p50_ms": 36.92158401827328,
"p95_ms": 44.39330839959439,
"retrievals": 3,
"reused_memories": 4,
"with_results": 3
},
"totals": {
"document_lines": 0,
"documents": 0,
"measured_documents": 0,
"memories": 3,
"tasks": 1
},
"tracking_started_at": "2026-10-08T01:56:06.888301+00:00",
"usage": {
"item_limit": 10000,
"items": 10,
"model_request_limit": 2000,
"model_requests": 9,
"plan": null,
"resets_at": "2026-11-01T00:00:00",
"retained_bytes": 17120,
"storage_limit_bytes": 536870912
}
}Errors
- 400The request is well formed but cannot be carried out, such as an unknown status. Error
- 401The API key is missing, unknown, expired or revoked. Error
- 403Not allowed: a read-only key, a view-only role, or an operation keys cannot do. Error
- 404Not found. Other Spaces also look absent to a key. Error
- 422Invalid fields, revision or payload. Error
- 503Temporarily unavailable or busy. Retry with backoff, honouring Retry-After. Error
Example request
curl "https://<api-host>/v1/spaces/{space_id}/overview" \
-H "Authorization: Bearer $SPACE_API_KEY"GET / v1/ spaces/ {space_id}/ map
Get the Space map
The Space's structure: sections, projects, folders, databases and categories, with the routing rules that say what belongs where. No document text or records. max_chars bounds the size; truncated says whether it was shortened.
Path parameters
space_idstring (uuid)Required
Query parameters
max_charsintegerDefault
12000
Responses
200Success
spaceobjectRequired2 fields in
spaceidstring (uuid)RequirednamestringRequired
global_rulesarray of objectRequired6 fields in
global_rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
sectionsarray of objectRequired7 fields in
sectionsidstring (uuid)RequirednamestringRequireddescriptionstringRequiredrulesarray of objectRequired6 fields in
rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
projectsarray of objectRequired7 fields in
projectsidstring (uuid)RequirednamestringRequireddescriptionstringRequiredstatusstringRequiredrulesarray of objectRequired6 fields in
rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
foldersarray of objectRequired4 fields in
foldersidstring (uuid)RequirednamestringRequireddescriptionstringRequiredrulesarray of objectRequired6 fields in
rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
databasesarray of objectRequired8 fields in
databasesidstring (uuid)RequirednamestringRequireddescriptionstringRequiredrecordsintegerRequiredfieldsarray of object or nullOmitted when the map is shortened to fit max_chars.
2 fields in
fieldsnamestringRequiredtypestringRequired
viewstringRequiredgroup_bystring or nullRequiredrulesarray of objectRequired6 fields in
rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
foldersarray of objectRequired4 fields in
foldersidstring (uuid)RequirednamestringRequireddescriptionstringRequiredrulesarray of objectRequired6 fields in
rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
databasesarray of objectRequired8 fields in
databasesidstring (uuid)RequirednamestringRequireddescriptionstringRequiredrecordsintegerRequiredfieldsarray of object or nullOmitted when the map is shortened to fit max_chars.
2 fields in
fieldsnamestringRequiredtypestringRequired
viewstringRequiredgroup_bystring or nullRequiredrulesarray of objectRequired6 fields in
rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
unsectionedobjectRequired3 fields in
unsectionedprojectsarray of objectRequired7 fields in
projectsidstring (uuid)RequirednamestringRequireddescriptionstringRequiredstatusstringRequiredrulesarray of objectRequired6 fields in
rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
foldersarray of objectRequired4 fields in
foldersidstring (uuid)RequirednamestringRequireddescriptionstringRequiredrulesarray of objectRequired6 fields in
rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
databasesarray of objectRequired8 fields in
databasesidstring (uuid)RequirednamestringRequireddescriptionstringRequiredrecordsintegerRequiredfieldsarray of object or nullOmitted when the map is shortened to fit max_chars.
2 fields in
fieldsnamestringRequiredtypestringRequired
viewstringRequiredgroup_bystring or nullRequiredrulesarray of objectRequired6 fields in
rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
foldersarray of objectRequired4 fields in
foldersidstring (uuid)RequirednamestringRequireddescriptionstringRequiredrulesarray of objectRequired6 fields in
rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
databasesarray of objectRequired8 fields in
databasesidstring (uuid)RequirednamestringRequireddescriptionstringRequiredrecordsintegerRequiredfieldsarray of object or nullOmitted when the map is shortened to fit max_chars.
2 fields in
fieldsnamestringRequiredtypestringRequired
viewstringRequiredgroup_bystring or nullRequiredrulesarray of objectRequired6 fields in
rulestextstringRequiredentry_idstring (uuid)Requiredmemory_idstring (uuid)RequiredrevisionintegerRequiredoriginstringRequiredOne of
explicit,inferredstalebooleanRequired
categoriesarray of objectRequired3 fields in
categoriesidstring (uuid)RequirednamestringRequireddescriptionstringRequired
task_statusesarray of objectRequired2 fields in
task_statusesvaluestringRequiredThe status value stored on tasks, such as in_progress.
labelstringRequired
truncatedbooleanRequiredTrue when the map was shortened to fit max_chars.
Example response
{
"categories": [
{
"description": "",
"id": "2783099a-562f-461b-b551-735fe15e947c",
"name": "Engineering"
}
],
"global_rules": [],
"sections": [
{
"databases": [],
"description": "",
"folders": [],
"id": "fde5224d-38ab-4b85-8cff-44f268d8b48b",
"name": "Work",
"projects": [
{
"databases": [],
"description": "",
"folders": [],
"id": "5c81be14-1e68-42d2-a4d4-48b684198713",
"name": "Beacon",
"rules": [],
"status": "todo"
}
],
"rules": []
}
],
"space": {
"id": "704ffc7a-8ef2-4be4-931d-35f4d4f21933",
"name": "Private Space"
},
"task_statuses": [
{
"label": "To do",
"value": "todo"
},
{
"label": "In progress",
"value": "in_progress"
}
],
"truncated": false,
"unsectioned": {
"databases": [
{
"description": "",
"fields": [
{
"name": "Company",
"type": "text"
},
{
"name": "Value",
"type": "number"
}
],
"group_by": null,
"id": "9d3b1d63-258d-4a4f-9e9e-6785d3c9a048",
"name": "Leads",
"records": 1,
"rules": [],
"view": "table"
}
],
"folders": [
{
"description": "",
"id": "215cddb8-818a-4451-b237-ae9a80a45f5d",
"name": "Specs",
"rules": []
}
],
"projects": [
{
"databases": [],
"description": "The Atlas launch.",
"folders": [],
"id": "fc2108b2-a7c2-43b4-b0ea-44c6e01a30a8",
"name": "Atlas",
"rules": [],
"status": "todo"
}
]
}
}Errors
- 401The API key is missing, unknown, expired or revoked. Error
- 403Not allowed: a read-only key, a view-only role, or an operation keys cannot do. Error
- 404Not found. Other Spaces also look absent to a key. Error
- 422Invalid fields, revision or payload. Error
- 503Temporarily unavailable or busy. Retry with backoff, honouring Retry-After. Error
Example request
curl "https://<api-host>/v1/spaces/{space_id}/map" \
-H "Authorization: Bearer $SPACE_API_KEY"