Advanced Personalization API

The Advanced Personalization API lets you access user profiles built based on the behavior of your users on your website or app.

Client libraries

Use Algolia’s API clients and libraries to reliably integrate Algolia’s APIs with your apps. The official API clients are covered by Algolia’s Service Level Agreement.

For more information, see Algolia’s ecosystem.

Base URLs

The Advanced Personalization API can be reached from multiple domains, each specific to a region.

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

Use the URL that matches your analytics region.

All requests must use HTTPS.

Authentication

Add these headers to authenticate requests:

• x-algolia-application-id. Your Algolia application ID.
• x-algolia-api-key. An API key with the search, browse and recommendation ACL permissions.

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 Advanced 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 2xx statuses. Client errors return 4xx statuses. Server errors return 5xx statuses. Error responses have a message property with more information.

Rate limiting

When making requests to the Advanced Personalization API, you are limited to 500 API calls per minute per application.

The following headers provide information about your current limit:

• x-ratelimit-limit: The number of requests allowed every 60 seconds.
• x-ratelimit-remaining: The number of requests remaining in the current 60 second period.
• x-ratelimit-reset: Timestamp when the next time period starts, measured in seconds since the Unix epoch.

Version

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