v1
latestOpenAPI 3.0.02026-07-1329122146.2 KBIndexService
This is the "standard" Indexing API for indexing semi-structured, text-heavy "documents." Indexing data into Vectara is typically very fast: within a few seconds.
Some tips for this API:
- This operation authenticates with either the Personal API Key, Index API Key, or OAuth 2.0 (in a JWT "Bearer Token"). You can find details of how to set up an API key or use OAuth 2.0 here.
- Vectara does require a special format for JSON objects you'd like to index. Some tips on how to model data in the indexing API, see the documentation here.
- The metadataJson object needs the JSON to be escaped so that it's not confused with other parts of the request JSON.
- Custom dimensions (customDims) is a feature that is only available to Scale accounts.
post/v1/index
Headers
customer-idinteger required
Enter the Customer ID to use for the request.
timeoutstring
(Optional) Enter the timeout value of the request in seconds, such as 10S or 30S.
Request body
Response
A successful response.