Documents

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.
label
stringOptional
A human-readable label for the document. Defaults to the originally uploaded file's file name.
status
string literalOptional

The current status of the document

  • ACTIVE - Active
Allowed value: ACTIVE
metadata
map from strings to anyOptional
A JSON object containing any metadata associated with the document that you'd like to filter upon later.

Response

This endpoint returns an object
id
string
last_uploaded_at
datetime
label
string
A human-readable label for the document. Defaults to the originally uploaded file's file name.
document_to_document_indexes
list of objects
external_id
stringOptional
The unique id of this document as it exists in the user's system.
processing_state
enumOptional

The current processing state of the document

  • QUEUED - Queued
  • PROCESSING - Processing
  • PROCESSED - Processed
  • FAILED - Failed
Allowed values: QUEUEDPROCESSINGPROCESSEDFAILED
status
string literalOptional

The current status of the document

  • ACTIVE - Active
Allowed value: ACTIVE
original_file_url
stringOptional
processed_file_url
stringOptional
metadata
map from strings to anyOptional
A previously supplied JSON object containing metadata that can be filtered on when searching.
Built with