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

Create an Agent

Start creation of a real SYM-node profile, Hermes profile, Gateway, runtime, and initial chat.

API 2.7.0 · Published service contract ↗

Request

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

Authentication: bearer. Required scope: agents:create.

POST /agents

Start creation of a real SYM-node profile, Hermes profile, Gateway, runtime, and initial chat.

ParameterTypeDescription
name
body · required
stringDisplay name for the Agent.
Request
curl --fail-with-body -X POST "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  --data "{\"name\":\"Research Agent\"}"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "item": {
    "profile_id": "research-agent",
    "display_name": "Research Agent",
    "status": "active"
  },
  "created": true,
  "chat_id": "chat_research-agent_main",
  "ok": true
}

Authorization

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

Errors

StatusDescription
400The request body or parameters are invalid.
401The workspace API key is missing, invalid, expired, or revoked.
403The key lacks the required scope or its owner no longer has permission.
429The key exceeded its current rate limit.

Usage notes