AdminService

POST /v1/read-corpus

Changed on Oct 12, 2024

Displays detailed information about corpora within your account including basic information, metadata, and whether it is enabled or disabled. This endpoint can help administrators monitor the amount of quota consumed by tenants.

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 filter feature applies to either the name or the description of a corpus.

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/read-corpus/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

corpusIdinteger[]

Corpora IDs to read.

readBasicInfoboolean

Subset of information to read. Set to true to read basic information about the corpus such as id, name, description, enabled, etc.

readSizeboolean

Set to true to read the size of the corpus.

readApiKeysboolean

Set to true to read the API keys associated with the corpus.

readCustomDimensionsboolean

Set to true to read the custom dimensions of the corpus.

readFilterAttributesboolean

Set to true to read the filter attributes of the corpus.

Response

A successful response.

Changes

Oct 12, 20248c3acaedc699 Revision changes
- info
  added the optional property //// to the response with the status

Operation history