Method: projects.agent.knowledgeBases.documents.list

Returns the list of all documents of the knowledge base.

HTTP request

GET https://dialogflow.googleapis.com/v2beta1/{parent=projects/*/agent/knowledgeBases/*}/documents

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.

Authorization requires the following Google IAM permission on the specified resource parent:

  • dialogflow.documents.list

Query parameters

Parameters
pageSize

number

Optional. The maximum number of items to return in a single page. By default 10 and at most 100.

pageToken

string

Optional. The nextPageToken value returned from a previous list request.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListDocumentsResponse.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the OAuth 2.0 Overview.