Search

POST

Perform a search against a document index.

This endpoint expects an object.

querystringRequired>=1 character

The query to search for.

index_idstringOptional

The ID of the index to search against. Must provide either this or index_name.

index_namestringOptional>=1 character

The name of the index to search against. Must provide either this or index_id.

optionsobjectOptional

Configuration options for the search.

resultslist of objects

The results of the search. Each result represents a chunk that matches the search query.

1	curl -X POST https://predict.vellum.ai/v1/search \
2	-H "X_API_KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"query": "query"
6	}'