> For the complete documentation index, see [llms.txt](https://docs.uptiq.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.uptiq.ai/document-ai/api-reference/api-reference.md).

# Overview

Use the API to extract, classify, and generate documents.

### Get started

{% stepper %}
{% step %}

### Create an API key

Create a key in **Settings → API Keys**. Send it with every authenticated request.
{% endstep %}

{% step %}

### Submit an extraction

Send a document with `POST /extract` for asynchronous processing. Use `POST /extract/sync` when you need the result in the response.
{% endstep %}

{% step %}

### Receive the result

For asynchronous work, receive completion through a webhook or retrieve the extraction by ID.
{% endstep %}
{% endstepper %}

### The four groups

| Group                                                          | What it does                           |
| -------------------------------------------------------------- | -------------------------------------- |
| [Extraction](broken://pages/vSGQzOYgGEf7RDcpwe08)              | Turn a document into structured fields |
| [Classification](/document-ai/api-reference/classification.md) | Identify what a document is            |
| [Generation](/document-ai/api-reference/generation.md)         | Produce a finished document from data  |
| [Utility](/document-ai/api-reference/utility.md)               | Look up supported types and formats    |

### API endpoint

```
https://<api-host>
```

Use the API host configured for your workspace.

### Your first call

One operation needs no credentials at all, which makes it a good way to prove connectivity before you introduce authentication as a variable:

```bash
curl "https://<api-host>/listSupportedDocuments"
```

A `200` with a JSON body of document types means you can reach the platform. Everything after that needs an API key.


---

# 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.uptiq.ai/document-ai/api-reference/api-reference.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.