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

Get Agent brief

Return one authorized Agent's safe state, recent chats and unread-chat count in one bounded response.

API 2.7.0 · Published service contract ↗

Request

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

Authentication: bearer. Required scope: agents:read.

GET /agents/{agent_id}/brief

Return one authorized Agent's safe state, recent chats and unread-chat count in one bounded response.

ParameterTypeDescription
agent_id
path · required
stringAuthorized Agent ID.
Request
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/brief" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "agent": {
    "id": "agent_example",
    "name": "Example Agent",
    "status": "active"
  },
  "recent_chats": [
    {
      "id": "chat_01J8",
      "title": "Competitor research",
      "status": "active",
      "unread_count": 0,
      "last_message_preview": "The report is ready."
    }
  ],
  "unread_chats": 0,
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "agents: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.

Usage notes