List Documents

import requests
url = "https://api.vellum.ai/v1/documents"
headers = {"X-API-KEY": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "string",
      "last_uploaded_at": "2024-01-15T09:30:00Z",
      "label": "string",
      "processing_state": "QUEUED",
      "document_to_document_indexes": [
        {
          "id": "string",
          "environment_document_index_id": "string",
          "document_index_id": "string",
          "processing_state": "string",
          "indexing_state": "AWAITING_PROCESSING"
        }
      ],
      "external_id": "string",
      "processing_failure_reason": "EXCEEDED_CHARACTER_LIMIT",
      "status": "ACTIVE",
      "keywords": [
        "string"
      ],
      "metadata": {}
    }
  ]
}

Used to list documents. Optionally filter on supported fields.

Authentication

X-API-KEYstring

API Key authentication via header

Query parameters

document_index_idstringOptionalformat: "uuid"

Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

orderingstringOptional

Which field to use when ordering the results.

searchstringOptional

A search term.

Response

countinteger

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"

resultslist of objects

List Documents

Authentication

Headers

Query parameters

Response

Authentication

Headers

Query parameters

Response

1	import requests
2
3	url = "https://api.vellum.ai/v1/documents"
4
5	headers = {"X-API-KEY": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"count": 123,
3	"next": "http://api.example.org/accounts/?offset=400&limit=100",
4	"previous": "http://api.example.org/accounts/?offset=200&limit=100",
5	"results": [
6	{
7	"id": "string",
8	"last_uploaded_at": "2024-01-15T09:30:00Z",
9	"label": "string",
10	"processing_state": "QUEUED",
11	"document_to_document_indexes": [
12	{
13	"id": "string",
14	"environment_document_index_id": "string",
15	"document_index_id": "string",
16	"processing_state": "string",
17	"indexing_state": "AWAITING_PROCESSING"
18	}
19	],
20	"external_id": "string",
21	"processing_failure_reason": "EXCEEDED_CHARACTER_LIMIT",
22	"status": "ACTIVE",
23	"keywords": [
24	"string"
25	],
26	"metadata": {}
27	}
28	]
29	}