Client SDKDocuments

Retrieve Document

Beta

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

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequiredformat: "^[^/]+$"

Headers

X-API-VersionstringOptional

Response

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
* `QUEUED` - Queued * `PROCESSING` - Processing * `PROCESSED` - Processed * `FAILED` - Failed * `UNKNOWN` - Unknown
Allowed values:
original_file_urlstring or null
document_to_document_indexeslist of objects
external_idstring or null<=1000 characters
The unique id of this document as it exists in the user's system.
statusenum or null

The current status of the document

  • ACTIVE - Active
Allowed values:
keywordslist of strings or null
A list of keywords that'll be associated with the document. Used as part of keyword search.
metadatamap from strings to any or null
A previously supplied JSON object containing metadata that can be filtered on when searching.