Personalization API

The Personalization API lets you access user profiles built from the personalization strategy.

For more information, see Algolia Personalization (Classic)

Base URLs

The base URLs for requests to the Personalization API are:

• https://personalization.us.algolia.com
• https://personalization.eu.algolia.com

Use the URL that matches your analytics region.

All requests must use HTTPS.

Authentication

To authenticate your API requests, add these headers:

• x-algolia-application-id. Your Algolia application ID.
• x-algolia-api-key. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint’s reference.

You can find your application ID and API key in the Algolia dashboard.

Request format

Request bodies must be JSON objects.

Response status and errors

The Personalization API returns JSON responses. Since JSON doesn’t guarantee any specific ordering, don’t rely on the order of attributes in the API response.

• Successful responses return a 2xx status.
• Client errors return a 4xx status.
• Server errors return a 5xx status.
• Error responses have a message property with more information.

Rate limits

You can make up to 40 requests per second per application to the Personalization API. Each response includes headers with information about your current limit:

• x-ratelimit-limit. The number of requests allowed every second.
• x-ratelimit-remaining. The number of requests remaining in the current period.
• x-ratelimit-reset. Timestamp in seconds since the Unix epoch when the rate limit resets.

Version

The current version of the Personalization API is version 1, as indicated by the /1/ in each endpoint’s URL.