> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gloo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

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.

```bash theme={null}
curl "https://platform.ai.gloo.com/..." \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

<Info>
  Follow the [Authentication Tutorial](/tutorials/authentication) to learn how to exchange your Client credentials for an access token and manage token expiration.
</Info>

***

## Gloo AI Service Map & Routing Table

| Service Category            | Primary Base URL Path                        | Current Version | Authentication     | Description / Use Case                                                                                                                                               |
| :-------------------------- | :------------------------------------------- | :-------------- | :----------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Responses** (recommended) | `https://platform.ai.gloo.com/ai/v1/`        | **v1**          | Required (Bearer)  | OpenAI-compatible Responses API — text, vision, image generation, and tool use. The recommended surface for new integrations.                                        |
| **Completions**             | `https://platform.ai.gloo.com/ai/v2/`        | **v2**          | Required (Bearer)  | Fully supported and backwards-compatible. Adds intelligent auto-routing, `model_family` selection, values-aligned (`tradition`) responses, and grounded completions. |
| **Search & Recs**           | `https://platform.ai.gloo.com/ai/v1/data/`   | **v1**          | Required (Bearer)  | Semantic search and item/affiliate recommendations.                                                                                                                  |
| **Model Catalog**           | `https://platform.ai.gloo.com/platform/v2/`  | **v2**          | **None**           | Public endpoint to list available models, pricing, and context windows.                                                                                              |
| **Content Controls**        | `https://platform.ai.gloo.com/engine/v2/`    | **v2**          | Required (Bearer)  | Data Engine operations: patch, delete, and metadata management.                                                                                                      |
| **Ingestion**               | `https://platform.ai.gloo.com/ingestion/v2/` | **v2**          | Required (Bearer)  | High-volume file and real-time data uploads.                                                                                                                         |
| **OAuth2 Auth**             | `https://platform.ai.gloo.com/oauth2/token`  | N/A             | Client Credentials | Token exchange endpoint for all authenticated requests.                                                                                                              |

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

***

## Download OpenAPI Specs

<CardGroup cols={2}>
  <Card title="Active Endpoints" icon="download" href="/openapi/openapi.json">
    Recommended for integrations. Includes active endpoints only.
  </Card>

  <Card title="All Endpoints" icon="code" href="/openapi/openapi.full.json">
    Includes active and deprecated endpoints used by the docs.
  </Card>
</CardGroup>

***

## 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**](/api-reference/general/errors).

***

## Getting Started: Your First Steps

Ready to build? Here’s how to get started:

1. **Get Your API Key:** Follow the [authentication guide](/studio/manage-api-credentials) to generate your first key in the Studio.
2. **Review the Guides:** Familiarize yourself with our core [API Guides](/api-guides/overview) to understand the conceptual models.
3. **Make Your First Call:** Explore the endpoints listed in the sidebar and make your first request!