Back to monitors
Informational AI classification

Documented Correlation-ID and Request-ID headers

Added documentation about request identification headers: Correlation-ID (returned in all responses to identify requests in logs) and optional Request-ID (custom 11-character alphanumeric identifier). This documents existing API behaviour but does not change any endpoints, parameters, or response schemas.

Alert history

  • Informational

    Documented Correlation-ID and Request-ID headers

    Added documentation about request identification headers: Correlation-ID (returned in all responses to identify requests in logs) and optional Request-ID (custom 11-character alphanumeric identifier). This documents existing API behaviour but does not change any endpoints, parameters, or response schemas.

  • Breaking

    Several fields removed from recommend/search schemas

    Multiple fields are removed from key schemas in the Algolia Recommend API spec:

    • facetFilters removed from baseRecommendSearchParams
    • enableABTest removed from baseRecommendSearchParams
    • ranking schema definition removed and its $ref removed from recommendIndexSettings
    • enableRules moved out of recommendIndexSettings and into an inline object on recommendSearchParams only

    Additionally, fallbackParams now composes baseRecommendSearchParams + searchParamsQuery + recommendIndexSettings instead of the full recommendSearchParams, changing which parameters are accepted for fallback requests. Clients passing facetFilters, enableABTest, ranking, or enableRules (in contexts other than recommendSearchParams) to these schemas may have those parameters silently ignored or rejected.

  • Additive

    Add searchResponsePartial schema for flexible response field control

    The API adds a new searchResponsePartial schema to the searchResult union that represents partial search responses when the responseFields parameter excludes certain fields. This enables clients to explicitly handle cases where optional response fields may be omitted, improving flexibility in response handling without breaking existing integrations.