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

Create an API key

Create a user-bound key for this workspace. The raw secret is returned exactly once.

API 2.7.0 · Published service contract ↗

Request

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

Authentication: bearer. Required scope: api_keys:write.

POST /api-keys

Create a user-bound key for this workspace. The raw secret is returned exactly once.

ParameterTypeDescription
name
body · required
stringHuman-readable key name.
scopes
body · required
string[]Requested API scopes, capped by the user's permissions.
expires_at
body
ISO timestamp | nullOptional expiry.
Request
curl --fail-with-body -X POST "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/api-keys" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  --data "{\"name\":\"Local integration\",\"scopes\":[\"agents:read\",\"files:read\",\"files:write\",\"chats:read\",\"messages:read\",\"messages:send\"],\"expires_at\":null}"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "item": {
    "id": "key_01J8",
    "name": "Local integration",
    "scopes": [
      "agents:read",
      "files:read",
      "files:write",
      "chats:read",
      "messages:read",
      "messages:send"
    ]
  },
  "key": "sym_ws_x7K2...9Qpf",
  "reveal_once": true,
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "api_keys: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.
429The key exceeded its current rate limit.

Usage notes