Authentication
Use the credential type required by the operation.
API 2.7.0 · Published service contract ↗
Workspace API keys
Send Authorization: Bearer <workspace-api-key> to https://app.sym.so/v1/workspaces/{workspace_id}. A key authorizes only its workspace and its granted scopes; it does not bypass the owner’s current membership or Agent access.
Account API keys
Create an account key in Account Settings for your own apps and Passes. Account endpoints use https://app.sym.so/v1/account, not a workspace URL. An account key does not grant workspace access.
Conversation Pass delegation
Operations that combine a workspace conversation and a personal Pass require the workspace bearer plus X-Sym-Account-Authorization containing the account bearer. Both credentials must belong to the same owner and have the required scopes.
Scopes
[
"browser_passes:read",
"browser_passes:write",
"workspace:read",
"machine:read",
"api_keys:read",
"api_keys:write",
"agents:read",
"agents:create",
"agents:write",
"agents:delete",
"files:read",
"files:write",
"chats:read",
"chats:write",
"messages:read",
"messages:send",
"operations:read",
"operations:cancel",
"webhooks:read",
"webhooks:write",
"schedules:read",
"instructions:read",
"instructions:write",
"settings:read",
"settings:write",
"apps:read",
"apps:write",
"secrets:read",
"secrets:write",
"connections:read",
"connections:write",
"search:read"
]Do not put API keys in URLs, browser scripts, screenshots or public repositories. Revoke a key if it is exposed.