An idiomatic C++ client library for the Vertex AI API, a service to train high-quality custom machine learning models with minimal machine learning expertise and effort.
While this library is GA, please note that the Google Cloud C++ client libraries do not follow Semantic Versioning.
Quickstart
The following shows the code that you'll run in the google/cloud/aiplatform/quickstart/ directory, which should give you a taste of the Vertex AI API C++ client library API.
#include "google/cloud/aiplatform/v1/endpoint_client.h"
#include <iostream>
int main(int argc, char* argv[]) try {
if (argc != 3) {
std::cerr << "Usage: " << argv[0] << " project-id location-id\n";
return 1;
}
namespace aiplatform = ::google::cloud::aiplatform_v1;
auto const location = std::string{argv[2]};
auto client = aiplatform::EndpointServiceClient(
aiplatform::MakeEndpointServiceConnection(location));
auto const parent =
std::string{"projects/"} + argv[1] + "/locations/" + location;
for (auto r : client.ListEndpoints(parent)) {
if (!r) throw std::move(r).status();
std::cout << r->DebugString() << "\n";
}
return 0;
} catch (google::cloud::Status const& status) {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
Main classes
This library offers multiple *Client classes, which are listed below. Each one of these classes exposes all the RPCs for a gRPC service as member functions of the class. This library groups multiple gRPC services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.
The library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the *Client classes when testing your application.
The library automatically retries requests that fail with transient errors, and uses exponential backoff to backoff between retries. Application developers can override the default policies.
More Information
Error Handling - describes how the library reports errors.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThis webpage details the Vertex AI API C++ client library, which is a GA (Generally Available) service designed for training high-quality machine learning models.\u003c/p\u003e\n"],["\u003cp\u003eThe library provides various \u003ccode\u003e*Client\u003c/code\u003e classes that expose all RPCs for gRPC services, grouping services that are part of the same product or frequently used together.\u003c/p\u003e\n"],["\u003cp\u003eThe most recent release candidate version available is 2.37.0-rc, with numerous other releases ranging from 2.36.0 down to 2.12.0.\u003c/p\u003e\n"],["\u003cp\u003eThe C++ client library does not follow Semantic Versioning, and it includes automatic retries with exponential backoff for requests that encounter transient errors, with the option to customize these policies.\u003c/p\u003e\n"],["\u003cp\u003eThe Vertex AI API C++ client library offers resources on error handling, overriding endpoints and authentication credentials, and environment variable configurations.\u003c/p\u003e\n"]]],[],null,["Version 2.12.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/aiplatform/latest)\n- [2.41.0](/cpp/docs/reference/aiplatform/2.41.0)\n- [2.40.0](/cpp/docs/reference/aiplatform/2.40.0)\n- [2.39.0](/cpp/docs/reference/aiplatform/2.39.0)\n- [2.38.0](/cpp/docs/reference/aiplatform/2.38.0)\n- [2.37.0](/cpp/docs/reference/aiplatform/2.37.0)\n- [2.36.0](/cpp/docs/reference/aiplatform/2.36.0)\n- [2.35.0](/cpp/docs/reference/aiplatform/2.35.0)\n- [2.34.0](/cpp/docs/reference/aiplatform/2.34.0)\n- [2.33.0](/cpp/docs/reference/aiplatform/2.33.0)\n- [2.32.0](/cpp/docs/reference/aiplatform/2.32.0)\n- [2.31.0](/cpp/docs/reference/aiplatform/2.31.0)\n- [2.30.0](/cpp/docs/reference/aiplatform/2.30.0)\n- [2.29.0](/cpp/docs/reference/aiplatform/2.29.0)\n- [2.28.0](/cpp/docs/reference/aiplatform/2.28.0)\n- [2.27.0](/cpp/docs/reference/aiplatform/2.27.0)\n- [2.26.0](/cpp/docs/reference/aiplatform/2.26.0)\n- [2.25.1](/cpp/docs/reference/aiplatform/2.25.1)\n- [2.24.0](/cpp/docs/reference/aiplatform/2.24.0)\n- [2.23.0](/cpp/docs/reference/aiplatform/2.23.0)\n- [2.22.1](/cpp/docs/reference/aiplatform/2.22.1)\n- [2.21.0](/cpp/docs/reference/aiplatform/2.21.0)\n- [2.20.0](/cpp/docs/reference/aiplatform/2.20.0)\n- [2.19.0](/cpp/docs/reference/aiplatform/2.19.0)\n- [2.18.0](/cpp/docs/reference/aiplatform/2.18.0)\n- [2.17.0](/cpp/docs/reference/aiplatform/2.17.0)\n- [2.16.0](/cpp/docs/reference/aiplatform/2.16.0)\n- [2.15.1](/cpp/docs/reference/aiplatform/2.15.1)\n- [2.14.0](/cpp/docs/reference/aiplatform/2.14.0)\n- [2.13.0](/cpp/docs/reference/aiplatform/2.13.0)\n- [2.12.0](/cpp/docs/reference/aiplatform/2.12.0) \n\nVertex AI API C++ Client Library\n================================\n\nAn idiomatic C++ client library for the [Vertex AI API](https://cloud.google.com/vertex-ai), a service to train high-quality custom machine learning models with minimal machine learning expertise and effort.\n\nWhile this library is **GA** , please note that the Google Cloud C++ client libraries do **not** follow [Semantic Versioning](https://semver.org/).\n\n### Quickstart\n\nThe following shows the code that you'll run in the `google/cloud/aiplatform/quickstart/` directory, which should give you a taste of the Vertex AI API C++ client library API. \n\n #include \"google/cloud/aiplatform/v1/endpoint_client.h\"\n #include \u003ciostream\u003e\n\n int main(int argc, char* argv[]) try {\n if (argc != 3) {\n std::cerr \u003c\u003c \"Usage: \" \u003c\u003c argv[0] \u003c\u003c \" project-id location-id\\n\";\n return 1;\n }\n\n namespace aiplatform = ::google::cloud::aiplatform_v1;\n auto const location = std::string{argv[2]};\n auto client = aiplatform::EndpointServiceClient(\n aiplatform::MakeEndpointServiceConnection(location));\n\n auto const parent =\n std::string{\"projects/\"} + argv[1] + \"/locations/\" + location;\n for (auto r : client.ListEndpoints(parent)) {\n if (!r) throw std::move(r).status();\n std::cout \u003c\u003c r-\u003eDebugString() \u003c\u003c \"\\n\";\n }\n\n return 0;\n } catch (google::cloud::Status const& status) {\n std::cerr \u003c\u003c \"google::cloud::Status thrown: \" \u003c\u003c status \u003c\u003c \"\\n\";\n return 1;\n }\n\n### Main classes\n\nThis library offers multiple `*Client` classes, which are listed below. Each one of these classes exposes all the RPCs for a gRPC `service` as member functions of the class. This library groups multiple gRPC services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.\n\nThe library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the `*Client` classes when testing your application.\n\n- [`aiplatform_v1::DatasetServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1DatasetServiceClient)\n- [`aiplatform_v1::EndpointServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1EndpointServiceClient)\n- [`aiplatform_v1::FeaturestoreServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1FeaturestoreServiceClient)\n- [`aiplatform_v1::FeaturestoreOnlineServingServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1FeaturestoreOnlineServingServiceClient)\n- [`aiplatform_v1::IndexServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1IndexServiceClient)\n- [`aiplatform_v1::IndexEndpointServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1IndexEndpointServiceClient)\n- [`aiplatform_v1::JobServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1JobServiceClient)\n- [`aiplatform_v1::MatchServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1MatchServiceClient)\n- [`aiplatform_v1::MetadataServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1MetadataServiceClient)\n- [`aiplatform_v1::MigrationServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1MigrationServiceClient)\n- [`aiplatform_v1::ModelServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1ModelServiceClient)\n- [`aiplatform_v1::ModelGardenServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1ModelGardenServiceClient)\n- [`aiplatform_v1::PipelineServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1PipelineServiceClient)\n- [`aiplatform_v1::PredictionServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1PredictionServiceClient)\n- [`aiplatform_v1::SpecialistPoolServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1SpecialistPoolServiceClient)\n- [`aiplatform_v1::TensorboardServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1TensorboardServiceClient)\n- [`aiplatform_v1::VizierServiceClient`](/cpp/docs/reference/aiplatform/2.12.0/classgoogle_1_1cloud_1_1aiplatform__v1_1_1VizierServiceClient)\n\n### Retry, Backoff, and Idempotency Policies.\n\nThe library automatically retries requests that fail with transient errors, and uses [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) to backoff between retries. Application developers can override the default policies.\n\n### More Information\n\n- [Error Handling](https://cloud.google.com/cpp/docs/reference/common/latest/common-error-handling.html) - describes how the library reports errors.\n- [How to Override the Default Endpoint](/cpp/docs/reference/aiplatform/2.12.0/aiplatform-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/aiplatform/2.12.0/aiplatform-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Environment Variables](/cpp/docs/reference/aiplatform/2.12.0/aiplatform-env) - describes environment variables that can configure the behavior of the library."]]