Sign in

v1

latestOpenAPI 3.0.02026-07-1329122146.2 KB
AdminService

Lists all corpora accessible to the OAuth client.

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.
post/v1/list-corpora

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

filterstring

A regex over the names and descriptions to match corpora against.

numResultsinteger required

The maximum results to return.

pageKeystring byte

A key that is passed in to retrieve a specific page of results.

Example request

{
  "numResults": 10,
  "filter": "[Tt][Ee][Ss][Tt]"
}

Response

A successful response.

pageKeystring byte

A key that is passed into a subsequent result in order to retrieve the next page of results.