Agents API

The Agents API lets you discover Glean agents, inspect their input and output schemas, and execute agent runs. Use it to embed Glean's agentic capabilities directly into your own applications and workflows.

Use Cases

Agent Discovery

Search for agents available to the authenticated user and retrieve their configuration to decide which agent to invoke.

Schema Inspection

Fetch an agent’s input and output schemas so you can build type-safe integrations and validate payloads before invoking a run.

Agent Execution

Create agent runs to execute Glean agents programmatically, then check their status, respond to approval requests, or cancel them.

API Endpoints

Method	Endpoint	Purpose
POST	/api/agents/search	Search agents
GET	/api/agents/{agent_id}	Get agent
GET	/api/agents/{agent_id}/schemas	Get agent schemas
POST	/api/agents/{agent_id}/runs	Create agent run
GET	/api/agents/{agent_id}/runs/{run_id}	Get agent run
POST	/api/agents/{agent_id}/cancellations	Cancel an agent run
POST	/api/agents/{agent_id}/responses	Respond to agent run approvals
GET	/api/admin/agents	List all agents

GET /api/admin/agents lists every agent in the workspace, including private and disabled agents. It is experimental. Send X-Glean-Include-Experimental: true on each request, or it is not exposed.

For per-user integrations, authenticate with OAuth. The Platform API authentication guide covers the Glean OAuth Authorization Server and external-IdP options. Use a Glean-issued token for global permissions with X-Glean-ActAs, or when no OAuth path exists.

For error responses, see Platform API Errors for the shared ProblemDetail code reference and remediation guidance.