For the complete documentation index, see llms.txt. This page is also available as Markdown.

Set up the Personalization API

Create a Personalization API activation and retrieve its endpoint.

Before you start

Make sure the Personalization API is enabled in your workspace. You also need a DinMo model that contains one row per record you want to retrieve, along with the fields your application needs.

Choose a stable, unique lookup key such as customer_id. Keep the response small and include only the fields that are needed at request time.

Create an activation

  1. From your model or segment, create a new activation.

  2. In Select your destination, select Personalization API under Native.

  3. Continue to the activation configuration.

The Personalization API option in the Native destinations list
Select Personalization API as the destination.

Configure the lookup key and attributes

Choose the field DinMo should use to look up a record. This is the value your application includes in the endpoint URL.

Then select the fields to include in the response and enter the attribute names your application expects. DinMo creates the attributes when needed and keeps their values up to date.

Activation configuration with a lookup key and custom attribute mappings
Choose a lookup key and map the fields returned by the API.

Run the activation and find the endpoint

Save and run the activation. In the destination's Exposures tab, expand the exposure to find:

  • The endpoint to call, including the model, activation, and lookup-key placeholder.

  • A link to create or manage API keys.

  • The response schema, which lists the fields returned for that exposure.

A Personalization API exposure showing its endpoint, authentication link, and response schema
Each exposure provides a ready-to-use endpoint and its response schema.

Create and manage API keys

Open Settings > API keys, then select Add API key. Store the key in your server-side secret manager; it is required to authenticate every request.

Delete keys that are no longer needed and rotate keys as part of your security practices.

The Personalization API keys settings page
Create, review, and delete Personalization API keys from Settings.

Test the endpoint

Use the endpoint displayed in the exposure and replace the lookup-key placeholder with a real value. Add your API key as a Bearer token. See the Personalization API reference for a complete request example.

Production checklist

  • Use a dedicated model for the data served through the API.

  • Keep a stable response contract: rename or remove mapped fields only after updating consumers.

  • Serve only the fields required by the application.

  • Define a fallback in your application for a missing record or unavailable service.

  • Monitor API usage and rotate keys regularly.

Last updated