Update Document

Beta
PATCH

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

Path parameters

idstringRequired

A UUID string identifying this document.

Request

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.

status"ACTIVE"OptionalDefaults to ACTIVE

The current status of the document

  • ACTIVE - Active
metadatamap from strings to anyOptional

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

Response

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
  • QUEUED - Queued
  • PROCESSING - Processing
  • PROCESSED - Processed
  • FAILED - Failed
  • UNKNOWN - Unknown
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

  • ACTIVE - Active
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.