AI Platform Training & Prediction API (Vizier)

An API for optimization. This reference documentation describes the AI Platform Vizier-related methods of the AI Platform Training and Prediction API. For details about other parts of the API, see the following:


We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:


REST Resource: v1.projects.locations.operations

cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.

REST Resource: v1.projects.locations.studies

create POST /v1/{parent=projects/*/locations/*}/studies
Creates a study.
delete DELETE /v1/{name=projects/*/locations/*/studies/*}
Deletes a study.
get GET /v1/{name=projects/*/locations/*/studies/*}
Gets a study.
list GET /v1/{parent=projects/*/locations/*}/studies
Lists all the studies in a region for an associated project.

REST Resource: v1.projects.locations.studies.trials

addMeasurement POST /v1/{name=projects/*/locations/*/studies/*/trials/*}:addMeasurement
Adds a measurement of the objective metrics to a trial.
checkEarlyStoppingState POST /v1/{name=projects/*/locations/*/studies/*/trials/*}:checkEarlyStoppingState
Checks whether a trial should stop or not.
complete POST /v1/{name=projects/*/locations/*/studies/*/trials/*}:complete
Marks a trial as complete.
create POST /v1/{parent=projects/*/locations/*/studies/*}/trials
Adds a user provided trial to a study.
delete DELETE /v1/{name=projects/*/locations/*/studies/*/trials/*}
Deletes a trial.
get GET /v1/{name=projects/*/locations/*/studies/*/trials/*}
Gets a trial.
list GET /v1/{parent=projects/*/locations/*/studies/*}/trials
Lists the trials associated with a study.
stop POST /v1/{name=projects/*/locations/*/studies/*/trials/*}:stop
Stops a trial.
suggest POST /v1/{parent=projects/*/locations/*/studies/*}/trials:suggest
Adds one or more trials to a study, with parameter values suggested by AI Platform Vizier.