Update Document

import requests
url = "https://api.vellum.ai/v1/documents/id"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"label\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"status\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keywords\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {
    "X-API-KEY": "<apiKey>",
    "Content-Type": "multipart/form-data; boundary=---011000010111000001101001"
}
response = requests.patch(url, data=payload, headers=headers)
print(response.json())

{
  "id": "string",
  "last_uploaded_at": "2024-01-15T09:30:00Z",
  "label": "string",
  "processing_state": "QUEUED",
  "original_file_url": "string",
  "document_to_document_indexes": [
    {
      "id": "string",
      "environment_document_index_id": "string",
      "document_index_id": "string",
      "extracted_text_file_url": "string",
      "processing_state": "string",
      "indexing_state": "AWAITING_PROCESSING"
    }
  ],
  "external_id": "string",
  "status": "ACTIVE",
  "keywords": [
    "string"
  ],
  "metadata": {}
}

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

import requests
url = "https://api.vellum.ai/v1/documents/id"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"label\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"status\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keywords\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {
    "X-API-KEY": "<apiKey>",
    "Content-Type": "multipart/form-data; boundary=---011000010111000001101001"
}
response = requests.patch(url, data=payload, headers=headers)
print(response.json())

{
  "id": "string",
  "last_uploaded_at": "2024-01-15T09:30:00Z",
  "label": "string",
  "processing_state": "QUEUED",
  "original_file_url": "string",
  "document_to_document_indexes": [
    {
      "id": "string",
      "environment_document_index_id": "string",
      "document_index_id": "string",
      "extracted_text_file_url": "string",
      "processing_state": "string",
      "indexing_state": "AWAITING_PROCESSING"
    }
  ],
  "external_id": "string",
  "status": "ACTIVE",
  "keywords": [
    "string"
  ],
  "metadata": {}
}

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

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequiredformat: "^[^/]+$"

Request

This endpoint expects a multipart form.

labelstringOptional1-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 * `ACTIVE` - Active

Allowed values:

keywordslist of stringsOptional

A list of keywords that'll be associated with the document. Used as part of keyword search.

metadatamap from strings to any or nullOptional

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

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

The current status of the document

ACTIVE - Active

Allowed values:

keywordslist of strings

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.

Update Document

Authentication

Path parameters

Headers

Request

Response

Authentication

Path parameters

Headers

Request

Response

1	import requests
2
3	url = "https://api.vellum.ai/v1/documents/id"
4
5	payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"label\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"status\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"keywords\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
6	headers = {
7	"X-API-KEY": "<apiKey>",
8	"Content-Type": "multipart/form-data; boundary=---011000010111000001101001"
9	}
10
11	response = requests.patch(url, data=payload, headers=headers)
12
13	print(response.json())

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