Skip to main content

​
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. See Algolia’s ecosystem

​
Base URLs

The base URLs for requests to the Advanced Personalization API are:
  • 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

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 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 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 limiting

When making requests to the Advanced Personalization API, you are limited to 500 requests per minute per application. Each API response includes these headers with more 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 in milliseconds since the Unix epoch when the rate limit will reset.

​
Version

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