Algolia A/B Testing API
Browse all Algolia APIs64
AI ReadinessAI-Aware (B)64/100
Agent-ready OpenAPI document · curated by JenticAnalyticsProduct AnalyticsapiKey11 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Create, monitor, and stop search relevance A/B tests on Algolia indices through 11 dedicated endpoints with sample size estimation.
Use for: I need to create a new A/B test between two Algolia index variants, Estimate how long a planned Algolia A/B test will need to run, Retrieve the latest results for a running A/B test, List every A/B test on my Algolia application
Not supported: Does not run search queries, ingest events, or manage indices - use for creating, monitoring, stopping, and estimating Algolia A/B tests only.
Jentic publishes the only available OpenAPI specification for the Algolia A/B Testing API, keeping it validated and agent-ready. The A/B Testing API lets teams run controlled search relevance experiments on Algolia indices, comparing two index variants against live user traffic. Endpoints cover creating tests, listing them, retrieving variant performance, stopping tests, and estimating sample size and duration before launch. Authentication uses two headers: x-algolia-application-id and x-algolia-api-key.
Install Jentic One Beta
Connect the A/B Testing API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the A/B Testing API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Falgolia.com%2Falgolia-ab-testing-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Falgolia.com%2Falgolia-ab-testing-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with A/B Testing API.
Create a search relevance A/B test between two index variants with POST /2/abtests
List every active and historical A/B test on the application via GET /2/abtests
Retrieve detailed performance metrics for a specific A/B test by id
Stop a running A/B test before its scheduled end with POST /2/abtests/{id}/stop
Delete an A/B test record once analysis is finished
Estimate the required sample size and duration for a planned A/B test before launch
Use Cases
Patterns agents use A/B Testing API for, with concrete tasks.
★ Search relevance experiment for a marketplace
A search engineering team tests a new ranking formula by creating an A/B test in Algolia: variant A is the production index, variant B uses an updated custom ranking. They call POST /2/abtests with the variants and traffic split, then poll GET /2/abtests/{id} for click-through and conversion deltas. The team avoids shipping a regression to all users by gating the change on the test result.
POST /2/abtests with variant A=production, variant B=updated, and 50/50 traffic; poll GET /2/abtests/{id} every 24 hours for the result delta
Pre-launch sample size estimation
Before launching an experiment, a product analyst calls POST /2/abtests/estimate with the expected effect size and confidence level so the team can budget the test correctly. The endpoint returns the required sample size and duration; the analyst then schedules the actual A/B test only if the projected runtime fits the release plan.
POST /2/abtests/estimate with the effect size and traffic, then only call POST /2/abtests if the projected duration fits the release window
Automatic shut-off for underperforming experiments
An ops automation polls /2/abtests/{id} for each running test and calls POST /2/abtests/{id}/stop when the leading variant crosses a confidence threshold or when negative conversion impact exceeds a guardrail. This keeps experiments from running longer than necessary and protects revenue when a variant clearly hurts performance.
GET /2/abtests/{id} on a schedule, evaluate guardrail metrics, and call POST /2/abtests/{id}/stop when the threshold is breached
Agent-driven experiment lifecycle through Jentic
A Jentic agent receives an intent like 'check on my running search experiments' and calls GET /2/abtests followed by GET /2/abtests/{id} for any tests that are still active. The agent summarises the results without exposing the application id and API key, which stay in your Jentic One instance.
Search Jentic for 'list Algolia A/B tests', execute GET /2/abtests, then GET /2/abtests/{id} for any running tests and return a summary
Key Endpoints
11 endpoints — jentic publishes the only available openapi specification for the algolia a/b testing api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/2/abtests
Create an A/B test
GET
/2/abtests
List all A/B tests
GET
/2/abtests/{id}
Retrieve A/B test details
DELETE
/2/abtests/{id}
Delete an A/B test
POST
/2/abtests/{id}/stop
Stop a running A/B test
POST
/2/abtests/estimate
Estimate sample size and duration
POST
/2/abtests
Create an A/B test
GET
/2/abtests
List all A/B tests
GET
/2/abtests/{id}
Retrieve A/B test details
DELETE
/2/abtests/{id}
Delete an A/B test
POST
/2/abtests/{id}/stop
Stop a running A/B test
POST
/2/abtests/estimate
Estimate sample size and duration
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
A/B Testing API
- AI-Aware (B)64/100
49
Foundational Compliance70
Developer Experience & Jentic Compatibility57
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
49
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: D+Signals: 4
81%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
17%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
70
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
35%
Example Density
How richly the API is illustrated with examples.
98%
Example Validity
Percentage of examples that conform to their schemas.
48%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
57
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: CSignals: 4
62%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
65%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Algolia A/B Testing API by hand means sending its API key, resolving the analytics.{region}.algolia.com host for your app, and managing the test lifecycle calls yourself. Through Jentic you install once, import the A/B Testing API from the API Directory, store the API key once, and your agent calls it.
Permission scoping
The A/B Testing API puts the test id in the URL path (/2/abtests/{id}, /2/abtests/{id}/stop), so a rule can pin your agent to one A/B test. You choose the operations it may call, so deleting a test is not included unless you add it.
Credential isolation
Your Algolia API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create an A/B test' or 'stop a running A/B test', and Jentic returns the matching Algolia operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using A/B Testing API through Jentic.
Why is there no official OpenAPI spec for the Algolia A/B Testing API?
Algolia does not publish a downstream-stable OpenAPI specification for direct agent use. Jentic generates and maintains this spec from Algolia's source bundles so AI agents and developers can call the A/B Testing API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Algolia A/B Testing API use?
The API requires two headers: x-algolia-application-id and x-algolia-api-key. The API key must have ACL permissions matching the requested endpoint. Jentic stores both values encrypted and injects the headers at execution time so neither key enters the agent's prompt context.
Can I create a new search A/B test through this API?
Yes. POST /2/abtests with the two variant index references, the traffic split, and the test name. The API returns the test id which you can use with GET /2/abtests/{id} to track results or POST /2/abtests/{id}/stop to end the test early.
What are the rate limits for the A/B Testing API?
Algolia documents a limit of 100 requests per minute per application for the A/B Testing API. Response headers include current rate-limit information; pace polling jobs to stay under that ceiling, especially when monitoring multiple tests at once.
How do I estimate the duration of a planned A/B test through Jentic?
Search Jentic for 'estimate algolia ab test duration', load the schema for POST /2/abtests/estimate, and execute it with the expected effect size and traffic share. Jentic returns the recommended sample size so an agent can decide whether to schedule the experiment.
Is the A/B Testing API available on every Algolia plan?
Algolia restricts A/B Testing to its Premium and Elevate plans. Confirm your plan in the Algolia dashboard before scripting against this API; calls from accounts without access return an authorisation error rather than a permission scope error.
Can I limit what my agent is allowed to do with the Algolia A/B Testing API?
Yes. Because you run Jentic One yourself, your own rules decide which A/B Testing operations the agent may call and which Algolia credentials it may use. You can grant read-only access with GET /2/abtests and GET /2/abtests/{id} while withholding POST /2/abtests/{id}/stop or DELETE /2/abtests/{id}, so a monitoring agent can never stop or delete a test. Since the test id sits in the URL path, a rule can also pin the agent to a single A/B test rather than every test on the application.
GET STARTED