Documents

List

GA
GET
https://api.vellum.ai/v1/documents
Used to list documents. Optionally filter on supported fields.

Query parameters

document_index_id
optional string
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.
limit
optional integer
Number of results to return per page.
offset
optional integer
The initial index from which to return the results.
ordering
optional string
Which field to use when ordering the results.

Response

This endpoint return an object.
count
optional integer
next
optional string
previous
optional string
results
optional list of objects
GET
/v1/documents
curl https://api.vellum.ai/v1/documents \
-H "X_API_KEY: <apiKey>"
Response
{
"count": 1,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"id": "id",
"last_uploaded_at": "2024-01-15T09:30:00Z",
"label": "label",
"document_to_document_indexes": [
{
"id": "id",
"document_index_id": "document_index_id"
}
],
"external_id": "external_id",
"processing_state": "QUEUED",
"processing_failure_reason": "EXCEEDED_CHARACTER_LIMIT",
"status": "ACTIVE",
"keywords": [
"keywords"
]
}
]
}