Platform API Quickstart

The Platform API is Glean's recommended API for new application integrations when the capability and stability level fit the use case. It provides modern endpoints under the /api path. Review the applicable stability notices before adopting a capability or endpoint.

Before you begin

1

Find your API URL

If automatic discovery is unavailable, ask a Glean admin for the complete Server instance (QE) value. Glean admins can copy it from the About Glean page.

2

Configure authentication

Review the Platform API authentication guide and choose the credentials for your integration.

3

Choose a capability

Start with the capability that matches your application: Search, Agents, Skills, or Chat.

Choose Platform API over Client API

Use Platform API for new integrations whenever the capability you need is available. Use Client API when you need an existing Client API capability that has not yet moved to Platform API or when maintaining an existing integration.

Make your first request

The example below uses the Search API. Review the endpoint's stability notice before using it in production.

The Platform API uses a bearer credential and JSON requests. A typical request looks like this:

curl -X POST 'https://<instance>-be.glean.com/api/search' \
  -H 'Authorization: Bearer <platform_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "quarterly planning"
  }'

See the Search API reference for the complete request and response model.

Next steps

Authenticate

Configure one of the supported Platform API bearer-token methods.

Search

Build permission-aware search experiences over connected content.

Run agents

Discover agents and create agent runs.