v1

latestOpenAPI 3.0.02026-07-1329122146.2 KB
AdminService

Lets you enable or disable a corpus. This is useful when you need to take the corpus offline without having to delete the corpus.

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/update-corpus-enablement

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

The corpus to enable or disable.

enableboolean

If true, enable the corpus. Otherwise, disable it.

Response

A successful response.