Assistant

List Assistant Tools

What Oro can do, by area of the app (RO-322): each tool with its route, whether it reads or writes (writes run only after the user confirms) and the scope the same route needs with an API key; plus the human-only actions Oro never does (sending, dialling, starting campaigns, approving drafts, team and workspace deletion, roles, billing) with the page that does them. Signed-in users only (API keys: 403).

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.
GET/api/v1/assistant/tools
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/assistant/tools" \  -H "X-Workspace-Id: string"
{
  "groups": [
    {
      "key": "string",
      "label": "string",
      "tools": [
        {
          "name": "string",
          "title": "string",
          "effect": "read",
          "needs_confirmation": true,
          "scope": "string",
          "method": "string",
          "path": "string"
        }
      ]
    }
  ],
  "human_only": [
    {
      "key": "string",
      "label": "string",
      "reason": "string",
      "href": "string"
    }
  ],
  "bulk_max": 0
}