> For the complete documentation index, see [llms.txt](https://docs.mindee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mindee.com/v1/platform-ui-tour/api-documentation.md).

# Documentation

<figure><img src="https://126655343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2al1MDqAP9Dg9iDRjkWg%2Fuploads%2Fgit-blob-cc942790e5062f954ba6ddd2434a08f625709dce%2Fa9f292bdcc2f721ffc413625cf6a829d48b53e443df2f8a5f9121bc5ad531dbb-image.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

Whether it's an [off-the-shelf](/v1/off-the-shelf-products/what-is-off-the-shelf-api.md) API from the API Store or a custom-built API, you can access the specific documentation to help you test and integrate easily. The documentation has different sections which are:

* API Reference
* Response scheme
* Limitations
* Open API

## API Reference

<figure><img src="https://126655343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2al1MDqAP9Dg9iDRjkWg%2Fuploads%2Fgit-blob-926868b4c4ff6c3105bccdfa97843c9e230259b3%2F40461a96769fe2e0eb16030081361de047632b7c397ca2213922b1a4ae2a0a10-image.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

**From the API reference section you can view:**

* HTTP Request
* Sample code

### HTTP Request

This contains all the main information you need to make a request to your API, such as base URL, Content-type, Authentication headers, and form data.

### Synchronous / Asynchronous

Some products like [Financial Documents](/v1/off-the-shelf-products/financial-documents-ocr.md) propose both a synchronous and an asynchronous endpoint. You can select the corresponding documentation by clicking on the toggle button on the top right hand corner.

### Sample Code

<figure><img src="https://126655343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2al1MDqAP9Dg9iDRjkWg%2Fuploads%2Fgit-blob-49ca634ff44d89478143913b15a6570b8eafeba1%2F424a9f3-expense-reciept-sample-code.png?alt=media" alt="Mindee Sample code located under the API reference tab on the right" width="563"><figcaption></figcaption></figure>

Sample code in several languages and command line tools are provided by Mindee, and they are ready to use by simply copying and pasting them into your coding environments, applications, or command line tools. To make use of this:

1. On the left side of the screen, click on **Documentation**.
2. Under the **API Reference** tab, you'll find the **Sample code** section in a number of popular languages or command line tool. Select according to your desired needs.
3. Select the API key you wish to use.
4. Copy and paste the code below into your applications, coding environments or command line interface. You're ready to go!

## Response scheme

<figure><img src="https://126655343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2al1MDqAP9Dg9iDRjkWg%2Fuploads%2Fgit-blob-f61e89d52034ecd957ddfb151c817381869e91b4%2Fff186fd-2.4.jpg?alt=media" alt="Response scheme section with its sub-section" width="563"><figcaption></figcaption></figure>

From the Response scheme section you can view:

* **Response structure**: This contains a full JSON response example along with a few details about how to access your document level predictions.
* **Extracted fields**: This provides details about every field extracted by the API within a document.

## Limitations

<figure><img src="https://126655343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2al1MDqAP9Dg9iDRjkWg%2Fuploads%2Fgit-blob-c7f678f4c4e3dd0ec4e9744fbec94443508139fb%2F5883fa9-2.5.jpg?alt=media" alt="Limitations section with its sub-section" width="563"><figcaption></figcaption></figure>

From the limitations section you can view:

* **Supported documents**: This contains details on the type of documents you can send to the API for parsing.
* **Rate limits**: This provides information on the rate limits of each API depending on your plan.

## Open API

<figure><img src="https://126655343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2al1MDqAP9Dg9iDRjkWg%2Fuploads%2Fgit-blob-65ea8227b67c098aafa67fa299d87e14c8c23ab6%2Ffc315f7-2.6.jpg?alt=media" alt="Open API swagger-like interface section" width="563"><figcaption></figcaption></figure>

The OpenAPI section is a swagger-like user interface that allows you to navigate through your API technical information. You can also download the OpenAPI definition of your API.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.mindee.com/v1/platform-ui-tour/api-documentation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.