Method: projects.locations.companionAgents.get

Gets a companion agent.

HTTP request

GET https://{endpoint}/v2/{name=projects/*/locations/*/companionAgents/*}

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The unique resource identifier of the CompanionAgent to get all information for. Format: projects/{project}/locations/{location}/companionAgents/{companionAgent}. Contains the information about the {project}, {location}, and {companionAgent}.

Request body

The request body must be empty.

Response body

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

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.