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

Algolia Personalization API

Configures and applies user-affinity profiles built from Insights events to re-rank search and browse results per user.

This API exposes 9 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

9 operations 5 paths 7 schemas 2 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Algolia 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 9

Across 5 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

personalization 9
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
/1/profiles/personalization/{userToken}
Retrieve a user profile
getUserTokenProfile 1 param → 200400402403404
DELETE
/1/profiles/{userToken}
Delete a user profile
deleteUserProfile 1 param → 200400402403404
GET
/1/strategies/personalization
Retrieve the personalization strategy
getPersonalizationStrategy → 200400402403404
POST
/1/strategies/personalization
Define the personalization strategy
setPersonalizationStrategy body → 200400402403404
GET
/setClientApiKey
Switch the API key used to authenticate requests
setClientApiKey 1 param → 204

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are eventsScoring (3 properties), personalizationStrategyParams (3 properties), facetsScoring (2 properties), ErrorBase (1 property). Each schema is shown below with its type and property counts.

facetsScoring
object
2 properties 2 required
EventType
string
Event type.
personalizationStrategyParams
object
3 properties 3 required
eventsScoring
object
3 properties 3 required
score
integer
Event score.
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…
ErrorBase
object
Error.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

algolia-personalization-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Algolia 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.