Skip to content
OpenParablePublic APIs

AI Platform Training & Prediction API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

An API to enable creating and using machine learning models.

AI Platform Training & Prediction API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 29 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://ml.googleapis.com/
Version
v1
Endpoints
29
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://ml.googleapis.com/v1/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://ml.googleapis.com/v1/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://ml.googleapis.com/v1/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v1/{name}Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
PATCH/v1/{name}Updates the specified Version resource. Currently the only update-able fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScal
DELETE/v1/{name}Deletes a model version. Each model can have multiple versions deployed and in use at any given time. Use this method to remove a single version. Note: You cann
GET/v1/{name}/operationsLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
POST/v1/{name}:addMeasurementAdds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.
POST/v1/{name}:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the serv
POST/v1/{name}:checkEarlyStoppingStateChecks whether a trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateRes
POST/v1/{name}:completeMarks a trial as complete.
POST/v1/{name}:explainPerforms explanation on the data in the request. {% dynamic include "/ai-platform/includes/___explain-request" %}
GET/v1/{name}:getConfigGet the service account information associated with your project. You need this information in order to grant the service account permissions for the Google Clo
POST/v1/{name}:predictPerforms online prediction on the data in the request. {% dynamic include "/ai-platform/includes/___predict-request" %}
POST/v1/{name}:setDefaultDesignates a version to be the default for the model. The default version is used for prediction requests made against the model that don't specify a version. T
POST/v1/{name}:stopStops a trial.
GET/v1/{parent}/jobsLists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}.
POST/v1/{parent}/jobsCreates a training or a batch prediction job.
GET/v1/{parent}/locationsList all locations that provides at least one type of CMLE capability.
GET/v1/{parent}/modelsLists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the reques
POST/v1/{parent}/modelsCreates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions
GET/v1/{parent}/studiesLists all the studies in a region for an associated project.
POST/v1/{parent}/studiesCreates a study.
GET/v1/{parent}/trialsLists the trials associated with a study.
POST/v1/{parent}/trialsAdds a user provided trial to a study.
POST/v1/{parent}/trials:listOptimalTrialsLists the pareto-optimal trials for multi-objective study or the optimal trials for single-objective study. The definition of pareto-optimal can be checked in w
POST/v1/{parent}/trials:suggestAdds one or more trials to a study, with parameter values suggested by AI Platform Vizier. Returns a long-running operation associated with the generation of tr
GET/v1/{parent}/versionsGets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of result
POST/v1/{parent}/versionsCreates a new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specifie
GET/v1/{resource}:getIamPolicyGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
POST/v1/{resource}:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` erro
POST/v1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND`

Questions

Does the AI Platform Training & Prediction API API need an API key?

Yes. The AI Platform Training & Prediction API API uses OAuth authentication; the documentation explains how to get credentials.

Does the AI Platform Training & Prediction API API support HTTPS?

Yes, the AI Platform Training & Prediction API API is served over HTTPS.

How many endpoints does the AI Platform Training & Prediction API API have?

Its OpenAPI description lists 29 endpoints in version v1. All of them are shown on this page.

What are alternatives to the AI Platform Training & Prediction API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).