Ctrlk
ChangelogTry UPTIQ AI
For the complete documentation index, see llms.txt. This page is also available as Markdown.
Reference

Utility

Discover what the platform can accept before you send it anything.

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.

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

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.

GET /document/supported-file-types does require a key, despite sitting in the same group. Do not assume the group is uniformly public.

For the categorised registry as a readable list, see Document Types.

Get supported file types for all document types.

GET /document/supported-file-types

Requires the X-Api-Key header. See Authentication.

Responses

Status
Description
Schema

200

OK

SupportedFileTypesResponse

400

Bad Request

ValidationError

401

Authentication required — the X-Api-Key header is missing or invalid.

Example

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

Related pages

  • Document Types — the same registry, categorised and annotated.

  • Discovering document types — reading the registry at build time instead of hardcoding it.

  • Authentication — why one endpoint here is public and the other is not.

Last updated

Was this helpful?