Algolia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algoliasearch API

4 actions 4 updates phrasing extends openapi/algolia-algoliasearch-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Algolia's API. It is a proposal applied on top of the contract, not a document Algolia publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/{path}'].post

$.paths['/1/indexes/*/queries'].post

$.paths['/1/indexes/*/recommendations'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Algoliasearch API
  version: 1.0.0
extends: openapi/algolia-algoliasearch-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/{path}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a raw POST request to the Algolia REST API
      effect: write
      questions:
      - Can I POST to an Algolia endpoint that the lite search client doesn't wrap?
      - Is there a generic way to send a custom POST with my own query parameters?
      instructions:
      - text: Send a raw POST request to Algolia path {path}.
        slots:
          path: path.path
      - text: POST to {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/indexes/*/queries'].post
  update:
    x-apievangelist-phrasing:
      intent: Run several search queries in one request
      effect: read
      questions:
      - How do I search my products index and my content index in a single round trip?
      - Can I stop running the remaining queries once one of them returns enough hits?
      - What's the way to send multiple searches with different filters on the same index at once?
      instructions:
      - text: 'Run these search queries together in one request: {requests}.'
        slots:
          requests: requestBody.requests
      - text: Execute the multi-index searches {requests} using strategy {strategy}.
        slots:
          requests: requestBody.requests
          strategy: requestBody.strategy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/indexes/*/recommendations'].post
  update:
    x-apievangelist-phrasing:
      intent: Get recommendations from AI models
      effect: read
      questions:
      - How do I fetch recommendations from Algolia's AI recommendation models?
      - Can I ask several recommendation models for results in one call?
      instructions:
      - text: 'Get recommendations for these model requests: {requests}.'
        slots:
          requests: requestBody.requests
      - text: Ask the selected recommendation models for results using {requests}.
        slots:
          requests: requestBody.requests
      method: generated
      generated: '2026-09-26'