Important: Recommendations AI has migrated to the Retail API, which is now generally available.

The Recommendations AI API (service endpoint and this documentation set remain available, but they will no longer be updated. We recommend migrating your recommendations to the Retail API (service endpoint See the new documentation:

Method: projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.create

Register an API key for use with predict method.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The parent resource path. "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store".

Authorization requires the following IAM permission on the specified resource parent:

  • automlrecommendations.apiKeys.create

Request body

The request body contains data with the following structure:

JSON representation
  "predictionApiKeyRegistration": {
    object (PredictionApiKeyRegistration)

object (PredictionApiKeyRegistration)

Required. The prediction API key registration.

Response body

If successful, the response body contains a newly created instance of PredictionApiKeyRegistration.

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.