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

Get machine information

Return safe identity and capability information for the SYM-node machine serving this workspace without exposing host credentials or private network configuration.

API 2.7.0 · Published service contract ↗

Request

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

Authentication: bearer. Required scope: machine:read.

GET /machine

Return safe identity and capability information for the SYM-node machine serving this workspace without exposing host credentials or private network configuration.

Request
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/machine" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "machine": {
    "id": "worker-example-001",
    "name": "Example Workspace",
    "platform": "linux",
    "architecture": "x86_64",
    "uptime_seconds": 184320,
    "sym_node_version": "0.1.45-alpha",
    "status": "online",
    "capabilities": [
      "agents",
      "files",
      "chats",
      "messages"
    ]
  },
  "ok": true
}

Authorization

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

Usage notes