IndexService

POST /v1/core/index

This API is intended to be used by experts. It gives you fine-grained control over chunking strategies by using the parts. Most users will want to use the File Upload API or the "standard" Index API.

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.
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.

Request

Base URL
https://api.vectara.io
Auth
- API key in header x-api-key
- or OAuth 2
  Client credentials
  Token URLhttps://vectara-prod-YOUR_VECTARA_CUSTOMER_ID.auth.us-west-2.amazoncognito.com/oauth2/token
TypeScript
https://skmtc.dev/vectara/apis/vectara-rest-api/docs/v1/core/index/post.ts
A function with typed inputs. Its response is checked against the schema.

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

customerIdstring int64

The Customer ID to issue the request for.

corpusIdstring int64

The Corpus ID to index the document into.

Response

A successful response.

Changes

No recorded changes to this operation across all 3 revisions of this API.