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 an API key. Endpoints that do not require authentication are explicitly labeled in the reference. For authenticated requests, include your API key in the Authorization header.
Follow the Authentication Tutorial to learn how to create and use your API key.

​
Gloo AI Service Map & Routing Table

Most endpoints require an API key sent as a Bearer token (Authorization: Bearer YOUR_API_KEY). Endpoints that do not require auth are explicitly labeled. API keys are the default and recommended way to authenticate; see the Authentication tutorial.
Legacy: OAuth2 client credentials. The /oauth2/token exchange (Client ID and Secret for a one-hour access token) is deprecated but still works for existing integrations. Create an API key and send it directly as the Bearer value to migrate. See Legacy: client credentials and OAuth.
Not sure which generation endpoint to use? See Endpoint types for how guarded, direct, and grounded endpoints differ.

​
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!