SymDocs
Workspace API
All productsSym Workspace APISym Passes MCP
Supportjoinsym.com ↗
Sym Workspace API

Get Agent soul

Read the authorized Agent identity layer together with safe effective-instruction metadata.

API 2.7.0 · Published service contract ↗

Request

Base URL: https://app.sym.so/v1/workspaces/{workspace_id}

Authentication: bearer. Required scope: instructions:read.

GET /agents/{agent_id}/soul

Read the authorized Agent identity layer together with safe effective-instruction metadata.

ParameterTypeDescription
agent_id
path · required
stringRequired agent_id path identifier.
Request
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/soul" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "item": {
    "scope_type": "profile",
    "scope_id": "agent_example",
    "markdown": "Be concise, analytical, and evidence-driven.",
    "revision": 4,
    "content_hash": "f5a4c1e2d3b60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0",
    "can_manage": true,
    "applies_to": "new_conversations"
  },
  "constitution": {
    "version": "1",
    "content_hash": "a1b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0",
    "managed": true
  },
  "workspace": {
    "revision": 7,
    "content_hash": "b2c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef01"
  },
  "effective_order": [
    {
      "layer": "platform_foundation",
      "managed": true
    },
    {
      "layer": "workspace_instructions",
      "managed": false,
      "revision": 7
    },
    {
      "layer": "profile_identity",
      "managed": false,
      "revision": 4
    }
  ],
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "instructions:read",
  "transport": "Authorization: Bearer <workspace_api_key>"
}

Errors

StatusDescription
401The workspace API key is missing, invalid, expired, or revoked.
403The key lacks the required scope or its owner no longer has permission.
404The resource is missing or intentionally hidden by authorization.
429The key exceeded its current rate limit.