System Atlas
SystemAtlas

Get the mapping guide

The upload contract: parts of the business, primitives, parameters, flow types, limits and instructions.

GET/api/v1/workspaces/:slug/mapping-guideNeeds a key

Authentication

Authorization: Bearer sa_… (any valid key; reads also accept a signed-in browser session).

Parameters

Path

  • slugstringrequired

    Workspace slug

Query

  • companystringoptional

    Company slug; defaults to the workspace's own company

Request

curl "https://systematlas.org/api/v1/workspaces/acme-builders/mapping-guide" \
  -H "Authorization: Bearer sa_…"

Response

200 with the result in data (abbreviated here). Errors are listed in Errors and limits.

Response
{
  "data": {
    "company": {
      "slug": "client"
    },
    "parts": [
      {
        "key": "winning_work",
        "primitives": [
          {
            "key": "estimating"
          }
        ]
      }
    ],
    "limits": {
      "itemsPerCall": 200,
      "callsPerMinute": 30
    }
  }
}

Over MCP

The same call as an MCP tool: get_mapping_guide.

PreviousGet a research runNext Create your workspace