2026-03-22
▼ ▲ aiplatform.projects.locations.generateUserScenarios
Path : v1beta1/{+location}:generateUserScenarios
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}:generateUserScenarios
HTTP Method : POST
Parameters :
location
Description : Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : location
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Generates user scenarios for agent evaluation.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2aTasks.create
Path : v1beta1/{+parent}/a2aTasks
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2aTasks
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the ReasoningEngine to create the A2aTask under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aTaskId
Description : Required. User-defined ID of the A2aTask. This ID must be unique within the ReasoningEngine.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an A2aTask.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2aTasks.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2aTasks/{a2aTasksId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the A2aTask. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an A2aTask.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2aTasks.list
Path : v1beta1/{+parent}/a2aTasks
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2aTasks
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the ReasoningEngine to list the A2aTasks under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `context_id` * `state` Example: `context_id="abc"`, `state="WORKING"`.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 100; values above 100 will hit exception.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The next_page_token value returned from a previous list AgentEngineTaskStoreService.ListA2aTasks call.
Location : query
Type : string
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. If this field is omitted, the default ordering is `create_time` descending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` Example: `create_time desc`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists A2aTasks for a ReasoningEngine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2aTasks.appendEvents
Path : v1beta1/{+name}:appendEvents
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2aTasks/{a2aTasksId}:appendEvents
HTTP Method : POST
Parameters :
name
Description : Required. The resource name of the A2aTask to append events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Appends TaskEvents to an A2aTask.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2aTasks.events.list
Path : v1beta1/{+parent}/events
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2aTasks/{a2aTasksId}/events
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the A2aTask to list the TaskEvents under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. The maximum value is 100; values above 100 will hit exception.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The next_page_token value returned from a previous list AgentEngineTaskStoreService.ListA2aTaskEvents call.
Location : query
Type : string
filter
Description : Optional. The standard list filter. Supported fields: * `create_time` range (i.e. `create_time>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
orderBy
Description : Optional. A comma-separated list of fields to order the results by. If this field is omitted, the results will be ordered by `event_sequence_number` in descending order. For each field, the default sort order is ascending. To specify descending order for a field, append a ` desc` suffix. For example: `create_time desc`. Supported fields: * `create_time` * `event_sequence_number`
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists TaskEvents for an A2aTask.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.tasks
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.card
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/card
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^card$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.extendedAgentCard
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/extendedAgentCard
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^extendedAgentCard$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.message.stream
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:stream
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/message:stream
HTTP Method : POST
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.
Pattern : ^message$
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.message.send
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:send
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/message:send
HTTP Method : POST
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^message$
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.tasks.cancel
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^tasks/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.tasks.pushNotificationConfigs
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+/pushNotificationConfigs$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.tasks.a2aGetReasoningEngine
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.tasks.subscribe
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:subscribe
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.
Pattern : ^tasks/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Stream get request for reasoning engine instance via the A2A stream get protocol apis.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/tasks$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.projects.locations.reasoningEngines.a2a.v1.extendedAgentCard
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/extendedAgentCard
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/extendedAgentCard$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.projects.locations.evaluationMetrics.create
Path : v1beta1/{+parent}/evaluationMetrics
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the EvaluationMetric in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
evaluationMetricId
Description : Optional. The ID to use for the EvaluationMetric, which will become the final component of the EvaluationMetric's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an EvaluationMetric.
▼ ▲ aiplatform.projects.locations.evaluationMetrics.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the EvaluationMetric resource. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`
Pattern : ^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an EvaluationMetric.
▼ ▲ aiplatform.projects.locations.evaluationMetrics.list
Path : v1beta1/{+parent}/evaluationMetrics
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location from which to list the EvaluationMetrics. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of EvaluationMetrics to return.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListEvaluationMetrics` call. Provide this to retrieve the subsequent page.
Location : query
Type : string
filter
Description : Optional. Filter expression that matches a subset of the EvaluationMetrics to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists EvaluationMetrics.
▼ ▲ aiplatform.projects.locations.evaluationMetrics.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the EvaluationMetric resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`
Pattern : ^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an EvaluationMetric.
▼ ▲ aiplatform.reasoningEngines.a2a.tasks
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.reasoningEngines.a2a.card
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/card
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^card$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.reasoningEngines.a2a.extendedAgentCard
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/extendedAgentCard
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^extendedAgentCard$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.reasoningEngines.a2a.message.stream
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:stream
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/message:stream
HTTP Method : POST
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.
Pattern : ^message$
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
▼ ▲ aiplatform.reasoningEngines.a2a.message.send
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:send
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/message:send
HTTP Method : POST
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^message$
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
▼ ▲ aiplatform.reasoningEngines.a2a.tasks.cancel
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^tasks/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
▼ ▲ aiplatform.reasoningEngines.a2a.tasks.pushNotificationConfigs
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+/pushNotificationConfigs$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.reasoningEngines.a2a.tasks.a2aGetReasoningEngine
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.reasoningEngines.a2a.tasks.subscribe
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:subscribe
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.
Pattern : ^tasks/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Stream get request for reasoning engine instance via the A2A stream get protocol apis.
▼ ▲ aiplatform.reasoningEngines.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.reasoningEngines.a2a.v1.tasks
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/tasks$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
▼ ▲ aiplatform.reasoningEngines.a2a.v1.extendedAgentCard
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/extendedAgentCard
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/extendedAgentCard$
Location : path
Required : Yes
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Location : query
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.