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

Delete an Agent

Delete an Agent through the same guarded lifecycle used by Workspace Settings.

API 2.7.0 · Published service contract ↗

Request

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

Authentication: bearer. Required scope: agents:delete.

DELETE /agents/{agent_id}

Delete an Agent through the same guarded lifecycle used by Workspace Settings.

ParameterTypeDescription
agent_id
path · required
stringStable Agent ID.
Request
curl --fail-with-body -X DELETE "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "deleted": true,
  "profile_id": "research-agent",
  "ok": true
}

Authorization

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