Update Agent soul
Replace the authorized Agent identity markdown with optimistic revision checking. Workspace admin permission is required.
API 2.7.0 · Published service contract ↗
Request
Base URL: https://app.sym.so/v1/workspaces/{workspace_id}
Authentication: bearer. Required scope: instructions:write.
PUT /agents/{agent_id}/soul
Replace the authorized Agent identity markdown with optimistic revision checking. Workspace admin permission is required.
| Parameter | Type | Description |
|---|---|---|
agent_idpath · required | string | Required agent_id path identifier. |
curl --fail-with-body -X PUT "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/soul" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
-H "Content-Type: application/json" \
--data "{\"markdown\":\"Be concise, analytical, and evidence-driven.\",\"expected_revision\":4,\"reason\":\"Clarify research behavior\"}"{
"worker_id": "worker-example-001",
"org_id": "workspace_example",
"item": {
"scope_type": "profile",
"scope_id": "agent_example",
"markdown": "Be concise, analytical, and evidence-driven.",
"revision": 5,
"content_hash": "c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef012",
"can_manage": true,
"applies_to": "new_conversations"
},
"profile_id": "agent_example",
"applies_to": "new_conversations",
"ok": true
}Authorization
{
"type": "bearer",
"scope": "instructions:write",
"transport": "Authorization: Bearer <workspace_api_key>"
}Errors
| Status | Description |
|---|---|
| 400 | The request body or parameters are invalid. |
| 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. |
| 409 | The supplied expected_revision is stale. |
| 429 | The key exceeded its current rate limit. |