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

Set or remove app secrets

Set or remove manifest-declared write-only secrets for one installed Agent app, then restart the Agent gateway environment. Workspace owner/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: secrets:write.

POST /agents/{agent_id}/apps/{app_id}/secrets

Set or remove manifest-declared write-only secrets for one installed Agent app, then restart the Agent gateway environment. Workspace owner/admin permission is required.

ParameterTypeDescription
agent_id
path · required
stringRequired agent_id path identifier.
app_id
path · required
stringRequired app_id path identifier.
Request
curl --fail-with-body -X POST "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/apps/$APP_ID/secrets" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  --data "{\"values\":{\"EXAMPLE_SERVICE_TOKEN\":\"<secret supplied at runtime>\"},\"unset\":[]}"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "data": {
    "profile_id": "agent_example",
    "app_id": "research-console",
    "declared_count": 1,
    "configured_count": 1,
    "missing_required": [],
    "secrets": [
      {
        "name": "EXAMPLE_SERVICE_TOKEN",
        "description": "Example provider access token",
        "required": true,
        "configured": true
      }
    ],
    "gateway_restart": {
      "ok": true,
      "service": "hermes-gateway-agent_example"
    }
  },
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "secrets: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.
404The resource is missing or intentionally hidden by authorization.
429The key exceeded its current rate limit.

Usage notes