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

Create a chat

Create a durable Agent chat, optionally with an initial user message. This creates a chat record; it does not restart the Agent Gateway or guarantee a fresh profile runtime.

API 2.7.0 · Published service contract ↗

Request

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

Authentication: bearer. Required scope: chats:write.

POST /agents/{agent_id}/chats

Create a durable Agent chat, optionally with an initial user message. This creates a chat record; it does not restart the Agent Gateway or guarantee a fresh profile runtime.

ParameterTypeDescription
agent_id
path · required
stringAgent that owns the new chat.
Request
curl --fail-with-body -X POST "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/chats" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  --data "{\"title\":\"Research competitors\",\"initial_message\":\"Find the five closest competitors.\"}"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "chat": {
    "id": "chat_01J9",
    "agent_id": "agent_example",
    "title": "Research competitors",
    "status": "queued"
  },
  "message": {
    "id": "msg_01J9",
    "status": "queued"
  },
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "chats:write",
  "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.
404The resource is missing or intentionally hidden by authorization.
429The key exceeded its current rate limit.