> 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

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

**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

Mindee Sample code located under the API reference tab on the right

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

Response scheme section with its sub-section

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

Limitations section with its sub-section

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

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 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.mindee.com/v1/platform-ui-tour/api-documentation.md?ask=&goal= ``` `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.