Read a file
Read a supported project file as content and metadata.
API 2.7.0 · Published service contract ↗
Request
Base URL: https://app.sym.so/v1/workspaces/{workspace_id}
Authentication: bearer. Required scope: files:read.
GET /agents/{agent_id}/files/content
Read a supported project file as content and metadata.
| Parameter | Type | Description |
|---|---|---|
agent_idpath · required | string | Authorized Agent ID. |
pathquery · required | string | Relative file path. |
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/files/content?path=$SYM_QUERY_PATH_URLENCODED" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"{
"worker_id": "worker-example-001",
"org_id": "workspace_example",
"file": {
"path": "notes/brief.md",
"content": "# Brief\n",
"encoding": "utf-8",
"size": 8,
"modified_at": "2026-08-04T09:00:00Z"
},
"ok": true
}Authorization
{
"type": "bearer",
"scope": "files:read",
"transport": "Authorization: Bearer <workspace_api_key>"
}Errors
| Status | Description |
|---|---|
| 401 | The workspace API key is missing, invalid, expired, or revoked. |
| 403 | The key lacks the required scope or its owner no longer has permission. |
| 404 | The resource is missing or intentionally hidden by authorization. |
| 429 | The key exceeded its current rate limit. |