2026-03-24
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.message.send
Parameter Order : tenant
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Send a message to the agent. This is a blocking call that will return the task once it is completed, or a LRO if requested.
Parameters :
tenant
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Required : Yes
Type : string
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/message:send
HTTP Method : POST
Path : v1/{+tenant}/a2a/v1/message:send
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.message.stream
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : tenant
Description : SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.
Parameters :
tenant
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/message:stream
HTTP Method : POST
Path : v1/{+tenant}/a2a/v1/message:stream
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.subscribe
Parameter Order :
Path : v1/{+tenant}/a2a/v1/{+name}:subscribe
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream.
Parameters :
tenant
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Required : Yes
name
Required : Yes
Location : path
Description : The resource name of the task to subscribe to. Format: tasks/{task_id}
Type : string
Pattern : ^tasks/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}:subscribe
HTTP Method : GET
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.cancel
HTTP Method : POST
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^tasks/[^/]+$
Description : The resource name of the task to cancel. Format: tasks/{task_id}
tenant
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Required : Yes
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Location : path
Description : Cancel a task from the agent. If supported one should expect no more task updates for the task.
Path : v1/{+tenant}/a2a/v1/{+name}:cancel
Parameter Order :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}:cancel
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.get
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Description : Required. The resource name of the task. Format: tasks/{task_id}
Required : Yes
Type : string
Pattern : ^tasks/[^/]+$
historyLength
Description : The number of most recent messages from the task's history to retrieve.
Format : int32
Type : integer
Location : query
tenant
Type : string
Location : path
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}
HTTP Method : GET
Description : Get the current state of a task from the agent.
Path : v1/{+tenant}/a2a/v1/{+name}
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.pushNotificationConfigs.create
Parameter Order :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs
HTTP Method : POST
Parameters :
tenant
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Location : path
parent
Required : Yes
Pattern : ^tasks/[^/]+/pushNotificationConfigs$
Location : path
Type : string
Description : Required. The parent task resource for this config. Format: tasks/{task_id}
configId
Location : query
Description : Required. The ID for the new config.
Type : string
Description : Set a push notification config for a task.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+tenant}/a2a/v1/{+parent}
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.pushNotificationConfigs.list
Description : Get a list of push notifications configured for a task.
Path : v1/{+tenant}/a2a/v1/{+parent}/pushNotificationConfigs
Parameters :
pageSize
Location : query
Format : int32
Description : For AIP-158 these fields are present. Usually not used/needed. The maximum number of configurations to return. If unspecified, all configs will be returned.
Type : integer
tenant
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Location : path
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Type : string
Required : Yes
parent
Description : The parent task resource. Format: tasks/{task_id}
Pattern : ^tasks/[^/]+$
Location : path
Type : string
Required : Yes
pageToken
Location : query
Type : string
Description : A page token received from a previous ListTaskPushNotificationConfigRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTaskPushNotificationConfigRequest` must match the call that provided the page token.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order :
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.pushNotificationConfigs.get
Description : Get a push notification config for a task.
Parameters :
name
Location : path
Type : string
Required : Yes
Description : The resource name of the config to retrieve. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$
tenant
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
Path : v1/{+tenant}/a2a/v1/{+name}
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.pushNotificationConfigs.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$
Required : Yes
Type : string
Description : The resource name of the config to delete. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
Location : path
tenant
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
Description : Delete a push notification config for a task.
Path : v1/{+tenant}/a2a/v1/{+name}
Parameter Order :
HTTP Method : DELETE
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.getCard
Description : GetAgentCard returns the agent card for the agent.
Parameters :
tenant
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Type : string
Location : path
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Required : Yes
Path : v1/{+tenant}/a2a/v1/card
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/card
Parameter Order : tenant
HTTP Method : GET
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.getCard
Parameter Order : tenant
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Path : v1/{+tenant}/card
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/card
Description : GetAgentCard returns the agent card for the agent.
Parameters :
tenant
Required : Yes
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Type : string
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.message.stream
Path : v1/{+tenant}/message:stream
Parameter Order : tenant
Description : SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/message:stream
HTTP Method : POST
Parameters :
tenant
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Type : string
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Required : Yes
Location : path
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.message.send
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
tenant
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Required : Yes
Type : string
Location : path
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Description : Send a message to the agent. This is a blocking call that will return the task once it is completed, or a LRO if requested.
Parameter Order : tenant
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/message:send
Path : v1/{+tenant}/message:send
HTTP Method : POST
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order :
Description : Cancel a task from the agent. If supported one should expect no more task updates for the task.
Path : v1/{+tenant}/{+name}:cancel
Parameters :
tenant
Required : Yes
Location : path
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Type : string
name
Type : string
Location : path
Description : The resource name of the task to cancel. Format: tasks/{task_id}
Required : Yes
Pattern : ^tasks/[^/]+$
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}:cancel
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
tenant
Location : path
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Type : string
historyLength
Description : The number of most recent messages from the task's history to retrieve.
Location : query
Format : int32
Type : integer
name
Description : Required. The resource name of the task. Format: tasks/{task_id}
Pattern : ^tasks/[^/]+$
Required : Yes
Location : path
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}
Path : v1/{+tenant}/{+name}
HTTP Method : GET
Description : Get the current state of a task from the agent.
Parameter Order :
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.subscribe
Description : TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
tenant
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Required : Yes
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
name
Type : string
Description : The resource name of the task to subscribe to. Format: tasks/{task_id}
Location : path
Required : Yes
Pattern : ^tasks/[^/]+$
Path : v1/{+tenant}/{+name}:subscribe
Parameter Order :
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}:subscribe
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.pushNotificationConfigs.delete
Description : Delete a push notification config for a task.
Parameter Order :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
Parameters :
tenant
Type : string
Required : Yes
Location : path
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
name
Required : Yes
Description : The resource name of the config to delete. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$
Location : path
Type : string
HTTP Method : DELETE
Path : v1/{+tenant}/{+name}
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.pushNotificationConfigs.create
Description : Set a push notification config for a task.
Parameter Order :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}/pushNotificationConfigs
Path : v1/{+tenant}/{+parent}
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Description : Required. The parent task resource for this config. Format: tasks/{task_id}
Pattern : ^tasks/[^/]+/pushNotificationConfigs$
Location : path
Type : string
configId
Location : query
Type : string
Description : Required. The ID for the new config.
tenant
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Required : Yes
Type : string
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.pushNotificationConfigs.list
HTTP Method : GET
Parameter Order :
Path : v1/{+tenant}/{+parent}/pushNotificationConfigs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}/pushNotificationConfigs
Parameters :
pageToken
Description : A page token received from a previous ListTaskPushNotificationConfigRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTaskPushNotificationConfigRequest` must match the call that provided the page token.
Location : query
Type : string
tenant
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Required : Yes
parent
Required : Yes
Type : string
Location : path
Pattern : ^tasks/[^/]+$
Description : The parent task resource. Format: tasks/{task_id}
pageSize
Type : integer
Format : int32
Description : For AIP-158 these fields are present. Usually not used/needed. The maximum number of configurations to return. If unspecified, all configs will be returned.
Location : query
Description : Get a list of push notifications configured for a task.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.pushNotificationConfigs.get
Parameter Order :
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+tenant}/{+name}
Parameters :
tenant
Type : string
Required : Yes
Location : path
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
name
Required : Yes
Description : The resource name of the config to retrieve. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$
Type : string
Location : path
Description : Get a push notification config for a task.