Glean provides two REST APIs for interacting with the platform. Our developer documentation provides detailed implementation instructions. This guide offers an introduction to Glean’s REST APIs and serves as a general reference.

​
API Types

Client API

The Client API enables implementation of a custom client interface to interact with the Glean system. This API allows you to build custom interfaces and integrate Glean’s functionality into your applications.

Indexing API

The Indexing API (also known as the Push API) is used to upload documents to Glean. This API enables you to programmatically manage document indexing and content integration with the Glean platform.

​
API Tokens

Different types of tokens are available depending on your integration needs:
​
Indexing Token
object
required
These tokens are specifically designed for indexing documents from internal tools or apps that Glean does not natively support. They are used with the Indexing REST API to send documents to Glean via HTTP requests.Features:
  • Configurable token rotation period in minutes
  • IP range restrictions for requests
  • Data source-specific or global permissions
  • Configurable expiry date
​
Client Token
object
required
These tokens are utilized for making API calls to Glean’s Client API. They can be scoped either to a single user or globally, allowing the caller to act as multiple users.Features:
  • Configurable scopes for specific request types (e.g., Chat, Answers, Search)
  • Permissions can be set to self, another user, or global (if Super Admin)
  • Configurable expiry date
​
Authentication Token API Key
object
required
These tokens are used to create authentication tokens on behalf of any user.Features:
  • Only one authentication key can be active at a time

​
Additional Resources

API Troubleshooting Guide

Access our comprehensive guide for troubleshooting common REST API issues and solutions.