Method: projects.agent.environments.get

Stay organized with collections Save and categorize content based on your preferences.

Retrieves the specified agent environment.

HTTP request

GET https://{endpoint}/v2/{name=projects/*/agent/environments/*}

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

The URLs use gRPC Transcoding syntax.

Path parameters



Required. The name of the environment. Supported formats:

  • projects/<Project ID>/agent/environments/<Environment ID>
  • projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>

The environment ID for the default environment is -.

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.environments.get

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.