Update Document | Vellum

Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata.

idstringRequiredformat: "^[^/]+$"

This endpoint expects an object.

labelstringOptional>=1 character<=1000 characters

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

statusenumOptional

The current status of the document

Allowed values:

metadatamap from strings to anyOptional

A JSON object containing any metadata associated with the document that you’d like to filter upon later.

idstringformat: "uuid"

last_uploaded_atstringformat: "date-time"

labelstring<=1000 characters

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

processing_stateenum

Allowed values:

document_to_document_indexeslist of objects

external_idstringOptional<=1000 characters

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

statusenumOptional

The current status of the document

Allowed values:

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	curl -X PATCH https://api.vellum.ai/v1/documents/id \
2	-H "X-API-KEY: <X-API-KEY>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"id": "foo",
3	"last_uploaded_at": "foo",
4	"label": "foo",
5	"processing_state": "QUEUED",
6	"document_to_document_indexes": [
7	{
8	"id": "foo",
9	"environment_document_index_id": "foo",
10	"document_index_id": "foo",
11	"indexing_state": "AWAITING_PROCESSING",
12	"extracted_text_file_url": "foo"
13	}
14	],
15	"external_id": "foo",
16	"status": "ACTIVE",
17	"original_file_url": "foo",
18	"processed_file_url": "foo",
19	"metadata": {}
20	}