Sign in

v1

latestOpenAPI 3.0.02026-07-1329122146.2 KB
DocumentService

Lists information about each document ingested into the corpus including the Document ID and metadata. This is useful for managing the lifecycle of documents and a quick way to check which documents are already in the index.

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

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

numResultsinteger

Maximum number of results to be returned by the server. Max is 1000. If the value is larger than 1000, it will be capped to 1000.

pageKeystring byte

Key of the specific page of the list results to return. Null/empty value means the very first page of the results is requested.

metadataFilterstring

Filter on document metadata. If empty, no filtering is done. Otherwise, only documents that match all of the specified metadata will be returned. The syntax is the same as for QueryRequest.metadata.

Response

A successful response.

nextPageKeystring byte

Represents the pagination key to retrieve the next page of results. If the value is "", it means no further results for the request. To retrieve the next page of results, client shall pass the value of next_page_key in the subsequent ListDocumentsRequest method call (in the request message's page_key field).