Quickstart
Make your first read-only request to an existing workspace.
API 2.7.0 · Published service contract ↗
Choose your workspace
Sign in to Sym and open the workspace you can access. Copy its workspace ID; a workspace name is not an API identifier.
Create a scoped API key
Use the workspace API-key controls to create a key with agents:read. Keep it on your server, not in frontend JavaScript.
List available Agents
Set WORKSPACE_ID and SYM_WORKSPACE_API_KEY in your local environment, then run the example below.
Your first request
curl --fail-with-body "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents?limit=20" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"const response = await fetch(`https://app.sym.so/v1/workspaces/${process.env.WORKSPACE_ID}/agents?limit=20`, {
headers: { Authorization: `Bearer ${process.env.SYM_WORKSPACE_API_KEY}` }
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data.items);import os, requests
response = requests.get(
f"https://app.sym.so/v1/workspaces/{os.environ['WORKSPACE_ID']}/agents",
headers={"Authorization": f"Bearer {os.environ['SYM_WORKSPACE_API_KEY']}"},
params={"limit": 20}, timeout=30,
)
response.raise_for_status()
print(response.json()["items"])The response lists only Agents you can currently access. Workspace membership, Agent access and key scopes are checked on every operation.
Next steps
Authentication
Workspace keys, account keys and delegated Pass access.
List Agents
Parameters, returned fields and error responses.
Errors and pagination
Handle limits, continuation and uncertain outcomes.