Method: projects.locations.collections.engines.assistants.agents.tasks.get

Get the current state of a task from the agent.

HTTP request

GET https://discoveryengine.googleapis.com/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/{name=tasks/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
tenant

string

Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.

name

string

Required. The resource name of the task. Format: tasks/{taskId}

Query parameters

Parameters
historyLength

integer

The number of most recent messages from the task's history to retrieve.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.