Method: projects.agent.search

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://dialogflow.googleapis.com/v2beta1/{parent=projects/*}/agent:search

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
parent

string

Required. The project to list agents from. Format: projects/<Project ID or '-'>.

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

  • dialogflow.agents.search

Query parameters

Parameters
pageSize

number

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

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 data with the following structure:

The response message for Agents.SearchAgents.

JSON representation
{
  "agents": [
    {
      object(Agent)
    }
  ],
  "nextPageToken": string
}
Fields
agents[]

object(Agent)

The list of agents. There will be a maximum number of items returned based on the pageSize field in the request.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Dialogflow Enterprise Edition