Documents

List

GA
GET
Used to list documents. Optionally filter on supported fields.

Query parameters

document_index_idstringOptional
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.

Response

This endpoint returns an object
count
integerOptional
next
stringOptional
previous
stringOptional
results
list of objectsOptional
GET
1curl https://api.vellum.ai/v1/documents \
2 -H "X_API_KEY: <apiKey>"
200Retrieved
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": "id",
8 "last_uploaded_at": "2024-01-15T09:30:00Z",
9 "label": "label",
10 "document_to_document_indexes": [
11 {
12 "id": "id",
13 "document_index_id": "document_index_id"
14 }
15 ],
16 "external_id": "external_id",
17 "processing_state": "QUEUED",
18 "processing_failure_reason": "EXCEEDED_CHARACTER_LIMIT",
19 "status": "ACTIVE",
20 "keywords": [
21 "keywords"
22 ]
23 }
24 ]
25}