Important: There is a newer version of this product and documentation. You are currently viewing the v1beta1 Recommendations Engine API documentation, which remains available but will no longer be updated.

See Migrating to the Retail API from beta in the new documentation.

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

Stay organized with collections Save and categorize content based on your preferences.

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.