Skip to main content

Tools API

The Tools API enables you to discover and execute various tools and integrations available within your Glean instance. Access external services, run automated workflows, and integrate with third-party applications to extend Glean's capabilities.

Use Cases

Tool Discovery

Discover available tools and integrations within your Glean instance to understand what capabilities are accessible through the API.

Workflow Automation

Execute tools programmatically to automate workflows, data processing, and integration tasks with external systems.

Third-party Integration

Integrate with external services and applications through Glean's tool ecosystem to create comprehensive business solutions.

API Endpoints

MethodEndpointPurpose
GET/rest/api/v1/actions/{actionPackId}/authGet end-user authentication status for an action pack.
Reports whether the calling user is already authenticated against the third-party tool backing the specified action pack. Intended for headless / server-driven clients that render an "Authorize" prompt when the user has not yet consented to the tool.
POST/rest/api/v1/actions/{actionPackId}/authStart the OAuth authorization flow for an action pack.
Starts the third-party OAuth flow for the specified action pack and returns the redirect URL that the client should navigate the end user to. After the OAuth callback completes, the user's browser is redirected back to `returnUrl` with a status query parameter (`?glean_action_auth=success|error&actionPackId=...`). `returnUrl` must match the tenant's configured return URL allowlist; otherwise the request is rejected with 400.
POST/rest/api/v1/tools/callExecute the specified tool
Execute the specified tool with provided parameters
GET/rest/api/v1/tools/listList available tools
Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned.