Retrieve Document

Beta

GET

Retrieve a Document, keying off of either its Vellum-generated ID or its external ID.

idstringRequired

A UUID string identifying this document.

idstring

last_uploaded_atdatetime

labelstring<=1000 characters

A human-readable label for the document. Defaults to the originally uploaded file’s file name.

processing_stateenum

Allowed values: QUEUEDPROCESSINGPROCESSEDFAILEDUNKNOWN

document_to_document_indexeslist of objects

external_idstringOptional<=1000 characters

The unique id of this document as it exists in the user’s system.

status"ACTIVE"OptionalDefaults to ACTIVE

The current status of the document

original_file_urlstringOptional

processed_file_urlstringOptional

metadatamap from strings to anyOptional

A previously supplied JSON object containing metadata that can be filtered on when searching.

1	{
2	"id": "id",
3	"last_uploaded_at": "2024-01-15T09:30:00Z",
4	"label": "label",
5	"processing_state": "QUEUED",
6	"document_to_document_indexes": [
7	{
8	"id": "id",
9	"document_index_id": "document_index_id",
10	"indexing_state": "AWAITING_PROCESSING",
11	"extracted_text_file_url": "extracted_text_file_url"
12	}
13	],
14	"external_id": "external_id",
15	"status": "ACTIVE",
16	"original_file_url": "original_file_url",
17	"processed_file_url": "processed_file_url",
18	"metadata": {
19	"key": "value"
20	}
21	}

1	curl https://api.vellum.ai/v1/documents/id \
2	-H "X_API_KEY: <apiKey>"