How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
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.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 12 operations across 7 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://ai-personalization.{region}.algolia.com.

12 operations 7 paths 44 schemas 2 DELETE6 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://ai-personalization.{region}.algolia.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Algolia Advanced Personalization API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-algolia-application-id (appId). An API key is passed in the header as x-algolia-api-key (apiKey). By default, every request must be authenticated.

  • appId — Your Algolia application ID.
  • apiKey — Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions.…

Paths & Operations 12

Across 7 paths, the API surfaces 12 operations — 2 DELETE, 6 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

advanced-personalization 12
GET
/{path}
Send requests to the Algolia REST API
customGet 2 params → 200400402403404
POST
/{path}
Send requests to the Algolia REST API
customPost 2 params body → 200400402403404
PUT
/{path}
Send requests to the Algolia REST API
customPut 2 params body → 200400402403404
DELETE
/{path}
Send requests to the Algolia REST API
customDelete 2 params → 200400402403404
GET
/2/config
Retrieve the configuration
getConfig → 200401500
PUT
/2/config
Update the configuration
putConfig body → 200400401402500
GET
/2/users
Get a list of user profiles
getUsers 7 params → 200401422500
GET
/2/users/{userID}
Get a user profile
getUser 1 param → 200400401404422500
DELETE
/2/users/{userID}
Delete a user profile
deleteUser 1 param → 200400401422500
GET
/2/realtime/users/{userToken}
Retrieve the real-time user's personalization profile
getRealtimeUser 1 param → 200400402421500
POST
/2/realtime/users/{userToken}/computedeprecated
Compute the real-time user's personalization profile
computeRealtimeUser 1 param → 202400402409421422500
GET
/setClientApiKey
Switch the API key used to authenticate requests
setClientApiKey 1 param → 204

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are configurationObject (5 properties), events (4 properties), user (4 properties), RealtimeUser (4 properties). Each schema is shown below with its type and property counts.

unauthorized
integer
HTTP status code for an authorization error.
ErrorResponses_internalServerError
object
2 properties
RealtimeUser
object
4 properties 4 required
genericNotFound
string
Details about the response, such as error messages.
event
object
3 properties 2 required
profileType
string
The type of user profiles to generate. Basic profiles are based on past behaviors, ensuring search results align with previous interests.
userType
string
issue
object
An issue is either an 'error' or a 'warning' that is generated by the validator.
3 properties 3 required
searchFilters
object
3 properties
realtime
object
1 property
userToken
string
Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www…
featureNotEnabled
string
Details about the response, such as error messages.
events
object
4 properties 4 required
ErrorResponses_genericNotFound
object
2 properties
ErrorResponses_badRequest
object
2 properties
badRequest
integer
HTTP status code for a bad request error.
ErrorMessages_badRequest
string
Details about the response, such as error messages.
ErrorResponses_badUserID
object
2 properties
unprocessableEntity
integer
HTTP status code for an unprocessable entity error.
sourceType
string
features
object
1 property
strategy
string
ErrorResponses_invalidUserID
object
2 properties
eventType
string
badUserID
string
Details about the response, such as error messages.
paymentRequired
integer
HTTP status code for a payment required error.
internalServerError
integer
HTTP status code for an internal server error.
Configuration_status
object
3 properties
errorCodes
string
subtype
string
user
object
4 properties 4 required
ErrorMessages_internalServerError
string
Details about the response, such as error messages.
configurationObject
object
5 properties 5 required
ErrorMessages_unauthorized
string
Details about the response, such as error messages.
invalidUserID
string
Details about the response, such as error messages.
genericUnprocessableEntity
string
Details about the response, such as error messages.
ErrorResponses_unauthorized
object
2 properties
notFound
integer
HTTP status code for a not found error.
ErrorResponses_genericUnprocessableEntity
object
2 properties
searchFilter
object
1 property
personalizationReRanking
string
The impact that personalization has on the re-ranking of search results.
ErrorResponses_featureNotEnabled
object
2 properties
status
string
ErrorBase
object
Error.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

algolia-advanced-personalization-api-openapi.yml Raw ↑
#Personalization#Artificial Intelligence#REST
← Back to A APIs
API Details
ID
algolia:algolia-advanced-personalization-api
Base URL
https://ai-personalization.{region}.algolia.com
Docs
https://www.algolia.com/doc/guides/personalization/advanced-personalization/what-is-advanced-personalization/
Provider
Algolia
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=algolia-algolia-advanced-personalization-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/algolia-algolia-advanced-personalization-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Algolia Advanced Personalization API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.