Vertex AI API

Train high-quality custom machine learning models with minimal machine learning expertise and effort.

Service: aiplatform.googleapis.com

To call this service, we recommend that you use the Google-providedclient libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

ADiscovery 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 documents:

Service endpoint

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

  • https://aiplatform.googleapis.com
  • https://africa-south1-aiplatform.googleapis.com
  • https://asia-east1-aiplatform.googleapis.com
  • https://asia-east2-aiplatform.googleapis.com
  • https://asia-northeast1-aiplatform.googleapis.com
  • https://asia-northeast2-aiplatform.googleapis.com
  • https://asia-northeast3-aiplatform.googleapis.com
  • https://asia-south1-aiplatform.googleapis.com
  • https://asia-southeast1-aiplatform.googleapis.com
  • https://asia-southeast2-aiplatform.googleapis.com
  • https://australia-southeast1-aiplatform.googleapis.com
  • https://australia-southeast2-aiplatform.googleapis.com
  • https://europe-central2-aiplatform.googleapis.com
  • https://europe-north1-aiplatform.googleapis.com
  • https://europe-southwest1-aiplatform.googleapis.com
  • https://europe-west1-aiplatform.googleapis.com
  • https://europe-west2-aiplatform.googleapis.com
  • https://europe-west3-aiplatform.googleapis.com
  • https://europe-west4-aiplatform.googleapis.com
  • https://europe-west6-aiplatform.googleapis.com
  • https://europe-west8-aiplatform.googleapis.com
  • https://europe-west9-aiplatform.googleapis.com
  • https://europe-west12-aiplatform.googleapis.com
  • https://me-central1-aiplatform.googleapis.com
  • https://me-central2-aiplatform.googleapis.com
  • https://me-west1-aiplatform.googleapis.com
  • https://northamerica-northeast1-aiplatform.googleapis.com
  • https://northamerica-northeast2-aiplatform.googleapis.com
  • https://southamerica-east1-aiplatform.googleapis.com
  • https://southamerica-west1-aiplatform.googleapis.com
  • https://us-central1-aiplatform.googleapis.com
  • https://us-east1-aiplatform.googleapis.com
  • https://us-east4-aiplatform.googleapis.com
  • https://us-south1-aiplatform.googleapis.com
  • https://us-west1-aiplatform.googleapis.com
  • https://us-west2-aiplatform.googleapis.com
  • https://us-west3-aiplatform.googleapis.com
  • https://us-west4-aiplatform.googleapis.com
  • https://us-east5-aiplatform.googleapis.com

SeeFeature availability for the supported features for each region.

REST Resource:v1.media

Methods
uploadPOST /v1/{parent}/ragFiles:upload
POST /upload/v1/{parent}/ragFiles:upload
Upload a file into a RagCorpus.

REST Resource:v1.operations

Methods
cancelPOST /v1/{name}:cancel
Starts asynchronous cancellation on a long-running operation.
deleteDELETE /v1/{name}
Deletes a long-running operation.
getGET /v1/{name}
Gets the latest state of a long-running operation.
listGET /v1/operations
Lists operations that match the specified filter in the request.
waitPOST /v1/{name}:wait
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.

REST Resource:v1.projects.locations

Methods
augmentPromptPOST /v1/{parent}:augmentPrompt
Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.
corroborateContentPOST /v1/{parent}:corroborateContent
Given an input text, it returns a score that evaluates the factuality of the text.
deployPOST /v1/{destination}:deploy
Deploys a model to a new endpoint.
evaluateInstancesPOST /v1/{location}:evaluateInstances
Evaluates instances based on a given metric.
getRagEngineConfigGET /v1/{name}
Gets a RagEngineConfig.
retrieveContextsPOST /v1/{parent}:retrieveContexts
Retrieves relevant contexts for a query.
updateRagEngineConfigPATCH /v1/{ragEngineConfig.name}
Updates a RagEngineConfig.

REST Resource:v1.projects.locations.batchPredictionJobs

Methods
cancelPOST /v1/{name}:cancel
Cancels a BatchPredictionJob.
createPOST /v1/{parent}/batchPredictionJobs
Creates a BatchPredictionJob.
deleteDELETE /v1/{name}
Deletes a BatchPredictionJob.
getGET /v1/{name}
Gets a BatchPredictionJob
listGET /v1/{parent}/batchPredictionJobs
Lists BatchPredictionJobs in a Location.

REST Resource:v1.projects.locations.cachedContents

Methods
createPOST /v1/{parent}/cachedContents
Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.
deleteDELETE /v1/{name}
Deletes cached content
getGET /v1/{name}
Gets cached content configurations
listGET /v1/{parent}/cachedContents
Lists cached contents in a project
patchPATCH /v1/{cachedContent.name}
Updates cached content configurations

REST Resource:v1.projects.locations.customJobs

Methods
cancelPOST /v1/{name}:cancel
Cancels a CustomJob.
createPOST /v1/{parent}/customJobs
Creates a CustomJob.
deleteDELETE /v1/{name}
Deletes a CustomJob.
getGET /v1/{name}
Gets a CustomJob.
listGET /v1/{parent}/customJobs
Lists CustomJobs in a Location.

REST Resource:v1.projects.locations.datasets

Methods
createPOST /v1/{parent}/datasets
Creates a Dataset.
deleteDELETE /v1/{name}
Deletes a Dataset.
exportPOST /v1/{name}:export
Exports data from a Dataset.
getGET /v1/{name}
Gets a Dataset.
importPOST /v1/{name}:import
Imports data into a Dataset.
listGET /v1/{parent}/datasets
Lists Datasets in a Location.
patchPATCH /v1/{dataset.name}
Updates a Dataset.
searchDataItemsGET /v1/{dataset}:searchDataItems
Searches DataItems in a Dataset.

REST Resource:v1.projects.locations.datasets.annotationSpecs

Methods
getGET /v1/{name}
Gets an AnnotationSpec.

REST Resource:v1.projects.locations.datasets.dataItems

Methods
listGET /v1/{parent}/dataItems
Lists DataItems in a Dataset.

REST Resource:v1.projects.locations.datasets.dataItems.annotations

Methods
listGET /v1/{parent}/annotations
Lists Annotations belongs to a dataitem.

REST Resource:v1.projects.locations.datasets.datasetVersions

Methods
createPOST /v1/{parent}/datasetVersions
Create a version from a Dataset.
deleteDELETE /v1/{name}
Deletes a Dataset version.
getGET /v1/{name}
Gets a Dataset version.
listGET /v1/{parent}/datasetVersions
Lists DatasetVersions in a Dataset.
patchPATCH /v1/{datasetVersion.name}
Updates a DatasetVersion.
restoreGET /v1/{name}:restore
Restores a dataset version.

REST Resource:v1.projects.locations.datasets.savedQueries

Methods
deleteDELETE /v1/{name}
Deletes a SavedQuery.
listGET /v1/{parent}/savedQueries
Lists SavedQueries in a Dataset.

REST Resource:v1.projects.locations.deploymentResourcePools

Methods
createPOST /v1/{parent}/deploymentResourcePools
Create a DeploymentResourcePool.
deleteDELETE /v1/{name}
Delete a DeploymentResourcePool.
getGET /v1/{name}
Get a DeploymentResourcePool.
listGET /v1/{parent}/deploymentResourcePools
List DeploymentResourcePools in a location.
patchPATCH /v1/{deploymentResourcePool.name}
Update a DeploymentResourcePool.
queryDeployedModelsGET /v1/{deploymentResourcePool}:queryDeployedModels
List DeployedModels that have been deployed on this DeploymentResourcePool.

REST Resource:v1.projects.locations.endpoints

Methods
createPOST /v1/{parent}/endpoints
Creates an Endpoint.
deleteDELETE /v1/{name}
Deletes an Endpoint.
deployModelPOST /v1/{endpoint}:deployModel
Deploys a Model into this Endpoint, creating a DeployedModel within it.
directPredictPOST /v1/{endpoint}:directPredict
Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.
directRawPredictPOST /v1/{endpoint}:directRawPredict
Perform an unary online prediction request to a gRPC model server for custom containers.
explainPOST /v1/{endpoint}:explain
Perform an online explanation.
getGET /v1/{name}
Gets an Endpoint.
listGET /v1/{parent}/endpoints
Lists Endpoints in a Location.
mutateDeployedModelPOST /v1/{endpoint}:mutateDeployedModel
Updates an existing deployed model.
patchPATCH /v1/{endpoint.name}
Updates an Endpoint.
predictPOST /v1/{endpoint}:predict
Perform an online prediction.
predictLongRunningPOST /v1/{endpoint}:predictLongRunning
rawPredictPOST /v1/{endpoint}:rawPredict
Perform an online prediction with an arbitrary HTTP payload.
serverStreamingPredictPOST /v1/{endpoint}:serverStreamingPredict
Perform a server-side streaming online prediction request for Vertex LLM streaming.
streamRawPredictPOST /v1/{endpoint}:streamRawPredict
Perform a streaming online prediction with an arbitrary HTTP payload.
undeployModelPOST /v1/{endpoint}:undeployModel
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
updatePOST /v1/{endpoint.name}:update
Updates an Endpoint with a long running operation.

REST Resource:v1.projects.locations.featureGroups

Methods
createPOST /v1/{parent}/featureGroups
Creates a new FeatureGroup in a given project and location.
deleteDELETE /v1/{name}
Deletes a single FeatureGroup.
getGET /v1/{name}
Gets details of a single FeatureGroup.
getIamPolicyPOST /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent}/featureGroups
Lists FeatureGroups in a given project and location.
patchPATCH /v1/{featureGroup.name}
Updates the parameters of a single FeatureGroup.
setIamPolicyPOST /v1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource:v1.projects.locations.featureGroups.features

Methods
batchCreatePOST /v1/{parent}/features:batchCreate
Creates a batch of Features in a given FeatureGroup.
createPOST /v1/{parent}/features
Creates a new Feature in a given FeatureGroup.
deleteDELETE /v1/{name}
Deletes a single Feature.
getGET /v1/{name}
Gets details of a single Feature.
listGET /v1/{parent}/features
Lists Features in a given FeatureGroup.
patchPATCH /v1/{feature.name}
Updates the parameters of a single Feature.

REST Resource:v1.projects.locations.featureOnlineStores

Methods
createPOST /v1/{parent}/featureOnlineStores
Creates a new FeatureOnlineStore in a given project and location.
deleteDELETE /v1/{name}
Deletes a single FeatureOnlineStore.
getGET /v1/{name}
Gets details of a single FeatureOnlineStore.
getIamPolicyPOST /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent}/featureOnlineStores
Lists FeatureOnlineStores in a given project and location.
patchPATCH /v1/{featureOnlineStore.name}
Updates the parameters of a single FeatureOnlineStore.
setIamPolicyPOST /v1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource:v1.projects.locations.featureOnlineStores.featureViews

Methods
createPOST /v1/{parent}/featureViews
Creates a new FeatureView in a given FeatureOnlineStore.
deleteDELETE /v1/{name}
Deletes a single FeatureView.
directWritePOST /v1/{featureView}:directWrite
Bidirectional streaming RPC to directly write to feature values in a feature view.
fetchFeatureValuesPOST /v1/{featureView}:fetchFeatureValues
Fetch feature values under a FeatureView.
generateFetchAccessTokenPOST /v1/{featureView}:generateFetchAccessToken
RPC to generate an access token for the given feature view.
getGET /v1/{name}
Gets details of a single FeatureView.
getIamPolicyPOST /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent}/featureViews
Lists FeatureViews in a given FeatureOnlineStore.
patchPATCH /v1/{featureView.name}
Updates the parameters of a single FeatureView.
searchNearestEntitiesPOST /v1/{featureView}:searchNearestEntities
Search the nearest entities under a FeatureView.
setIamPolicyPOST /v1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
syncPOST /v1/{featureView}:sync
Triggers on-demand sync for the FeatureView.
testIamPermissionsPOST /v1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource:v1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs

Methods
getGET /v1/{name}
Gets details of a single FeatureViewSync.
listGET /v1/{parent}/featureViewSyncs
Lists FeatureViewSyncs in a given FeatureView.

REST Resource:v1.projects.locations.featurestores

Methods
batchReadFeatureValuesPOST /v1/{featurestore}:batchReadFeatureValues
Batch reads Feature values from a Featurestore.
createPOST /v1/{parent}/featurestores
Creates a new Featurestore in a given project and location.
deleteDELETE /v1/{name}
Deletes a single Featurestore.
getGET /v1/{name}
Gets details of a single Featurestore.
getIamPolicyPOST /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent}/featurestores
Lists Featurestores in a given project and location.
patchPATCH /v1/{featurestore.name}
Updates the parameters of a single Featurestore.
searchFeaturesGET /v1/{location}/featurestores:searchFeatures
Searches Features matching a query in a given project.
setIamPolicyPOST /v1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource:v1.projects.locations.featurestores.entityTypes

Methods
createPOST /v1/{parent}/entityTypes
Creates a new EntityType in a given Featurestore.
deleteDELETE /v1/{name}
Deletes a single EntityType.
deleteFeatureValuesPOST /v1/{entityType}:deleteFeatureValues
Delete Feature values from Featurestore.
exportFeatureValuesPOST /v1/{entityType}:exportFeatureValues
Exports Feature values from all the entities of a target EntityType.
getGET /v1/{name}
Gets details of a single EntityType.
getIamPolicyPOST /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
importFeatureValuesPOST /v1/{entityType}:importFeatureValues
Imports Feature values into the Featurestore from a source storage.
listGET /v1/{parent}/entityTypes
Lists EntityTypes in a given Featurestore.
patchPATCH /v1/{entityType.name}
Updates the parameters of a single EntityType.
readFeatureValuesPOST /v1/{entityType}:readFeatureValues
Reads Feature values of a specific entity of an EntityType.
setIamPolicyPOST /v1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
streamingReadFeatureValuesPOST /v1/{entityType}:streamingReadFeatureValues
Reads Feature values for multiple entities.
testIamPermissionsPOST /v1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.
writeFeatureValuesPOST /v1/{entityType}:writeFeatureValues
Writes Feature values of one or more entities of an EntityType.

REST Resource:v1.projects.locations.featurestores.entityTypes.features

Methods
batchCreatePOST /v1/{parent}/features:batchCreate
Creates a batch of Features in a given EntityType.
createPOST /v1/{parent}/features
Creates a new Feature in a given EntityType.
deleteDELETE /v1/{name}
Deletes a single Feature.
getGET /v1/{name}
Gets details of a single Feature.
listGET /v1/{parent}/features
Lists Features in a given EntityType.
patchPATCH /v1/{feature.name}
Updates the parameters of a single Feature.

REST Resource:v1.projects.locations.hyperparameterTuningJobs

Methods
cancelPOST /v1/{name}:cancel
Cancels a HyperparameterTuningJob.
createPOST /v1/{parent}/hyperparameterTuningJobs
Creates a HyperparameterTuningJob
deleteDELETE /v1/{name}
Deletes a HyperparameterTuningJob.
getGET /v1/{name}
Gets a HyperparameterTuningJob
listGET /v1/{parent}/hyperparameterTuningJobs
Lists HyperparameterTuningJobs in a Location.

REST Resource:v1.projects.locations.indexEndpoints

Methods
createPOST /v1/{parent}/indexEndpoints
Creates an IndexEndpoint.
deleteDELETE /v1/{name}
Deletes an IndexEndpoint.
deployIndexPOST /v1/{indexEndpoint}:deployIndex
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
getGET /v1/{name}
Gets an IndexEndpoint.
listGET /v1/{parent}/indexEndpoints
Lists IndexEndpoints in a Location.
mutateDeployedIndexPOST /v1/{indexEndpoint}:mutateDeployedIndex
Update an existing DeployedIndex under an IndexEndpoint.
patchPATCH /v1/{indexEndpoint.name}
Updates an IndexEndpoint.
undeployIndexPOST /v1/{indexEndpoint}:undeployIndex
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

REST Resource:v1.projects.locations.indexes

Methods
createPOST /v1/{parent}/indexes
Creates an Index.
deleteDELETE /v1/{name}
Deletes an Index.
getGET /v1/{name}
Gets an Index.
listGET /v1/{parent}/indexes
Lists Indexes in a Location.
patchPATCH /v1/{index.name}
Updates an Index.
removeDatapointsPOST /v1/{index}:removeDatapoints
Remove Datapoints from an Index.
upsertDatapointsPOST /v1/{index}:upsertDatapoints
Add/update Datapoints into an Index.

REST Resource:v1.projects.locations.metadataStores

Methods
createPOST /v1/{parent}/metadataStores
Initializes a MetadataStore, including allocation of resources.
deleteDELETE /v1/{name}
Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
getGET /v1/{name}
Retrieves a specific MetadataStore.
listGET /v1/{parent}/metadataStores
Lists MetadataStores for a Location.

REST Resource:v1.projects.locations.metadataStores.artifacts

Methods
createPOST /v1/{parent}/artifacts
Creates an Artifact associated with a MetadataStore.
deleteDELETE /v1/{name}
Deletes an Artifact.
getGET /v1/{name}
Retrieves a specific Artifact.
listGET /v1/{parent}/artifacts
Lists Artifacts in the MetadataStore.
patchPATCH /v1/{artifact.name}
Updates a stored Artifact.
purgePOST /v1/{parent}/artifacts:purge
Purges Artifacts.
queryArtifactLineageSubgraphGET /v1/{artifact}:queryArtifactLineageSubgraph
Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.

REST Resource:v1.projects.locations.metadataStores.contexts

Methods
addContextArtifactsAndExecutionsPOST /v1/{context}:addContextArtifactsAndExecutions
Adds a set of Artifacts and Executions to a Context.
addContextChildrenPOST /v1/{context}:addContextChildren
Adds a set of Contexts as children to a parent Context.
createPOST /v1/{parent}/contexts
Creates a Context associated with a MetadataStore.
deleteDELETE /v1/{name}
Deletes a stored Context.
getGET /v1/{name}
Retrieves a specific Context.
listGET /v1/{parent}/contexts
Lists Contexts on the MetadataStore.
patchPATCH /v1/{context.name}
Updates a stored Context.
purgePOST /v1/{parent}/contexts:purge
Purges Contexts.
queryContextLineageSubgraphGET /v1/{context}:queryContextLineageSubgraph
Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
removeContextChildrenPOST /v1/{context}:removeContextChildren
Remove a set of children contexts from a parent Context.

REST Resource:v1.projects.locations.metadataStores.executions

Methods
addExecutionEventsPOST /v1/{execution}:addExecutionEvents
Adds Events to the specified Execution.
createPOST /v1/{parent}/executions
Creates an Execution associated with a MetadataStore.
deleteDELETE /v1/{name}
Deletes an Execution.
getGET /v1/{name}
Retrieves a specific Execution.
listGET /v1/{parent}/executions
Lists Executions in the MetadataStore.
patchPATCH /v1/{execution.name}
Updates a stored Execution.
purgePOST /v1/{parent}/executions:purge
Purges Executions.
queryExecutionInputsAndOutputsGET /v1/{execution}:queryExecutionInputsAndOutputs
Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.

REST Resource:v1.projects.locations.metadataStores.metadataSchemas

Methods
createPOST /v1/{parent}/metadataSchemas
Creates a MetadataSchema.
getGET /v1/{name}
Retrieves a specific MetadataSchema.
listGET /v1/{parent}/metadataSchemas
Lists MetadataSchemas.

REST Resource:v1.projects.locations.migratableResources

Methods
batchMigratePOST /v1/{parent}/migratableResources:batchMigrate
Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
searchPOST /v1/{parent}/migratableResources:search
Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

REST Resource:v1.projects.locations.modelDeploymentMonitoringJobs

Methods
createPOST /v1/{parent}/modelDeploymentMonitoringJobs
Creates a ModelDeploymentMonitoringJob.
deleteDELETE /v1/{name}
Deletes a ModelDeploymentMonitoringJob.
getGET /v1/{name}
Gets a ModelDeploymentMonitoringJob.
listGET /v1/{parent}/modelDeploymentMonitoringJobs
Lists ModelDeploymentMonitoringJobs in a Location.
patchPATCH /v1/{modelDeploymentMonitoringJob.name}
Updates a ModelDeploymentMonitoringJob.
pausePOST /v1/{name}:pause
Pauses a ModelDeploymentMonitoringJob.
resumePOST /v1/{name}:resume
Resumes a paused ModelDeploymentMonitoringJob.
searchModelDeploymentMonitoringStatsAnomaliesPOST /v1/{modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies
Searches Model Monitoring Statistics generated within a given time window.

REST Resource:v1.projects.locations.models

Methods
copyPOST /v1/{parent}/models:copy
Copies an already existing Vertex AI Model into the specified Location.
deleteDELETE /v1/{name}
Deletes a Model.
deleteVersionDELETE /v1/{name}:deleteVersion
Deletes a Model version.
exportPOST /v1/{name}:export
Exports a trained, exportable Model to a location specified by the user.
getGET /v1/{name}
Gets a Model.
getIamPolicyPOST /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent}/models
Lists Models in a Location.
listCheckpointsGET /v1/{name}:listCheckpoints
Lists checkpoints of the specified model version.
listVersionsGET /v1/{name}:listVersions
Lists versions of the specified model.
mergeVersionAliasesPOST /v1/{name}:mergeVersionAliases
Merges a set of aliases for a Model version.
patchPATCH /v1/{model.name}
Updates a Model.
setIamPolicyPOST /v1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.
updateExplanationDatasetPOST /v1/{model}:updateExplanationDataset
Incrementally update the dataset used for an examples model.
uploadPOST /v1/{parent}/models:upload
Uploads a Model artifact into Vertex AI.

REST Resource:v1.projects.locations.models.evaluations

Methods
getGET /v1/{name}
Gets a ModelEvaluation.
importPOST /v1/{parent}/evaluations:import
Imports an externally generated ModelEvaluation.
listGET /v1/{parent}/evaluations
Lists ModelEvaluations in a Model.

REST Resource:v1.projects.locations.models.evaluations.slices

Methods
batchImportPOST /v1/{parent}:batchImport
Imports a list of externally generated EvaluatedAnnotations.
getGET /v1/{name}
Gets a ModelEvaluationSlice.
listGET /v1/{parent}/slices
Lists ModelEvaluationSlices in a ModelEvaluation.

REST Resource:v1.projects.locations.nasJobs

Methods
cancelPOST /v1/{name}:cancel
Cancels a NasJob.
createPOST /v1/{parent}/nasJobs
Creates a NasJob
deleteDELETE /v1/{name}
Deletes a NasJob.
getGET /v1/{name}
Gets a NasJob
listGET /v1/{parent}/nasJobs
Lists NasJobs in a Location.

REST Resource:v1.projects.locations.nasJobs.nasTrialDetails

Methods
getGET /v1/{name}
Gets a NasTrialDetail.
listGET /v1/{parent}/nasTrialDetails
List top NasTrialDetails of a NasJob.

REST Resource:v1.projects.locations.notebookExecutionJobs

Methods
createPOST /v1/{parent}/notebookExecutionJobs
Creates a NotebookExecutionJob.
deleteDELETE /v1/{name}
Deletes a NotebookExecutionJob.
getGET /v1/{name}
Gets a NotebookExecutionJob.
listGET /v1/{parent}/notebookExecutionJobs
Lists NotebookExecutionJobs in a Location.

REST Resource:v1.projects.locations.notebookRuntimeTemplates

Methods
createPOST /v1/{parent}/notebookRuntimeTemplates
Creates a NotebookRuntimeTemplate.
deleteDELETE /v1/{name}
Deletes a NotebookRuntimeTemplate.
getGET /v1/{name}
Gets a NotebookRuntimeTemplate.
getIamPolicyPOST /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent}/notebookRuntimeTemplates
Lists NotebookRuntimeTemplates in a Location.
patchPATCH /v1/{notebookRuntimeTemplate.name}
Updates a NotebookRuntimeTemplate.
setIamPolicyPOST /v1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource:v1.projects.locations.notebookRuntimes

Methods
assignPOST /v1/{parent}/notebookRuntimes:assign
Assigns a NotebookRuntime to a user for a particular Notebook file.
deleteDELETE /v1/{name}
Deletes a NotebookRuntime.
getGET /v1/{name}
Gets a NotebookRuntime.
listGET /v1/{parent}/notebookRuntimes
Lists NotebookRuntimes in a Location.
startPOST /v1/{name}:start
Starts a NotebookRuntime.
stopPOST /v1/{name}:stop
Stops a NotebookRuntime.
upgradePOST /v1/{name}:upgrade
Upgrades a NotebookRuntime.

REST Resource:v1.projects.locations.operations

Methods
cancelPOST /v1/{name}:cancel
Starts asynchronous cancellation on a long-running operation.
deleteDELETE /v1/{name}
Deletes a long-running operation.
getGET /v1/{name}
Gets the latest state of a long-running operation.
listGET /v1/{name}/operations
Lists operations that match the specified filter in the request.
waitPOST /v1/{name}:wait
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.

REST Resource:v1.projects.locations.persistentResources

Methods
createPOST /v1/{parent}/persistentResources
Creates a PersistentResource.
deleteDELETE /v1/{name}
Deletes a PersistentResource.
getGET /v1/{name}
Gets a PersistentResource.
listGET /v1/{parent}/persistentResources
Lists PersistentResources in a Location.
patchPATCH /v1/{persistentResource.name}
Updates a PersistentResource.
rebootPOST /v1/{name}:reboot
Reboots a PersistentResource.

REST Resource:v1.projects.locations.pipelineJobs

Methods
batchCancelPOST /v1/{parent}/pipelineJobs:batchCancel
Batch cancel PipelineJobs.
batchDeletePOST /v1/{parent}/pipelineJobs:batchDelete
Batch deletes PipelineJobs The Operation is atomic.
cancelPOST /v1/{name}:cancel
Cancels a PipelineJob.
createPOST /v1/{parent}/pipelineJobs
Creates a PipelineJob.
deleteDELETE /v1/{name}
Deletes a PipelineJob.
getGET /v1/{name}
Gets a PipelineJob.
listGET /v1/{parent}/pipelineJobs
Lists PipelineJobs in a Location.

REST Resource:v1.projects.locations.publishers.models

Methods
embedContentPOST /v1/{model}:embedContent
Embed content with multimodal inputs.
predictPOST /v1/{endpoint}:predict
Perform an online prediction.
predictLongRunningPOST /v1/{endpoint}:predictLongRunning
rawPredictPOST /v1/{endpoint}:rawPredict
Perform an online prediction with an arbitrary HTTP payload.
serverStreamingPredictPOST /v1/{endpoint}:serverStreamingPredict
Perform a server-side streaming online prediction request for Vertex LLM streaming.
streamRawPredictPOST /v1/{endpoint}:streamRawPredict
Perform a streaming online prediction with an arbitrary HTTP payload.

REST Resource:v1.projects.locations.ragCorpora

Methods
createPOST /v1/{parent}/ragCorpora
Creates a RagCorpus.
deleteDELETE /v1/{name}
Deletes a RagCorpus.
getGET /v1/{name}
Gets a RagCorpus.
listGET /v1/{parent}/ragCorpora
Lists RagCorpora in a Location.
patchPATCH /v1/{ragCorpus.name}
Updates a RagCorpus.

REST Resource:v1.projects.locations.ragCorpora.ragFiles

Methods
deleteDELETE /v1/{name}
Deletes a RagFile.
getGET /v1/{name}
Gets a RagFile.
importPOST /v1/{parent}/ragFiles:import
Import files from Google Cloud Storage or Google Drive into a RagCorpus.
listGET /v1/{parent}/ragFiles
Lists RagFiles in a RagCorpus.

REST Resource:v1.projects.locations.reasoningEngines

Methods
createPOST /v1/{parent}/reasoningEngines
Creates a reasoning engine.
deleteDELETE /v1/{name}
Deletes a reasoning engine.
getGET /v1/{name}
Gets a reasoning engine.
listGET /v1/{parent}/reasoningEngines
Lists reasoning engines in a location.
patchPATCH /v1/{reasoningEngine.name}
Updates a reasoning engine.
queryPOST /v1/{name}:query
Queries using a reasoning engine.
streamQueryPOST /v1/{name}:streamQuery
Streams queries using a reasoning engine.

REST Resource:v1.projects.locations.schedules

Methods
createPOST /v1/{parent}/schedules
Creates a Schedule.
deleteDELETE /v1/{name}
Deletes a Schedule.
getGET /v1/{name}
Gets a Schedule.
listGET /v1/{parent}/schedules
Lists Schedules in a Location.
patchPATCH /v1/{schedule.name}
Updates an active or paused Schedule.
pausePOST /v1/{name}:pause
Pauses a Schedule.
resumePOST /v1/{name}:resume
Resumes a paused Schedule to start scheduling new runs.

REST Resource:v1.projects.locations.specialistPools

Methods
createPOST /v1/{parent}/specialistPools
Creates a SpecialistPool.
deleteDELETE /v1/{name}
Deletes a SpecialistPool as well as all Specialists in the pool.
getGET /v1/{name}
Gets a SpecialistPool.
listGET /v1/{parent}/specialistPools
Lists SpecialistPools in a Location.
patchPATCH /v1/{specialistPool.name}
Updates a SpecialistPool.

REST Resource:v1.projects.locations.studies

Methods
createPOST /v1/{parent}/studies
Creates a Study.
deleteDELETE /v1/{name}
Deletes a Study.
getGET /v1/{name}
Gets a Study by name.
listGET /v1/{parent}/studies
Lists all the studies in a region for an associated project.
lookupPOST /v1/{parent}/studies:lookup
Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

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

Methods
addTrialMeasurementPOST /v1/{trialName}:addTrialMeasurement
Adds a measurement of the objective metrics to a Trial.
checkTrialEarlyStoppingStatePOST /v1/{trialName}:checkTrialEarlyStoppingState
Checks whether a Trial should stop or not.
completePOST /v1/{name}:complete
Marks a Trial as complete.
createPOST /v1/{parent}/trials
Adds a user provided Trial to a Study.
deleteDELETE /v1/{name}
Deletes a Trial.
getGET /v1/{name}
Gets a Trial.
listGET /v1/{parent}/trials
Lists the Trials associated with a Study.
listOptimalTrialsPOST /v1/{parent}/trials:listOptimalTrials
Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
stopPOST /v1/{name}:stop
Stops a Trial.
suggestPOST /v1/{parent}/trials:suggest
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.

REST Resource:v1.projects.locations.tensorboards

Methods
batchReadGET /v1/{tensorboard}:batchRead
Reads multiple TensorboardTimeSeries' data.
createPOST /v1/{parent}/tensorboards
Creates a Tensorboard.
deleteDELETE /v1/{name}
Deletes a Tensorboard.
getGET /v1/{name}
Gets a Tensorboard.
listGET /v1/{parent}/tensorboards
Lists Tensorboards in a Location.
patchPATCH /v1/{tensorboard.name}
Updates a Tensorboard.
readSizeGET /v1/{tensorboard}:readSize
Returns the storage size for a given TensorBoard instance.
readUsageGET /v1/{tensorboard}:readUsage
Returns a list of monthly active users for a given TensorBoard instance.

REST Resource:v1.projects.locations.tensorboards.experiments

Methods
batchCreatePOST /v1/{parent}:batchCreate
Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
createPOST /v1/{parent}/experiments
Creates a TensorboardExperiment.
deleteDELETE /v1/{name}
Deletes a TensorboardExperiment.
getGET /v1/{name}
Gets a TensorboardExperiment.
listGET /v1/{parent}/experiments
Lists TensorboardExperiments in a Location.
patchPATCH /v1/{tensorboardExperiment.name}
Updates a TensorboardExperiment.
writePOST /v1/{tensorboardExperiment}:write
Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's.

REST Resource:v1.projects.locations.tensorboards.experiments.runs

Methods
batchCreatePOST /v1/{parent}/runs:batchCreate
Batch create TensorboardRuns.
createPOST /v1/{parent}/runs
Creates a TensorboardRun.
deleteDELETE /v1/{name}
Deletes a TensorboardRun.
getGET /v1/{name}
Gets a TensorboardRun.
listGET /v1/{parent}/runs
Lists TensorboardRuns in a Location.
patchPATCH /v1/{tensorboardRun.name}
Updates a TensorboardRun.
writePOST /v1/{tensorboardRun}:write
Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun.

REST Resource:v1.projects.locations.tensorboards.experiments.runs.timeSeries

Methods
createPOST /v1/{parent}/timeSeries
Creates a TensorboardTimeSeries.
deleteDELETE /v1/{name}
Deletes a TensorboardTimeSeries.
exportTensorboardTimeSeriesPOST /v1/{tensorboardTimeSeries}:exportTensorboardTimeSeries
Exports a TensorboardTimeSeries' data.
getGET /v1/{name}
Gets a TensorboardTimeSeries.
listGET /v1/{parent}/timeSeries
Lists TensorboardTimeSeries in a Location.
patchPATCH /v1/{tensorboardTimeSeries.name}
Updates a TensorboardTimeSeries.
readGET /v1/{tensorboardTimeSeries}:read
Reads a TensorboardTimeSeries' data.
readBlobDataGET /v1/{timeSeries}:readBlobData
Gets bytes of TensorboardBlobs.

REST Resource:v1.projects.locations.trainingPipelines

Methods
cancelPOST /v1/{name}:cancel
Cancels a TrainingPipeline.
createPOST /v1/{parent}/trainingPipelines
Creates a TrainingPipeline.
deleteDELETE /v1/{name}
Deletes a TrainingPipeline.
getGET /v1/{name}
Gets a TrainingPipeline.
listGET /v1/{parent}/trainingPipelines
Lists TrainingPipelines in a Location.

REST Resource:v1.projects.locations.tuningJobs

Methods
cancelPOST /v1/{name}:cancel
Cancels a TuningJob.
createPOST /v1/{parent}/tuningJobs
Creates a TuningJob.
getGET /v1/{name}
Gets a TuningJob.
listGET /v1/{parent}/tuningJobs
Lists TuningJobs in a Location.
rebaseTunedModelPOST /v1/{parent}/tuningJobs:rebaseTunedModel
Rebase a TunedModel.

REST Resource:v1.publishers.models

Methods
getGET /v1/{name}
Gets a Model Garden publisher model.

REST Resource:v1beta1.media

Methods
uploadPOST /v1beta1/{parent}/ragFiles:upload
POST /upload/v1beta1/{parent}/ragFiles:upload
Upload a file into a RagCorpus.

REST Resource:v1beta1.operations

Methods
cancelPOST /v1beta1/{name}:cancel
Starts asynchronous cancellation on a long-running operation.
deleteDELETE /v1beta1/{name}
Deletes a long-running operation.
getGET /v1beta1/{name}
Gets the latest state of a long-running operation.
listGET /v1beta1/operations
Lists operations that match the specified filter in the request.
waitPOST /v1beta1/{name}:wait
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.

REST Resource:v1beta1.projects

Methods
fetchPublisherModelConfigGET /v1beta1/{name}:fetchPublisherModelConfig
Fetches the configs of publisher models.
setPublisherModelConfigPOST /v1beta1/{name}:setPublisherModelConfig
Sets (creates or updates) configs of publisher models.

REST Resource:v1beta1.projects.locations

Methods
augmentPromptPOST /v1beta1/{parent}:augmentPrompt
Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.
corroborateContentPOST /v1beta1/{parent}:corroborateContent
Given an input text, it returns a score that evaluates the factuality of the text.
deployPOST /v1beta1/{destination}:deploy
Deploys a model to a new endpoint.
deployPublisherModel
(deprecated)
POST /v1beta1/{destination}:deployPublisherModel
Deploys publisher models.
evaluateDatasetPOST /v1beta1/{location}:evaluateDataset
Evaluates a dataset based on a set of given metrics.
evaluateInstancesPOST /v1beta1/{location}:evaluateInstances
Evaluates instances based on a given metric.
getRagEngineConfigGET /v1beta1/{name}
Gets a RagEngineConfig.
recommendSpecPOST /v1beta1/{parent}:recommendSpec
Gets a Model's spec recommendations.
retrieveContextsPOST /v1beta1/{parent}:retrieveContexts
Retrieves relevant contexts for a query.
updateRagEngineConfigPATCH /v1beta1/{ragEngineConfig.name}
Updates a RagEngineConfig.

REST Resource:v1beta1.projects.locations.batchPredictionJobs

Methods
cancelPOST /v1beta1/{name}:cancel
Cancels a BatchPredictionJob.
createPOST /v1beta1/{parent}/batchPredictionJobs
Creates a BatchPredictionJob.
deleteDELETE /v1beta1/{name}
Deletes a BatchPredictionJob.
getGET /v1beta1/{name}
Gets a BatchPredictionJob
listGET /v1beta1/{parent}/batchPredictionJobs
Lists BatchPredictionJobs in a Location.

REST Resource:v1beta1.projects.locations.cachedContents

Methods
createPOST /v1beta1/{parent}/cachedContents
Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.
deleteDELETE /v1beta1/{name}
Deletes cached content
getGET /v1beta1/{name}
Gets cached content configurations
listGET /v1beta1/{parent}/cachedContents
Lists cached contents in a project
patchPATCH /v1beta1/{cachedContent.name}
Updates cached content configurations

REST Resource:v1beta1.projects.locations.customJobs

Methods
cancelPOST /v1beta1/{name}:cancel
Cancels a CustomJob.
createPOST /v1beta1/{parent}/customJobs
Creates a CustomJob.
deleteDELETE /v1beta1/{name}
Deletes a CustomJob.
getGET /v1beta1/{name}
Gets a CustomJob.
listGET /v1beta1/{parent}/customJobs
Lists CustomJobs in a Location.

REST Resource:v1beta1.projects.locations.datasets

Methods
assemblePOST /v1beta1/{name}:assemble
Assembles each row of a multimodal dataset and writes the result into a BigQuery table.
assessPOST /v1beta1/{name}:assess
Assesses the state or validity of the dataset with respect to a given use case.
createPOST /v1beta1/{parent}/datasets
Creates a Dataset.
deleteDELETE /v1beta1/{name}
Deletes a Dataset.
exportPOST /v1beta1/{name}:export
Exports data from a Dataset.
getGET /v1beta1/{name}
Gets a Dataset.
importPOST /v1beta1/{name}:import
Imports data into a Dataset.
listGET /v1beta1/{parent}/datasets
Lists Datasets in a Location.
patchPATCH /v1beta1/{dataset.name}
Updates a Dataset.
searchDataItemsGET /v1beta1/{dataset}:searchDataItems
Searches DataItems in a Dataset.

REST Resource:v1beta1.projects.locations.datasets.annotationSpecs

Methods
getGET /v1beta1/{name}
Gets an AnnotationSpec.

REST Resource:v1beta1.projects.locations.datasets.dataItems

Methods
listGET /v1beta1/{parent}/dataItems
Lists DataItems in a Dataset.

REST Resource:v1beta1.projects.locations.datasets.dataItems.annotations

Methods
listGET /v1beta1/{parent}/annotations
Lists Annotations belongs to a dataitem.

REST Resource:v1beta1.projects.locations.datasets.datasetVersions

Methods
createPOST /v1beta1/{parent}/datasetVersions
Create a version from a Dataset.
deleteDELETE /v1beta1/{name}
Deletes a Dataset version.
getGET /v1beta1/{name}
Gets a Dataset version.
listGET /v1beta1/{parent}/datasetVersions
Lists DatasetVersions in a Dataset.
patchPATCH /v1beta1/{datasetVersion.name}
Updates a DatasetVersion.
restoreGET /v1beta1/{name}:restore
Restores a dataset version.

REST Resource:v1beta1.projects.locations.datasets.savedQueries

Methods
deleteDELETE /v1beta1/{name}
Deletes a SavedQuery.
listGET /v1beta1/{parent}/savedQueries
Lists SavedQueries in a Dataset.

REST Resource:v1beta1.projects.locations.deploymentResourcePools

Methods
createPOST /v1beta1/{parent}/deploymentResourcePools
Create a DeploymentResourcePool.
deleteDELETE /v1beta1/{name}
Delete a DeploymentResourcePool.
getGET /v1beta1/{name}
Get a DeploymentResourcePool.
listGET /v1beta1/{parent}/deploymentResourcePools
List DeploymentResourcePools in a location.
patchPATCH /v1beta1/{deploymentResourcePool.name}
Update a DeploymentResourcePool.
queryDeployedModelsGET /v1beta1/{deploymentResourcePool}:queryDeployedModels
List DeployedModels that have been deployed on this DeploymentResourcePool.

REST Resource:v1beta1.projects.locations.endpoints

Methods
countTokensPOST /v1beta1/{endpoint}:countTokens
Perform a token counting.
createPOST /v1beta1/{parent}/endpoints
Creates an Endpoint.
deleteDELETE /v1beta1/{name}
Deletes an Endpoint.
deployModelPOST /v1beta1/{endpoint}:deployModel
Deploys a Model into this Endpoint, creating a DeployedModel within it.
directPredictPOST /v1beta1/{endpoint}:directPredict
Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.
directRawPredictPOST /v1beta1/{endpoint}:directRawPredict
Perform an unary online prediction request to a gRPC model server for custom containers.
explainPOST /v1beta1/{endpoint}:explain
Perform an online explanation.
getGET /v1beta1/{name}
Gets an Endpoint.
getIamPolicyPOST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1beta1/{parent}/endpoints
Lists Endpoints in a Location.
mutateDeployedModelPOST /v1beta1/{endpoint}:mutateDeployedModel
Updates an existing deployed model.
patchPATCH /v1beta1/{endpoint.name}
Updates an Endpoint.
predictPOST /v1beta1/{endpoint}:predict
Perform an online prediction.
rawPredictPOST /v1beta1/{endpoint}:rawPredict
Perform an online prediction with an arbitrary HTTP payload.
serverStreamingPredictPOST /v1beta1/{endpoint}:serverStreamingPredict
Perform a server-side streaming online prediction request for Vertex LLM streaming.
setIamPolicyPOST /v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
streamRawPredictPOST /v1beta1/{endpoint}:streamRawPredict
Perform a streaming online prediction with an arbitrary HTTP payload.
testIamPermissionsPOST /v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.
undeployModelPOST /v1beta1/{endpoint}:undeployModel
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
updatePOST /v1beta1/{endpoint.name}:update
Updates an Endpoint with a long running operation.

REST Resource:v1beta1.projects.locations.endpoints.chat

Methods
completionsPOST /v1beta1/{endpoint}/chat/completions
Exposes an OpenAI-compatible endpoint for chat completions.

REST Resource:v1beta1.projects.locations.exampleStores

Methods
createPOST /v1beta1/{parent}/exampleStores
Create an ExampleStore.
deleteDELETE /v1beta1/{name}
Delete an ExampleStore.
fetchExamplesPOST /v1beta1/{exampleStore}:fetchExamples
Get Examples from the Example Store.
getGET /v1beta1/{name}
Get an ExampleStore.
listGET /v1beta1/{parent}/exampleStores
List ExampleStores in a Location.
patchPATCH /v1beta1/{exampleStore.name}
Update an ExampleStore.
removeExamplesPOST /v1beta1/{exampleStore}:removeExamples
Remove Examples from the Example Store.
searchExamplesPOST /v1beta1/{exampleStore}:searchExamples
Search for similar Examples for given selection criteria.
upsertExamplesPOST /v1beta1/{exampleStore}:upsertExamples
Create or update Examples in the Example Store.

REST Resource:v1beta1.projects.locations.extensions

Methods
deleteDELETE /v1beta1/{name}
Deletes an Extension.
executePOST /v1beta1/{name}:execute
Executes the request against a given extension.
getGET /v1beta1/{name}
Gets an Extension.
importPOST /v1beta1/{parent}/extensions:import
Imports an Extension.
listGET /v1beta1/{parent}/extensions
Lists Extensions in a location.
patchPATCH /v1beta1/{extension.name}
Updates an Extension.
queryPOST /v1beta1/{name}:query
Queries an extension with a default controller.

REST Resource:v1beta1.projects.locations.featureGroups

Methods
createPOST /v1beta1/{parent}/featureGroups
Creates a new FeatureGroup in a given project and location.
deleteDELETE /v1beta1/{name}
Deletes a single FeatureGroup.
getGET /v1beta1/{name}
Gets details of a single FeatureGroup.
getIamPolicyPOST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1beta1/{parent}/featureGroups
Lists FeatureGroups in a given project and location.
patchPATCH /v1beta1/{featureGroup.name}
Updates the parameters of a single FeatureGroup.
setIamPolicyPOST /v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource:v1beta1.projects.locations.featureGroups.featureMonitors

Methods
createPOST /v1beta1/{parent}/featureMonitors
Creates a new FeatureMonitor in a given project, location and FeatureGroup.
deleteDELETE /v1beta1/{name}
Deletes a single FeatureMonitor.
getGET /v1beta1/{name}
Gets details of a single FeatureMonitor.
listGET /v1beta1/{parent}/featureMonitors
Lists FeatureGroups in a given project and location.
patchPATCH /v1beta1/{featureMonitor.name}
Updates the parameters of a single FeatureMonitor.

REST Resource:v1beta1.projects.locations.featureGroups.featureMonitors.featureMonitorJobs

Methods
createPOST /v1beta1/{parent}/featureMonitorJobs
Creates a new feature monitor job.
getGET /v1beta1/{name}
Get a feature monitor job.
listGET /v1beta1/{parent}/featureMonitorJobs
List feature monitor jobs.

REST Resource:v1beta1.projects.locations.featureGroups.features

Methods
batchCreatePOST /v1beta1/{parent}/features:batchCreate
Creates a batch of Features in a given FeatureGroup.
createPOST /v1beta1/{parent}/features
Creates a new Feature in a given FeatureGroup.
deleteDELETE /v1beta1/{name}
Deletes a single Feature.
getGET /v1beta1/{name}
Gets details of a single Feature.
listGET /v1beta1/{parent}/features
Lists Features in a given FeatureGroup.
patchPATCH /v1beta1/{feature.name}
Updates the parameters of a single Feature.

REST Resource:v1beta1.projects.locations.featureOnlineStores

Methods
createPOST /v1beta1/{parent}/featureOnlineStores
Creates a new FeatureOnlineStore in a given project and location.
deleteDELETE /v1beta1/{name}
Deletes a single FeatureOnlineStore.
getGET /v1beta1/{name}
Gets details of a single FeatureOnlineStore.
getIamPolicyPOST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1beta1/{parent}/featureOnlineStores
Lists FeatureOnlineStores in a given project and location.
patchPATCH /v1beta1/{featureOnlineStore.name}
Updates the parameters of a single FeatureOnlineStore.
setIamPolicyPOST /v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource:v1beta1.projects.locations.featureOnlineStores.featureViews

Methods
createPOST /v1beta1/{parent}/featureViews
Creates a new FeatureView in a given FeatureOnlineStore.
deleteDELETE /v1beta1/{name}
Deletes a single FeatureView.
directWritePOST /v1beta1/{featureView}:directWrite
Bidirectional streaming RPC to directly write to feature values in a feature view.
fetchFeatureValuesPOST /v1beta1/{featureView}:fetchFeatureValues
Fetch feature values under a FeatureView.
generateFetchAccessTokenPOST /v1beta1/{featureView}:generateFetchAccessToken
RPC to generate an access token for the given feature view.
getGET /v1beta1/{name}
Gets details of a single FeatureView.
getIamPolicyPOST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1beta1/{parent}/featureViews
Lists FeatureViews in a given FeatureOnlineStore.
patchPATCH /v1beta1/{featureView.name}
Updates the parameters of a single FeatureView.
searchNearestEntitiesPOST /v1beta1/{featureView}:searchNearestEntities
Search the nearest entities under a FeatureView.
setIamPolicyPOST /v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
streamingFetchFeatureValuesPOST /v1beta1/{featureView}:streamingFetchFeatureValues
Bidirectional streaming RPC to fetch feature values under a FeatureView.
syncPOST /v1beta1/{featureView}:sync
Triggers on-demand sync for the FeatureView.
testIamPermissionsPOST /v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource:v1beta1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs

Methods
getGET /v1beta1/{name}
Gets details of a single FeatureViewSync.
listGET /v1beta1/{parent}/featureViewSyncs
Lists FeatureViewSyncs in a given FeatureView.

REST Resource:v1beta1.projects.locations.featurestores

Methods
batchReadFeatureValuesPOST /v1beta1/{featurestore}:batchReadFeatureValues
Batch reads Feature values from a Featurestore.
createPOST /v1beta1/{parent}/featurestores
Creates a new Featurestore in a given project and location.
deleteDELETE /v1beta1/{name}
Deletes a single Featurestore.
getGET /v1beta1/{name}
Gets details of a single Featurestore.
getIamPolicyPOST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1beta1/{parent}/featurestores
Lists Featurestores in a given project and location.
patchPATCH /v1beta1/{featurestore.name}
Updates the parameters of a single Featurestore.
searchFeaturesGET /v1beta1/{location}/featurestores:searchFeatures
Searches Features matching a query in a given project.
setIamPolicyPOST /v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource:v1beta1.projects.locations.featurestores.entityTypes

Methods
createPOST /v1beta1/{parent}/entityTypes
Creates a new EntityType in a given Featurestore.
deleteDELETE /v1beta1/{name}
Deletes a single EntityType.
deleteFeatureValuesPOST /v1beta1/{entityType}:deleteFeatureValues
Delete Feature values from Featurestore.
exportFeatureValuesPOST /v1beta1/{entityType}:exportFeatureValues
Exports Feature values from all the entities of a target EntityType.
getGET /v1beta1/{name}
Gets details of a single EntityType.
getIamPolicyPOST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
importFeatureValuesPOST /v1beta1/{entityType}:importFeatureValues
Imports Feature values into the Featurestore from a source storage.
listGET /v1beta1/{parent}/entityTypes
Lists EntityTypes in a given Featurestore.
patchPATCH /v1beta1/{entityType.name}
Updates the parameters of a single EntityType.
readFeatureValuesPOST /v1beta1/{entityType}:readFeatureValues
Reads Feature values of a specific entity of an EntityType.
setIamPolicyPOST /v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
streamingReadFeatureValuesPOST /v1beta1/{entityType}:streamingReadFeatureValues
Reads Feature values for multiple entities.
testIamPermissionsPOST /v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.
writeFeatureValuesPOST /v1beta1/{entityType}:writeFeatureValues
Writes Feature values of one or more entities of an EntityType.

REST Resource:v1beta1.projects.locations.featurestores.entityTypes.features

Methods
batchCreatePOST /v1beta1/{parent}/features:batchCreate
Creates a batch of Features in a given EntityType.
createPOST /v1beta1/{parent}/features
Creates a new Feature in a given EntityType.
deleteDELETE /v1beta1/{name}
Deletes a single Feature.
getGET /v1beta1/{name}
Gets details of a single Feature.
listGET /v1beta1/{parent}/features
Lists Features in a given EntityType.
patchPATCH /v1beta1/{feature.name}
Updates the parameters of a single Feature.

REST Resource:v1beta1.projects.locations.hyperparameterTuningJobs

Methods
cancelPOST /v1beta1/{name}:cancel
Cancels a HyperparameterTuningJob.
createPOST /v1beta1/{parent}/hyperparameterTuningJobs
Creates a HyperparameterTuningJob
deleteDELETE /v1beta1/{name}
Deletes a HyperparameterTuningJob.
getGET /v1beta1/{name}
Gets a HyperparameterTuningJob
listGET /v1beta1/{parent}/hyperparameterTuningJobs
Lists HyperparameterTuningJobs in a Location.

REST Resource:v1beta1.projects.locations.indexEndpoints

Methods
createPOST /v1beta1/{parent}/indexEndpoints
Creates an IndexEndpoint.
deleteDELETE /v1beta1/{name}
Deletes an IndexEndpoint.
deployIndexPOST /v1beta1/{indexEndpoint}:deployIndex
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
getGET /v1beta1/{name}
Gets an IndexEndpoint.
listGET /v1beta1/{parent}/indexEndpoints
Lists IndexEndpoints in a Location.
mutateDeployedIndexPOST /v1beta1/{indexEndpoint}:mutateDeployedIndex
Update an existing DeployedIndex under an IndexEndpoint.
patchPATCH /v1beta1/{indexEndpoint.name}
Updates an IndexEndpoint.
undeployIndexPOST /v1beta1/{indexEndpoint}:undeployIndex
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

REST Resource:v1beta1.projects.locations.indexes

Methods
createPOST /v1beta1/{parent}/indexes
Creates an Index.
deleteDELETE /v1beta1/{name}
Deletes an Index.
getGET /v1beta1/{name}
Gets an Index.
importPOST /v1beta1/{name}:import
Imports an Index from an external source (e.g., BigQuery).
listGET /v1beta1/{parent}/indexes
Lists Indexes in a Location.
patchPATCH /v1beta1/{index.name}
Updates an Index.
removeDatapointsPOST /v1beta1/{index}:removeDatapoints
Remove Datapoints from an Index.
upsertDatapointsPOST /v1beta1/{index}:upsertDatapoints
Add/update Datapoints into an Index.

REST Resource:v1beta1.projects.locations.metadataStores

Methods
createPOST /v1beta1/{parent}/metadataStores
Initializes a MetadataStore, including allocation of resources.
deleteDELETE /v1beta1/{name}
Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
getGET /v1beta1/{name}
Retrieves a specific MetadataStore.
listGET /v1beta1/{parent}/metadataStores
Lists MetadataStores for a Location.

REST Resource:v1beta1.projects.locations.metadataStores.artifacts

Methods
createPOST /v1beta1/{parent}/artifacts
Creates an Artifact associated with a MetadataStore.
deleteDELETE /v1beta1/{name}
Deletes an Artifact.
getGET /v1beta1/{name}
Retrieves a specific Artifact.
listGET /v1beta1/{parent}/artifacts
Lists Artifacts in the MetadataStore.
patchPATCH /v1beta1/{artifact.name}
Updates a stored Artifact.
purgePOST /v1beta1/{parent}/artifacts:purge
Purges Artifacts.
queryArtifactLineageSubgraphGET /v1beta1/{artifact}:queryArtifactLineageSubgraph
Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.

REST Resource:v1beta1.projects.locations.metadataStores.contexts

Methods
addContextArtifactsAndExecutionsPOST /v1beta1/{context}:addContextArtifactsAndExecutions
Adds a set of Artifacts and Executions to a Context.
addContextChildrenPOST /v1beta1/{context}:addContextChildren
Adds a set of Contexts as children to a parent Context.
createPOST /v1beta1/{parent}/contexts
Creates a Context associated with a MetadataStore.
deleteDELETE /v1beta1/{name}
Deletes a stored Context.
getGET /v1beta1/{name}
Retrieves a specific Context.
listGET /v1beta1/{parent}/contexts
Lists Contexts on the MetadataStore.
patchPATCH /v1beta1/{context.name}
Updates a stored Context.
purgePOST /v1beta1/{parent}/contexts:purge
Purges Contexts.
queryContextLineageSubgraphGET /v1beta1/{context}:queryContextLineageSubgraph
Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
removeContextChildrenPOST /v1beta1/{context}:removeContextChildren
Remove a set of children contexts from a parent Context.

REST Resource:v1beta1.projects.locations.metadataStores.executions

Methods
addExecutionEventsPOST /v1beta1/{execution}:addExecutionEvents
Adds Events to the specified Execution.
createPOST /v1beta1/{parent}/executions
Creates an Execution associated with a MetadataStore.
deleteDELETE /v1beta1/{name}
Deletes an Execution.
getGET /v1beta1/{name}
Retrieves a specific Execution.
listGET /v1beta1/{parent}/executions
Lists Executions in the MetadataStore.
patchPATCH /v1beta1/{execution.name}
Updates a stored Execution.
purgePOST /v1beta1/{parent}/executions:purge
Purges Executions.
queryExecutionInputsAndOutputsGET /v1beta1/{execution}:queryExecutionInputsAndOutputs
Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.

REST Resource:v1beta1.projects.locations.metadataStores.metadataSchemas

Methods
createPOST /v1beta1/{parent}/metadataSchemas
Creates a MetadataSchema.
getGET /v1beta1/{name}
Retrieves a specific MetadataSchema.
listGET /v1beta1/{parent}/metadataSchemas
Lists MetadataSchemas.

REST Resource:v1beta1.projects.locations.migratableResources

Methods
batchMigratePOST /v1beta1/{parent}/migratableResources:batchMigrate
Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
searchPOST /v1beta1/{parent}/migratableResources:search
Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

REST Resource:v1beta1.projects.locations.modelDeploymentMonitoringJobs

Methods
createPOST /v1beta1/{parent}/modelDeploymentMonitoringJobs
Creates a ModelDeploymentMonitoringJob.
deleteDELETE /v1beta1/{name}
Deletes a ModelDeploymentMonitoringJob.
getGET /v1beta1/{name}
Gets a ModelDeploymentMonitoringJob.
listGET /v1beta1/{parent}/modelDeploymentMonitoringJobs
Lists ModelDeploymentMonitoringJobs in a Location.
patchPATCH /v1beta1/{modelDeploymentMonitoringJob.name}
Updates a ModelDeploymentMonitoringJob.
pausePOST /v1beta1/{name}:pause
Pauses a ModelDeploymentMonitoringJob.
resumePOST /v1beta1/{name}:resume
Resumes a paused ModelDeploymentMonitoringJob.
searchModelDeploymentMonitoringStatsAnomaliesPOST /v1beta1/{modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies
Searches Model Monitoring Statistics generated within a given time window.

REST Resource:v1beta1.projects.locations.modelMonitors

Methods
createPOST /v1beta1/{parent}/modelMonitors
Creates a ModelMonitor.
deleteDELETE /v1beta1/{name}
Deletes a ModelMonitor.
getGET /v1beta1/{name}
Gets a ModelMonitor.
listGET /v1beta1/{parent}/modelMonitors
Lists ModelMonitors in a Location.
patchPATCH /v1beta1/{modelMonitor.name}
Updates a ModelMonitor.
searchModelMonitoringAlertsPOST /v1beta1/{modelMonitor}:searchModelMonitoringAlerts
Returns the Model Monitoring alerts.
searchModelMonitoringStatsPOST /v1beta1/{modelMonitor}:searchModelMonitoringStats
Searches Model Monitoring Stats generated within a given time window.

REST Resource:v1beta1.projects.locations.modelMonitors.modelMonitoringJobs

Methods
createPOST /v1beta1/{parent}/modelMonitoringJobs
Creates a ModelMonitoringJob.
deleteDELETE /v1beta1/{name}
Deletes a ModelMonitoringJob.
getGET /v1beta1/{name}
Gets a ModelMonitoringJob.
listGET /v1beta1/{parent}/modelMonitoringJobs
Lists ModelMonitoringJobs.

REST Resource:v1beta1.projects.locations.models

Methods
copyPOST /v1beta1/{parent}/models:copy
Copies an already existing Vertex AI Model into the specified Location.
deleteDELETE /v1beta1/{name}
Deletes a Model.
deleteVersionDELETE /v1beta1/{name}:deleteVersion
Deletes a Model version.
exportPOST /v1beta1/{name}:export
Exports a trained, exportable Model to a location specified by the user.
getGET /v1beta1/{name}
Gets a Model.
getIamPolicyPOST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1beta1/{parent}/models
Lists Models in a Location.
listCheckpointsGET /v1beta1/{name}:listCheckpoints
Lists checkpoints of the specified model version.
listVersionsGET /v1beta1/{name}:listVersions
Lists versions of the specified model.
mergeVersionAliasesPOST /v1beta1/{name}:mergeVersionAliases
Merges a set of aliases for a Model version.
patchPATCH /v1beta1/{model.name}
Updates a Model.
setIamPolicyPOST /v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.
updateExplanationDatasetPOST /v1beta1/{model}:updateExplanationDataset
Incrementally update the dataset used for an examples model.
uploadPOST /v1beta1/{parent}/models:upload
Uploads a Model artifact into Vertex AI.

REST Resource:v1beta1.projects.locations.models.evaluations

Methods
getGET /v1beta1/{name}
Gets a ModelEvaluation.
importPOST /v1beta1/{parent}/evaluations:import
Imports an externally generated ModelEvaluation.
listGET /v1beta1/{parent}/evaluations
Lists ModelEvaluations in a Model.

REST Resource:v1beta1.projects.locations.models.evaluations.slices

Methods
batchImportPOST /v1beta1/{parent}:batchImport
Imports a list of externally generated EvaluatedAnnotations.
getGET /v1beta1/{name}
Gets a ModelEvaluationSlice.
listGET /v1beta1/{parent}/slices
Lists ModelEvaluationSlices in a ModelEvaluation.

REST Resource:v1beta1.projects.locations.notebookExecutionJobs

Methods
createPOST /v1beta1/{parent}/notebookExecutionJobs
Creates a NotebookExecutionJob.
deleteDELETE /v1beta1/{name}
Deletes a NotebookExecutionJob.
getGET /v1beta1/{name}
Gets a NotebookExecutionJob.
listGET /v1beta1/{parent}/notebookExecutionJobs
Lists NotebookExecutionJobs in a Location.

REST Resource:v1beta1.projects.locations.notebookRuntimeTemplates

Methods
createPOST /v1beta1/{parent}/notebookRuntimeTemplates
Creates a NotebookRuntimeTemplate.
deleteDELETE /v1beta1/{name}
Deletes a NotebookRuntimeTemplate.
getGET /v1beta1/{name}
Gets a NotebookRuntimeTemplate.
getIamPolicyPOST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1beta1/{parent}/notebookRuntimeTemplates
Lists NotebookRuntimeTemplates in a Location.
patchPATCH /v1beta1/{notebookRuntimeTemplate.name}
Updates a NotebookRuntimeTemplate.
setIamPolicyPOST /v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource:v1beta1.projects.locations.notebookRuntimes

Methods
assignPOST /v1beta1/{parent}/notebookRuntimes:assign
Assigns a NotebookRuntime to a user for a particular Notebook file.
deleteDELETE /v1beta1/{name}
Deletes a NotebookRuntime.
getGET /v1beta1/{name}
Gets a NotebookRuntime.
listGET /v1beta1/{parent}/notebookRuntimes
Lists NotebookRuntimes in a Location.
startPOST /v1beta1/{name}:start
Starts a NotebookRuntime.
stopPOST /v1beta1/{name}:stop
Stops a NotebookRuntime.
upgradePOST /v1beta1/{name}:upgrade
Upgrades a NotebookRuntime.

REST Resource:v1beta1.projects.locations.operations

Methods
cancelPOST /v1beta1/{name}:cancel
Starts asynchronous cancellation on a long-running operation.
deleteDELETE /v1beta1/{name}
Deletes a long-running operation.
getGET /v1beta1/{name}
Gets the latest state of a long-running operation.
listGET /v1beta1/{name}/operations
Lists operations that match the specified filter in the request.
waitPOST /v1beta1/{name}:wait
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.

REST Resource:v1beta1.projects.locations.persistentResources

Methods
createPOST /v1beta1/{parent}/persistentResources
Creates a PersistentResource.
deleteDELETE /v1beta1/{name}
Deletes a PersistentResource.
getGET /v1beta1/{name}
Gets a PersistentResource.
listGET /v1beta1/{parent}/persistentResources
Lists PersistentResources in a Location.
patchPATCH /v1beta1/{persistentResource.name}
Updates a PersistentResource.
rebootPOST /v1beta1/{name}:reboot
Reboots a PersistentResource.

REST Resource:v1beta1.projects.locations.pipelineJobs

Methods
batchCancelPOST /v1beta1/{parent}/pipelineJobs:batchCancel
Batch cancel PipelineJobs.
batchDeletePOST /v1beta1/{parent}/pipelineJobs:batchDelete
Batch deletes PipelineJobs The Operation is atomic.
cancelPOST /v1beta1/{name}:cancel
Cancels a PipelineJob.
createPOST /v1beta1/{parent}/pipelineJobs
Creates a PipelineJob.
deleteDELETE /v1beta1/{name}
Deletes a PipelineJob.
getGET /v1beta1/{name}
Gets a PipelineJob.
listGET /v1beta1/{parent}/pipelineJobs
Lists PipelineJobs in a Location.

REST Resource:v1beta1.projects.locations.publishers.models

Methods
countTokensPOST /v1beta1/{endpoint}:countTokens
Perform a token counting.
embedContentPOST /v1beta1/{model}:embedContent
Embed content with multimodal inputs.
exportPOST /v1beta1/{parent}/{name}:export
Exports a publisher model to a user provided Google Cloud Storage bucket.
fetchPublisherModelConfigGET /v1beta1/{name}:fetchPublisherModelConfig
Fetches the configs of publisher models.
getIamPolicyPOST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
predictPOST /v1beta1/{endpoint}:predict
Perform an online prediction.
rawPredictPOST /v1beta1/{endpoint}:rawPredict
Perform an online prediction with an arbitrary HTTP payload.
serverStreamingPredictPOST /v1beta1/{endpoint}:serverStreamingPredict
Perform a server-side streaming online prediction request for Vertex LLM streaming.
setPublisherModelConfigPOST /v1beta1/{name}:setPublisherModelConfig
Sets (creates or updates) configs of publisher models.
streamRawPredictPOST /v1beta1/{endpoint}:streamRawPredict
Perform a streaming online prediction with an arbitrary HTTP payload.

REST Resource:v1beta1.projects.locations.ragCorpora

Methods
createPOST /v1beta1/{parent}/ragCorpora
Creates a RagCorpus.
deleteDELETE /v1beta1/{name}
Deletes a RagCorpus.
getGET /v1beta1/{name}
Gets a RagCorpus.
listGET /v1beta1/{parent}/ragCorpora
Lists RagCorpora in a Location.
patchPATCH /v1beta1/{ragCorpus.name}
Updates a RagCorpus.

REST Resource:v1beta1.projects.locations.ragCorpora.ragFiles

Methods
deleteDELETE /v1beta1/{name}
Deletes a RagFile.
getGET /v1beta1/{name}
Gets a RagFile.
importPOST /v1beta1/{parent}/ragFiles:import
Import files from Google Cloud Storage or Google Drive into a RagCorpus.
listGET /v1beta1/{parent}/ragFiles
Lists RagFiles in a RagCorpus.

REST Resource:v1beta1.projects.locations.reasoningEngines

Methods
createPOST /v1beta1/{parent}/reasoningEngines
Creates a reasoning engine.
deleteDELETE /v1beta1/{name}
Deletes a reasoning engine.
getGET /v1beta1/{name}
Gets a reasoning engine.
listGET /v1beta1/{parent}/reasoningEngines
Lists reasoning engines in a location.
patchPATCH /v1beta1/{reasoningEngine.name}
Updates a reasoning engine.
queryPOST /v1beta1/{name}:query
Queries using a reasoning engine.
streamQueryPOST /v1beta1/{name}:streamQuery
Streams queries using a reasoning engine.

REST Resource:v1beta1.projects.locations.reasoningEngines.memories

Methods
createPOST /v1beta1/{parent}/memories
Create a Memory.
deleteDELETE /v1beta1/{name}
Delete a Memory.
generatePOST /v1beta1/{parent}/memories:generate
Generate memories.
getGET /v1beta1/{name}
Get a Memory.
listGET /v1beta1/{parent}/memories
List Memories.
patchPATCH /v1beta1/{memory.name}
Update a Memory.
retrievePOST /v1beta1/{parent}/memories:retrieve
Retrieve memories.

REST Resource:v1beta1.projects.locations.reasoningEngines.sessions

Methods
appendEventPOST /v1beta1/{name}:appendEvent
Appends an event to a given session.
createPOST /v1beta1/{parent}/sessions
Creates a newSession.
deleteDELETE /v1beta1/{name}
Deletes details of the specificSession.
getGET /v1beta1/{name}
Gets details of the specificSession.
listGET /v1beta1/{parent}/sessions
ListsSessions in a given reasoning engine.
patchPATCH /v1beta1/{session.name}
Updates the specificSession.

REST Resource:v1beta1.projects.locations.reasoningEngines.sessions.events

Methods
listGET /v1beta1/{parent}/events
ListsEvents in a given session.

REST Resource:v1beta1.projects.locations.schedules

Methods
createPOST /v1beta1/{parent}/schedules
Creates a Schedule.
deleteDELETE /v1beta1/{name}
Deletes a Schedule.
getGET /v1beta1/{name}
Gets a Schedule.
listGET /v1beta1/{parent}/schedules
Lists Schedules in a Location.
patchPATCH /v1beta1/{schedule.name}
Updates an active or paused Schedule.
pausePOST /v1beta1/{name}:pause
Pauses a Schedule.
resumePOST /v1beta1/{name}:resume
Resumes a paused Schedule to start scheduling new runs.

REST Resource:v1beta1.projects.locations.specialistPools

Methods
createPOST /v1beta1/{parent}/specialistPools
Creates a SpecialistPool.
deleteDELETE /v1beta1/{name}
Deletes a SpecialistPool as well as all Specialists in the pool.
getGET /v1beta1/{name}
Gets a SpecialistPool.
listGET /v1beta1/{parent}/specialistPools
Lists SpecialistPools in a Location.
patchPATCH /v1beta1/{specialistPool.name}
Updates a SpecialistPool.

REST Resource:v1beta1.projects.locations.studies

Methods
createPOST /v1beta1/{parent}/studies
Creates a Study.
deleteDELETE /v1beta1/{name}
Deletes a Study.
getGET /v1beta1/{name}
Gets a Study by name.
listGET /v1beta1/{parent}/studies
Lists all the studies in a region for an associated project.
lookupPOST /v1beta1/{parent}/studies:lookup
Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

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

Methods
addTrialMeasurementPOST /v1beta1/{trialName}:addTrialMeasurement
Adds a measurement of the objective metrics to a Trial.
checkTrialEarlyStoppingStatePOST /v1beta1/{trialName}:checkTrialEarlyStoppingState
Checks whether a Trial should stop or not.
completePOST /v1beta1/{name}:complete
Marks a Trial as complete.
createPOST /v1beta1/{parent}/trials
Adds a user provided Trial to a Study.
deleteDELETE /v1beta1/{name}
Deletes a Trial.
getGET /v1beta1/{name}
Gets a Trial.
listGET /v1beta1/{parent}/trials
Lists the Trials associated with a Study.
listOptimalTrialsPOST /v1beta1/{parent}/trials:listOptimalTrials
Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
stopPOST /v1beta1/{name}:stop
Stops a Trial.
suggestPOST /v1beta1/{parent}/trials:suggest
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.

REST Resource:v1beta1.projects.locations.tensorboards

Methods
batchReadGET /v1beta1/{tensorboard}:batchRead
Reads multiple TensorboardTimeSeries' data.
createPOST /v1beta1/{parent}/tensorboards
Creates a Tensorboard.
deleteDELETE /v1beta1/{name}
Deletes a Tensorboard.
getGET /v1beta1/{name}
Gets a Tensorboard.
listGET /v1beta1/{parent}/tensorboards
Lists Tensorboards in a Location.
patchPATCH /v1beta1/{tensorboard.name}
Updates a Tensorboard.
readSizeGET /v1beta1/{tensorboard}:readSize
Returns the storage size for a given TensorBoard instance.
readUsageGET /v1beta1/{tensorboard}:readUsage
Returns a list of monthly active users for a given TensorBoard instance.

REST Resource:v1beta1.projects.locations.tensorboards.experiments

Methods
batchCreatePOST /v1beta1/{parent}:batchCreate
Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
createPOST /v1beta1/{parent}/experiments
Creates a TensorboardExperiment.
deleteDELETE /v1beta1/{name}
Deletes a TensorboardExperiment.
getGET /v1beta1/{name}
Gets a TensorboardExperiment.
listGET /v1beta1/{parent}/experiments
Lists TensorboardExperiments in a Location.
patchPATCH /v1beta1/{tensorboardExperiment.name}
Updates a TensorboardExperiment.
writePOST /v1beta1/{tensorboardExperiment}:write
Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's.

REST Resource:v1beta1.projects.locations.tensorboards.experiments.runs

Methods
batchCreatePOST /v1beta1/{parent}/runs:batchCreate
Batch create TensorboardRuns.
createPOST /v1beta1/{parent}/runs
Creates a TensorboardRun.
deleteDELETE /v1beta1/{name}
Deletes a TensorboardRun.
getGET /v1beta1/{name}
Gets a TensorboardRun.
listGET /v1beta1/{parent}/runs
Lists TensorboardRuns in a Location.
patchPATCH /v1beta1/{tensorboardRun.name}
Updates a TensorboardRun.
writePOST /v1beta1/{tensorboardRun}:write
Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun.

REST Resource:v1beta1.projects.locations.tensorboards.experiments.runs.timeSeries

Methods
createPOST /v1beta1/{parent}/timeSeries
Creates a TensorboardTimeSeries.
deleteDELETE /v1beta1/{name}
Deletes a TensorboardTimeSeries.
exportTensorboardTimeSeriesPOST /v1beta1/{tensorboardTimeSeries}:exportTensorboardTimeSeries
Exports a TensorboardTimeSeries' data.
getGET /v1beta1/{name}
Gets a TensorboardTimeSeries.
listGET /v1beta1/{parent}/timeSeries
Lists TensorboardTimeSeries in a Location.
patchPATCH /v1beta1/{tensorboardTimeSeries.name}
Updates a TensorboardTimeSeries.
readGET /v1beta1/{tensorboardTimeSeries}:read
Reads a TensorboardTimeSeries' data.
readBlobDataGET /v1beta1/{timeSeries}:readBlobData
Gets bytes of TensorboardBlobs.

REST Resource:v1beta1.projects.locations.trainingPipelines

Methods
cancelPOST /v1beta1/{name}:cancel
Cancels a TrainingPipeline.
createPOST /v1beta1/{parent}/trainingPipelines
Creates a TrainingPipeline.
deleteDELETE /v1beta1/{name}
Deletes a TrainingPipeline.
getGET /v1beta1/{name}
Gets a TrainingPipeline.
listGET /v1beta1/{parent}/trainingPipelines
Lists TrainingPipelines in a Location.

REST Resource:v1beta1.projects.locations.tuningJobs

Methods
cancelPOST /v1beta1/{name}:cancel
Cancels a TuningJob.
createPOST /v1beta1/{parent}/tuningJobs
Creates a TuningJob.
getGET /v1beta1/{name}
Gets a TuningJob.
listGET /v1beta1/{parent}/tuningJobs
Lists TuningJobs in a Location.
rebaseTunedModelPOST /v1beta1/{parent}/tuningJobs:rebaseTunedModel
Rebase a TunedModel.

REST Resource:v1beta1.projects.modelGardenEula

Methods
acceptPOST /v1beta1/{parent}/modelGardenEula:accept
Accepts the EULA acceptance status of a publisher model.
checkPOST /v1beta1/{parent}/modelGardenEula:check
Checks the EULA acceptance status of a publisher model.

REST Resource:v1beta1.publishers.models

Methods
getGET /v1beta1/{name}
Gets a Model Garden publisher model.
listGET /v1beta1/{parent}/models
Lists publisher models in Model Garden.

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

Last updated 2025-12-17 UTC.