- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Returns the list of agents.
Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections .
HTTP request
GET https://{endpoint}/v2/{parent=projects/*/locations/*}/agent:search
Where {endpoint}
is one of the supported service endpoints
.
The URLs use gRPC Transcoding syntax.
Path parameters
parent
string
Required. The project to list agents from. Format: projects/<Project ID or '-'>
.
Authorization requires the following IAM
permission on the specified resource parent
:
-
dialogflow.agents.search
Query parameters
| Parameters | |
|---|---|
pageSize
|
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
pageToken
|
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 SearchAgentsResponse
.
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 Authentication Overview .
