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

Cancel a task from the agent. If supported one should expect no more task updates for the task.

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

The URL uses gRPC Transcoding syntax.

Parameters

Parameters
`tenant`	`string` Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
`name`	`string` The resource name of the task to cancel. Format: tasks/{taskId}

tenant

string

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

name

string

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

The request body must be empty.

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

Requires the following OAuth scope:

For more information, see the Authentication Overview.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-21 UTC.

Method: projects.locations.collections.engines.assistants.agents.tasks.cancel Stay organized with collections Save and categorize content based on your preferences.