API reference / Space guide

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)Required
  • organization_idstring (uuid)Required
  • kindstringRequired

    One of personal, team

  • rolestringRequired

    One of owner, admin, member, viewer

  • visibilitystringRequired
  • is_defaultbooleanRequired
  • namestringRequired
  • tasks_collection_idstring (uuid)Required
  • mcp_urlstringRequired

    The agent (MCP) endpoint. The REST API shares its origin.

  • agent_idstring (uuid) or nullRequired

    Always null for an API key.

  • space_mapobjectRequired
    1 field in space_map
    • toolstringRequired
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

  • 401The API key is missing, unknown, expired or revoked. 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/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

  • versionstringRequired

    Opaque. 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_bytesintegerRequired
  • itemsintegerRequired
  • storage_limit_bytesintegerRequired
  • item_limitintegerRequired
  • model_requestsintegerRequired

    Model requests used this calendar month (UTC).

  • model_request_limitintegerRequired
  • resets_atstring (date-time) or nullRequired
  • planobject or nullRequired
    3 fields in plan
    • planstringRequired
    • statusstringRequired
    • {key}any

      Any 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

  • daysinteger

    Default 30

  • all_periodsboolean

    Default false

Responses

200Success

  • space_idstring (uuid)Required
  • daysintegerRequired

    One of 7, 30, 90

  • as_ofstring (date-time)Required
  • period_startstring (date-time)Required
  • tracking_started_atstring (date-time)Required
  • totalsobjectRequired
    5 fields in totals
    • documentsintegerRequired
    • tasksintegerRequired
    • memoriesintegerRequired
    • document_linesintegerRequired
    • measured_documentsintegerRequired
  • summaryobjectRequired
    11 fields in summary
    • document_writesintegerRequired
    • documents_createdintegerRequired
    • memories_createdintegerRequired
    • memory_writesintegerRequired
    • retrievalsintegerRequired
    • with_resultsintegerRequired
    • emptyintegerRequired
    • errorsintegerRequired
    • p50_msnumber or nullRequired
    • p95_msnumber or nullRequired
    • reused_memoriesintegerRequired
  • activityarray of objectRequired
    5 fields in activity
    • datestringRequired

      A UTC calendar date, YYYY-MM-DD.

    • availablebooleanRequired

      False before activity tracking started.

    • document_writesinteger or nullRequired
    • memories_createdinteger or nullRequired
    • retrievalsinteger or nullRequired
  • agentsarray of objectRequired
    13 fields in agents
    • document_writesintegerRequired
    • documents_createdintegerRequired
    • memories_createdintegerRequired
    • memory_writesintegerRequired
    • retrievalsintegerRequired
    • with_resultsintegerRequired
    • emptyintegerRequired
    • errorsintegerRequired
    • p50_msnumber or nullRequired
    • p95_msnumber or nullRequired
    • agent_idstring (uuid) or nullRequired
    • actor_typestringRequired
    • last_active_atstring (date-time)Required
  • strategiesarray of objectRequired
    11 fields in strategies
    • document_writesintegerRequired
    • documents_createdintegerRequired
    • memories_createdintegerRequired
    • memory_writesintegerRequired
    • retrievalsintegerRequired
    • with_resultsintegerRequired
    • emptyintegerRequired
    • errorsintegerRequired
    • p50_msnumber or nullRequired
    • p95_msnumber or nullRequired
    • strategystringRequired
  • recentarray of objectRequired
    11 fields in recent
    • idstring (uuid)Required
    • created_atstring (date-time)Required
    • agent_idstring (uuid) or nullRequired
    • actor_typestringRequired
    • kindstringRequired
    • resource_idstring (uuid) or nullRequired
    • new_itemsintegerRequired
    • item_countintegerRequired
    • outcomestringRequired
    • duration_msnumber or nullRequired
    • resource_existsbooleanRequired
  • usageobjectRequired
    8 fields in usage
    • retained_bytesintegerRequired
    • itemsintegerRequired
    • storage_limit_bytesintegerRequired
    • item_limitintegerRequired
    • model_requestsintegerRequired

      Model requests used this calendar month (UTC).

    • model_request_limitintegerRequired
    • resets_atstring (date-time) or nullRequired
    • planobject or nullRequired
      3 fields in plan
      • planstringRequired
      • statusstringRequired
      • {key}any

        Any other key.

  • periodsobject or null

    With all_periods=true: the 7, 30 and 90 day windows.

    1 field in periods
    • {key}object

      Any other key.

      4 fields in {key}
      • period_startstring (date-time)Required
      • summaryobjectRequired
        11 fields in summary
        • document_writesintegerRequired
        • documents_createdintegerRequired
        • memories_createdintegerRequired
        • memory_writesintegerRequired
        • retrievalsintegerRequired
        • with_resultsintegerRequired
        • emptyintegerRequired
        • errorsintegerRequired
        • p50_msnumber or nullRequired
        • p95_msnumber or nullRequired
        • reused_memoriesintegerRequired
      • agentsarray of objectRequired
        13 fields in agents
        • document_writesintegerRequired
        • documents_createdintegerRequired
        • memories_createdintegerRequired
        • memory_writesintegerRequired
        • retrievalsintegerRequired
        • with_resultsintegerRequired
        • emptyintegerRequired
        • errorsintegerRequired
        • p50_msnumber or nullRequired
        • p95_msnumber or nullRequired
        • agent_idstring (uuid) or nullRequired
        • actor_typestringRequired
        • last_active_atstring (date-time)Required
      • strategiesarray of objectRequired
        11 fields in strategies
        • document_writesintegerRequired
        • documents_createdintegerRequired
        • memories_createdintegerRequired
        • memory_writesintegerRequired
        • retrievalsintegerRequired
        • with_resultsintegerRequired
        • emptyintegerRequired
        • errorsintegerRequired
        • p50_msnumber or nullRequired
        • p95_msnumber or nullRequired
        • strategystringRequired
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_charsinteger

    Default 12000

Responses

200Success

  • spaceobjectRequired
    2 fields in space
    • idstring (uuid)Required
    • namestringRequired
  • global_rulesarray of objectRequired
    6 fields in global_rules
    • textstringRequired
    • entry_idstring (uuid)Required
    • memory_idstring (uuid)Required
    • revisionintegerRequired
    • originstringRequired

      One of explicit, inferred

    • stalebooleanRequired
  • sectionsarray of objectRequired
    7 fields in sections
    • idstring (uuid)Required
    • namestringRequired
    • descriptionstringRequired
    • rulesarray of objectRequired
      6 fields in rules
      • textstringRequired
      • entry_idstring (uuid)Required
      • memory_idstring (uuid)Required
      • revisionintegerRequired
      • originstringRequired

        One of explicit, inferred

      • stalebooleanRequired
    • projectsarray of objectRequired
      7 fields in projects
      • idstring (uuid)Required
      • namestringRequired
      • descriptionstringRequired
      • statusstringRequired
      • rulesarray of objectRequired
        6 fields in rules
        • textstringRequired
        • entry_idstring (uuid)Required
        • memory_idstring (uuid)Required
        • revisionintegerRequired
        • originstringRequired

          One of explicit, inferred

        • stalebooleanRequired
      • foldersarray of objectRequired
        4 fields in folders
        • idstring (uuid)Required
        • namestringRequired
        • descriptionstringRequired
        • rulesarray of objectRequired
          6 fields in rules
          • textstringRequired
          • entry_idstring (uuid)Required
          • memory_idstring (uuid)Required
          • revisionintegerRequired
          • originstringRequired

            One of explicit, inferred

          • stalebooleanRequired
      • databasesarray of objectRequired
        8 fields in databases
        • idstring (uuid)Required
        • namestringRequired
        • descriptionstringRequired
        • recordsintegerRequired
        • fieldsarray of object or null

          Omitted when the map is shortened to fit max_chars.

          2 fields in fields
          • namestringRequired
          • typestringRequired
        • viewstringRequired
        • group_bystring or nullRequired
        • rulesarray of objectRequired
          6 fields in rules
          • textstringRequired
          • entry_idstring (uuid)Required
          • memory_idstring (uuid)Required
          • revisionintegerRequired
          • originstringRequired

            One of explicit, inferred

          • stalebooleanRequired
    • foldersarray of objectRequired
      4 fields in folders
      • idstring (uuid)Required
      • namestringRequired
      • descriptionstringRequired
      • rulesarray of objectRequired
        6 fields in rules
        • textstringRequired
        • entry_idstring (uuid)Required
        • memory_idstring (uuid)Required
        • revisionintegerRequired
        • originstringRequired

          One of explicit, inferred

        • stalebooleanRequired
    • databasesarray of objectRequired
      8 fields in databases
      • idstring (uuid)Required
      • namestringRequired
      • descriptionstringRequired
      • recordsintegerRequired
      • fieldsarray of object or null

        Omitted when the map is shortened to fit max_chars.

        2 fields in fields
        • namestringRequired
        • typestringRequired
      • viewstringRequired
      • group_bystring or nullRequired
      • rulesarray of objectRequired
        6 fields in rules
        • textstringRequired
        • entry_idstring (uuid)Required
        • memory_idstring (uuid)Required
        • revisionintegerRequired
        • originstringRequired

          One of explicit, inferred

        • stalebooleanRequired
  • unsectionedobjectRequired
    3 fields in unsectioned
    • projectsarray of objectRequired
      7 fields in projects
      • idstring (uuid)Required
      • namestringRequired
      • descriptionstringRequired
      • statusstringRequired
      • rulesarray of objectRequired
        6 fields in rules
        • textstringRequired
        • entry_idstring (uuid)Required
        • memory_idstring (uuid)Required
        • revisionintegerRequired
        • originstringRequired

          One of explicit, inferred

        • stalebooleanRequired
      • foldersarray of objectRequired
        4 fields in folders
        • idstring (uuid)Required
        • namestringRequired
        • descriptionstringRequired
        • rulesarray of objectRequired
          6 fields in rules
          • textstringRequired
          • entry_idstring (uuid)Required
          • memory_idstring (uuid)Required
          • revisionintegerRequired
          • originstringRequired

            One of explicit, inferred

          • stalebooleanRequired
      • databasesarray of objectRequired
        8 fields in databases
        • idstring (uuid)Required
        • namestringRequired
        • descriptionstringRequired
        • recordsintegerRequired
        • fieldsarray of object or null

          Omitted when the map is shortened to fit max_chars.

          2 fields in fields
          • namestringRequired
          • typestringRequired
        • viewstringRequired
        • group_bystring or nullRequired
        • rulesarray of objectRequired
          6 fields in rules
          • textstringRequired
          • entry_idstring (uuid)Required
          • memory_idstring (uuid)Required
          • revisionintegerRequired
          • originstringRequired

            One of explicit, inferred

          • stalebooleanRequired
    • foldersarray of objectRequired
      4 fields in folders
      • idstring (uuid)Required
      • namestringRequired
      • descriptionstringRequired
      • rulesarray of objectRequired
        6 fields in rules
        • textstringRequired
        • entry_idstring (uuid)Required
        • memory_idstring (uuid)Required
        • revisionintegerRequired
        • originstringRequired

          One of explicit, inferred

        • stalebooleanRequired
    • databasesarray of objectRequired
      8 fields in databases
      • idstring (uuid)Required
      • namestringRequired
      • descriptionstringRequired
      • recordsintegerRequired
      • fieldsarray of object or null

        Omitted when the map is shortened to fit max_chars.

        2 fields in fields
        • namestringRequired
        • typestringRequired
      • viewstringRequired
      • group_bystring or nullRequired
      • rulesarray of objectRequired
        6 fields in rules
        • textstringRequired
        • entry_idstring (uuid)Required
        • memory_idstring (uuid)Required
        • revisionintegerRequired
        • originstringRequired

          One of explicit, inferred

        • stalebooleanRequired
  • categoriesarray of objectRequired
    3 fields in categories
    • idstring (uuid)Required
    • namestringRequired
    • descriptionstringRequired
  • task_statusesarray of objectRequired
    2 fields in task_statuses
    • valuestringRequired

      The status value stored on tasks, such as in_progress.

    • labelstringRequired
  • truncatedbooleanRequired

    True 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"