List Document Indexes | Vellum

1 import { VellumClient } from "vellum-ai"; 2 3 const client = new VellumClient({ apiKey: "YOUR_API_KEY" }); 4 await client.documentIndexes.list();

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": "foo", 8 "created": "foo", 9 "label": "foo", 10 "name": "foo", 11 "indexing_config": { 12 "vectorizer": { 13 "config": { 14 "add_openai_api_key": true 15 }, 16 "model_name": "text-embedding-3-small" 17 }, 18 "chunking": { 19 "chunker_name": "reducto-chunker", 20 "chunker_config": { 21 "character_limit": 1000 22 } 23 } 24 }, 25 "status": "ACTIVE" 26 } 27 ] 28 }

Used to retrieve a list of Document Indexes.

Query parameters

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

Search for document indices by name or label

statusenumOptional

Filter down to only document indices that have a status matching the status specified

ACTIVE - Active
ARCHIVED - Archived

Allowed values:

Response

countinteger or null

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"

resultslist of objects or null

Headers

Query parameters

Response