> 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/developer-documentation/integration-guides/utility.md).

# Utility API

Two lookup endpoints answer the questions every integration asks first: *which document types can I name*, and *which file formats will you take*. Both are worth calling at build time rather than hardcoding, because the document-type registry grows without a release — new types are added as configuration.

### Generated endpoint reference

The generated reference is the source of truth for schemas and responses.

* [List all supported document types from YAML configs](/document-ai/developer-documentation/utility-1/list-all-supported-document-types-from-yaml-configs.md)

Use the generated reference navigation for supported file types. This guide keeps authentication and registry behavior.

{% hint style="info" %}
`GET /listSupportedDocuments` is the one operation on this API that needs no API key. It is a useful first call when you are checking connectivity, because a failure tells you something about the network rather than about your credentials.
{% endhint %}

{% hint style="warning" %}
`GET /document/supported-file-types` **does** require a key, despite sitting in the same group. Do not assume the group is uniformly public.
{% endhint %}

For the categorised registry as a readable list, see [Document Types](/document-ai/guides-1/document-types.md).

### Get supported file types for all document types.

`GET /document/supported-file-types`

Requires the `X-Api-Key` header. See [Authentication](/document-ai/developer-documentation/getting-started/authentication.md).

**Responses**

| Status | Description                                                             | Schema                       |
| ------ | ----------------------------------------------------------------------- | ---------------------------- |
| `200`  | OK                                                                      | `SupportedFileTypesResponse` |
| `400`  | Bad Request                                                             | `ValidationError`            |
| `401`  | Authentication required — the `X-Api-Key` header is missing or invalid. |                              |

**Example**

```bash
curl -X GET "https://api-docai-uat.uptiq.ai/document/supported-file-types" \
  -H "X-Api-Key: $DOCAI_API_KEY"
```

### List all supported document types from YAML configs.

`GET /listSupportedDocuments`

No authentication required.

**Responses**

| Status | Description | Schema                           |
| ------ | ----------- | -------------------------------- |
| `200`  | OK          | `ListSupportedDocumentsResponse` |
| `400`  | Bad Request | `ValidationError`                |

**Example**

```bash
curl -X GET "https://api-docai-uat.uptiq.ai/listSupportedDocuments"
```

### Related pages

* [Document Types](/document-ai/guides-1/document-types.md) — the same registry, categorised and annotated.
* [Discovering document types](/document-ai/cookbooks/discovering-document-types.md) — reading the registry at build time instead of hardcoding it.
* [Authentication](/document-ai/developer-documentation/getting-started/authentication.md) — why one endpoint here is public and the other is not.


---

# 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/developer-documentation/integration-guides/utility.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.