> 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/integrations/api-reference.md).

# Manual Integration

Help for manually integrating Mindee: API reference, test client, and cURL samples.

{% hint style="warning" %}
**We do not recommend manually integrating**, and cannot guarantee full support.

Pro plans and above benefit from extended integration support.
{% endhint %}

{% hint style="success" %}
**Recommended integrations:**

* [Client Libraries / SDKs](/integrations/client-libraries-sdk.md)
* [No-Code Integration](/extraction-models/no-code-integration.md)

Also take a look at the [Integration Overview](/integrations/api-overview.md) if you are setting up your integration for the first time.
{% endhint %}

{% hint style="info" %}
If you would like to download the OpenAPI specification directly, it is available here:\
<https://api-v2.mindee.net/openapi.json>
{% endhint %}

The bare Mindee HTTP API is RESTful, and returns data in a JSON format.

API routes and schemas are organized according to the type of model:

* [Extraction Models](/integrations/api-reference/extraction-models.md)
* [Split Models](/integrations/api-reference/split-models.md)
* [Crop Models](/integrations/api-reference/crop-models.md)
* [Classification Models](/integrations/api-reference/classification-models.md)
* [OCR Models](/integrations/api-reference/ocr-models.md)

For each section you can find the complete documentation of all routes, including cURL samples and a built-in testing tool.

Here is a working example of the built-in test client for an Extraction Model. Other models are similar.

<figure><img src="https://4029869281-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu5bStlX8nv4b9z4GXB2S%2Fuploads%2Fgit-blob-90f1411ee7d0fda8bda7e98593bf94e7a8371dd6%2Fapi-example_post-inference.png?alt=media" alt=""><figcaption></figcaption></figure>


---

# 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/integrations/api-reference.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.
