AdminService
POST /v1/create-corpus
Changed onCreates a corpus, which is a container to store data in.
Some tips for this API:
- This operation works with the Personal API Key and OAuth 2.0 (in a JWT "Bearer Token") authentication. You can find details of how to set up and use OAuth 2.0 here.
- The name of the corpus is the only required field.
- Filter attributes tell Vectara which metadata fields you'd like to run SQL-style filters against. If you need to change them after you've created the corpus, see the Replace Filter Attributes API
- textless and customDimensions are features that are only available to Scale accounts.
Request
- Base URLhttps://api.vectara.io
- Auth
- API key in header x-api-key
- or OAuth 2Client credentialsToken URLhttps://vectara-prod-YOUR_VECTARA_CUSTOMER_ID.auth.us-west-2.amazoncognito.com/oauth2/token
- TypeScriptA 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
Response
A successful response.
Changes
- info
the request property
became optional
- info