List Documents

GET

1 from vellum import Vellum
2 
3 client = Vellum(
4     api_key="YOUR_API_KEY",
5 )
6 client.documents.list()

Play

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       "processing_state": "QUEUED",
11       "document_to_document_indexes": [
12         {
13           "id": "id",
14           "document_index_id": "document_index_id"
15         }
16       ],
17       "external_id": "external_id",
18       "processing_failure_reason": "EXCEEDED_CHARACTER_LIMIT",
19       "status": "ACTIVE",
20       "keywords": [
21         "keywords"
22       ],
23       "metadata": {
24         "key": "value"
25       }
26     }
27   ]
28 }

Used to list documents. Optionally filter on supported fields.

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

countintegerOptional

nextstringOptionalformat: "uri"

previousstringOptionalformat: "uri"

resultslist of objectsOptional

Headers

Query parameters

Response