Algolia

Algolia Advanced Personalization API

The successor to classic Personalization: real-time user profiles, personalization strategies and a dedicated error-code reference. Runs on its own AI personalization host and publishes the only per-product error catalogue in the estate.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /{path} Send a raw GET request to Advanced Personalization · Send requests to the Algolia REST API #
Ask an LLM
“Can I read an Advanced Personalization endpoint that the client library doesn't wrap?”
“Is there a generic way to GET any Advanced Personalization path with my own query parameters?”
Tell an agent
Send a raw GET request to Advanced Personalization path {path}.
Fetch Advanced Personalization path {path} with query parameters {parameters}.
POST /{path} Send a raw POST request to Advanced Personalization · Send requests to the Algolia REST API #
Ask an LLM
“Can I POST to an Advanced Personalization endpoint the SDK doesn't expose?”
“What's the generic escape hatch for posting to any Advanced Personalization path?”
Tell an agent
Send a raw POST request to Advanced Personalization path {path}.
POST to Advanced Personalization path {path} with query parameters {parameters}.
PUT /{path} Send a raw PUT request to Advanced Personalization · Send requests to the Algolia REST API #
Ask an LLM
“Can I send a custom PUT to an Advanced Personalization path with no dedicated method?”
“Is there a passthrough for replacing a resource on an arbitrary Advanced Personalization endpoint?”
Tell an agent
Send a raw PUT request to Advanced Personalization path {path}.
PUT to Advanced Personalization path {path} with query parameters {parameters}.
DELETE /{path} Send a raw DELETE request to Advanced Personalization · Send requests to the Algolia REST API #
Ask an LLM
“Can I issue a DELETE against an arbitrary Advanced Personalization path?”
“Is there a generic delete call for Advanced Personalization endpoints without a dedicated method?”
Tell an agent destructive · confirm first
Send a raw DELETE request to Advanced Personalization path {path}.
DELETE Advanced Personalization path {path} with query parameters {parameters}.
GET /2/config Get the Advanced Personalization configuration · Retrieve the configuration #
Ask an LLM
“Which indices have Advanced Personalization configured, and with what settings?”
“What does my current per-index Advanced Personalization configuration look like?”
Tell an agent
Show my Advanced Personalization configuration for every index.
List the per-index configuration objects for Advanced Personalization.
PUT /2/config Update the Advanced Personalization configuration · Update the configuration #
Ask an LLM
“How do I turn on Advanced Personalization for a new index?”
“Can I change the re-ranking and profile type used by Advanced Personalization?”
Tell an agent
Configure Advanced Personalization for indices {indices} with features {features}, profile type {profileType} and re-ranking {personalizationReRanking}.
Set Advanced Personalization re-ranking to {personalizationReRanking} on indices {indices}, keeping features {features} and profile type {profileType}.
GET /2/users List Advanced Personalization user profiles · Get a list of user profiles #
Ask an LLM
“How do I page through all the user profiles Advanced Personalization has built?”
“Can I find the users who have an affinity for a specific facet value?”
Tell an agent
List Advanced Personalization user profiles between {startDate} and {endDate}.
Find user profiles with affinity {affinity} on indices {indices}, {limit} at a time.
GET /2/users/{userID} Get one Advanced Personalization user profile · Get a user profile #
Ask an LLM
“What has Advanced Personalization stored about one specific user ID?”
“How do I inspect a single user's advanced profile?”
Tell an agent
Show the Advanced Personalization profile for user {userID}.
Retrieve user profile {userID} from Advanced Personalization.
DELETE /2/users/{userID} Delete an Advanced Personalization user profile · Delete a user profile #
Ask an LLM
“How do I delete one user's Advanced Personalization profile by user ID?”
“Can I wipe a single advanced user profile to honor a data removal request?”
Tell an agent destructive · confirm first
Delete the Advanced Personalization profile for user {userID}.
Remove user {userID} from Advanced Personalization.
GET /2/realtime/users/{userToken} Get a user's real-time personalization profile · Retrieve the real-time user's personalization profile #
Ask an LLM
“What search filters does the real-time profile currently apply for a user token?”
“How do I see a shopper's live personalization profile during their session?”
Tell an agent
Show the real-time personalization profile for user token {userToken}.
Get the live search filters personalized for {userToken}.
POST /2/realtime/users/{userToken}/compute Recompute a user's real-time personalization profile · Compute the real-time user's personalization profile #
Ask an LLM
“How do I force a refresh of a user's real-time personalization profile?”
“Can I ask Algolia to recompute the live profile for one user token right now?”
Tell an agent
Recompute the real-time personalization profile for user token {userToken}.
Trigger a fresh computation of {userToken}'s live personalization profile.
GET /setClientApiKey Switch the API key the Advanced Personalization client uses · Switch the API key used to authenticate requests #
Ask an LLM
“Can I change which API key my Advanced Personalization client authenticates with?”
“How do I rotate the key an existing Advanced Personalization client sends?”
Tell an agent
Switch the Advanced Personalization client to API key {apiKey}.
Use {apiKey} for all further Advanced Personalization requests.

Documentation

📖
Documentation
https://www.algolia.com/doc/guides/personalization/advanced-personalization/what-is-advanced-personalization/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/openapi/algolia-advanced-personalization-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-configuration-object-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-realtime-user-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-user-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-events-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-issue-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-profile-type-schema.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/overlays/algolia-advanced-personalization-api-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/algolia:algolia-advanced-personalization-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

algolia-advanced-personalization-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Advanced Personalization API
  summary: The Advanced Personalization API lets you access user profiles built based on the behavior of your users on your website or app
  description: '## Client libraries


    Use Algolia''s API clients and libraries to reliably integrate Algolia''s APIs with your apps.'
  version: 2.0.0
servers:
- url: https://ai-personalization.{region}.algolia.com
  variables:
    region:
      description: 'Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).

        '
      enum:
      - eu
      - us
      default: eu
security:
- appId: []
  apiKey: []
tags:


# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/openapi/algolia-advanced-personalization-api-openapi.yml