> For the complete documentation index, see [llms.txt](https://docs.minchat.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.minchat.io/rest-apis/overview.md).

# Overview

The Chat Platform API allows you to interact directly with data resources related to your application's chat activities. It uses standard HTTP protocols, with JSON payloads returned in response to requests, and is based on RESTful principles. This API offers more flexibility and added functionality compared to the native SDKs, which handle many requests and responses on the client side.

## Base URL

MinChat API calls are made to the following URL:

```http
https://api.minchat.io
```

### Headers

A typical HTTP request to the Chat API includes the following headers:

```http
Authorization: Bearer YOUR_API_KEY
```

The API Key can be found on the [Minchat dashboard.](https://minchat.io/sdk)

All of your API requests must be made over HTTPS. Plain HTTP calls will fail. API requests without the API Key will also fail.

## Response Codes

The MinChat API uses standard HTTP status codes to indicate the success or failure of API calls.

<table data-header-hidden><thead><tr><th width="116.5"></th><th></th></tr></thead><tbody><tr><td><strong>200</strong></td><td>API call was successful.</td></tr><tr><td><strong>400</strong></td><td>You've made an error in your request. See the message field in the response for details.</td></tr><tr><td><strong>401</strong></td><td>The authentication credentials provided were incorrect. (i.e invalid API Key).</td></tr><tr><td><strong>404</strong></td><td>Unknown API end point.</td></tr><tr><td><strong>500</strong></td><td>A temporary internal server error.</td></tr></tbody></table>

## API Endpoints

View All the API Endpoints [here](https://api.minchat.io/docs).

<https://api.minchat.io/docs>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.minchat.io/rest-apis/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.