Vertex AI API (aiplatform:v1beta1)

2025-09-09

17 new methods

Additions

    Methods
  • aiplatform.projects.locations.reasoningEngines.a2a.v1.card

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/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 :

    • name
    • a2aEndpoint
    • 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.message.stream

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:stream

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/message$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • name
    • a2aEndpoint
    • 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.v1.message.send

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:send

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/message$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • name
    • a2aEndpoint
    • 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.v1.tasks.cancel

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/tasks/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • name
    • a2aEndpoint
    • 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.v1.tasks.pushNotificationConfigs

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/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 :

    • name
    • a2aEndpoint
    • 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.a2aGetReasoningEngine

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^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 :

    • name
    • a2aEndpoint
    • 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.subscribe

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/tasks/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • name
    • a2aEndpoint
    • 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.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/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 :

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

      Description : Get request for reasoning engine instance via the A2A get protocol apis.

  • aiplatform.projects.publishers.models.enableModel

      Path : v1beta1/{+parent}/{+name}:enableModel

      Flat Path : v1beta1/projects/{projectsId}/publishers/{publishersId}/models/{modelsId}:enableModel

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The project requesting access for named model. Format: `projects/{project}`

          Pattern : ^projects/[^/]+$

          Location : path

          Required : Yes

          Type : string

        name

          Description : Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`

          Pattern : ^publishers/[^/]+/models/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

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

      Description : Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).

  • aiplatform.reasoningEngines.a2a.v1.card

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/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 :

    • name
    • a2aEndpoint
    • 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.message.stream

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:stream

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/message$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • name
    • a2aEndpoint
    • 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.v1.message.send

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:send

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/message$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • name
    • a2aEndpoint
    • 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.v1.tasks.cancel

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/tasks/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • name
    • a2aEndpoint
    • 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.v1.tasks.pushNotificationConfigs

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/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 :

    • name
    • a2aEndpoint
    • 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.a2aGetReasoningEngine

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^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 :

    • name
    • a2aEndpoint
    • 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.subscribe

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/tasks/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • name
    • a2aEndpoint
    • 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.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine

      Path : v1beta1/{+name}/a2a/{+a2aEndpoint}

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/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 : ^v1/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 :

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

      Description : Get request for reasoning engine instance via the A2A get protocol apis.