Search

Perform a search against a document index.

X-API-KEYstring

API Key authentication via header

This endpoint expects an object.

querystringRequired>=1 character

The query to search for.

index_idstring or nullOptionalformat: "uuid"

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

index_namestring or nullOptional>=1 character

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

optionsobject or nullOptional

Configuration options for the search.

document_indexstring or nullOptional>=1 character

Either the index name or index ID to search against. Must provide either this, index_id or index_name.

resultslist of objects

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

400

Bad Request Error

404

Not Found Error

500

Internal Server Error

1	import requests
2
3	url = "https://predict.vellum.ai/v1/search"
4
5	payload = { "query": "string" }
6	headers = {
7	"X-API-KEY": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	import requests
2
3	url = "https://predict.vellum.ai/v1/search"
4
5	payload = { "query": "string" }
6	headers = {
7	"X-API-KEY": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())