Skip to main content
Welcome to the Gloo AI API! This reference documentation will help you build powerful applications by integrating directly with our platform’s core capabilities, from conversational AI to content management. Our API is built on standard REST principles, uses predictable resource-oriented URLs, and returns JSON-encoded responses.

​
Authentication

Most Gloo AI API endpoints require authentication using Bearer Tokens obtained through the OAuth2 client credentials flow. Endpoints that do not require authentication are explicitly labeled in the reference. For authenticated requests, include your token in the Authorization header.
Follow the Authentication Tutorial to learn how to exchange your Client credentials for an access token and manage token expiration.

​
Gloo AI Service Map & Routing Table

Most endpoints require a bearer token obtained via OAuth2 client credentials. Endpoints that do not require auth are explicitly labeled.

​
Download OpenAPI Specs

Active Endpoints

Recommended for integrations. Includes active endpoints only.

All Endpoints

Includes active and deprecated endpoints used by the docs.

​
Error Handling

The Gloo AI API uses conventional HTTP response codes to indicate the success or failure of a request.
  • Codes in the 2xx range indicate success.
  • Codes in the 4xx range indicate a client-side error (e.g., a missing parameter, bad authentication).
  • Codes in the 5xx range indicate a server-side error on our end.
For a detailed list of all possible error codes and their meanings, please see our API Errors Guide.

​
Getting Started: Your First Steps

Ready to build? Here’s how to get started:
  1. Get Your API Key: Follow the authentication guide to generate your first key in the Studio.
  2. Review the Guides: Familiarize yourself with our core API Guides to understand the conceptual models.
  3. Make Your First Call: Explore the endpoints listed in the sidebar and make your first request!