Algolia · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Algolia Agent Studio API

3 actions 3 updates update extends openapi/algolia-agent-studio-api-openapi.yml
Derived by API Evangelist Built from the contracts Algolia publishes. Algolia did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-api-evangelistx-conventionsx-error-catalogx-rate-limitsx-authenticationx-lifecyclex-write-semanticsx-retry-strategy

Targets 1

$.info

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Algolia Agent Studio API
  version: 1.0.0
  x-generated: '2026-08-27'
  x-method: generated
  x-source: Generated by the API Evangelist enrichment pipeline over openapi/algolia-agent-studio-api-openapi.yml. The upstream Algolia document
    is never mutated in place; the pristine harvest is archived at openapi/_original/.
extends: openapi/algolia-agent-studio-api-openapi.yml
actions:
- target: $.info
  description: Attach API Evangelist catalog identity so the document is traceable back to the provider profile.
  update:
    x-api-evangelist:
      provider: Algolia
      providerId: algolia
      profile: https://apis.io/provider/algolia/
      apis_yml: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/apis.yml
      upstream: https://github.com/algolia/api-clients-automation/tree/main/specs/bundled
      harvested: '2026-08-27'
- target: $.info
  description: Point at the cross-cutting runtime semantics this document does not itself carry.
  update:
    x-conventions: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/conventions/algolia-conventions.yml
    x-error-catalog: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/errors/algolia-problem-types.yml
    x-rate-limits: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/rate-limits/algolia-rate-limits.yml
    x-authentication: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/authentication/algolia-authentication.yml
    x-lifecycle: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/lifecycle/algolia-lifecycle.yml
- target: $.info
  description: 'Record the two conventions an agent must know that no operation schema states: writes are asynchronous, and the fallback hosts
    are part of the contract.'
  update:
    x-write-semantics:
      asynchronous: true
      note: Write operations return a taskID rather than the committed state. Poll waitTask before reading back.
      docs: https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/in-depth/index-operations-are-asynchronous
    x-retry-strategy:
      required: true
      fallback_hosts:
      - https://{APPLICATION_ID}-1.algolianet.com
      - https://{APPLICATION_ID}-2.algolianet.com
      - https://{APPLICATION_ID}-3.algolianet.com
      note: Fallback hosts use a different DNS provider than the primary hosts and must be randomized. Every official Algolia client implements
        this; a direct REST caller must implement it itself.

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • 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 overlay
curl "https://apis.io/api/v1/overlays/algolia-agent-studio-api-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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