Python API client changelog

4.37.0

feat(specs): add optional feedID to composition result set (#5991)
fix(specs): invalid API format for multi feed in Comp API (#5993)

4.36.1

docs(specs): align with style guides (#5930)
fix(specs): insights-api timestamp documentation (#5925)
fix(specs): BREAKING CHANGE – remove unnecessary required fields (#5959)
The SearchResponse model now accepts query and params as optional parameters, as they are not always returned by the API.
fix(specs): add missing redirect property to rule consequence schema (#5934)

4.36.0

BREAKING CHANGES: this minor version includes multiple breaking changes related to fixes on different APIs. See below for more details.

feat(specs): conditions is not required anymore in composition rules (#5853)
docs(SearchParams): Document that filter scores are supported in virtual replicas (#5716)
feat(python): Increase timeout on retries (#5857)
fix(specs): BREAKING CHANGE – remove baseRecommendRequest from trendingFacets [CR-10264] (#5858)
The TrendingFacets model has been updated to reflect the API response.
docs: BREAKING CHANGE – authentication type can’t be updated (#5824)
The AuthenticationUpdate model has been updated to reflect that the type field can’t be updated.
feat(clients): Test python timeout (#5883)
fix(specs): allow additionalProperties on insights-api events (#5885)
fix(specs): update currency validation rules (#5890)
fix(specs): BREAKING CHANGE – more accurate composition behavior typing (#5892)
The CompositionBehavior model is now a union type for better accuracy.
fix(clients): Increased timeout delta for Python and Swift tests (#5893)
feat(specs): BREAKING CHANGE – Ingestion API: new code property in oauth authentication (#5897)
The AuthOAuth and AuthOAuthPartial models have been updated to reflect that the clientId field is now optional, and the code field can be set.

4.35.4

chore: agentic config prep (#5825)

4.35.3

fix(specs): BREAKING CHANGE — remove fields requirement from run response in CompAPI client (#5809)
Some fields from the Composition Run search response were marked as required while they were optional on the API side. This has been fixed, but might impact the client types.

4.35.2

chore: update Python version in release workflow to 3.13.7 (#5771)

4.35.1

refactor(specs): extract results field in a dedicated directory (#5739)
chore(deps): dependencies 2025-11-24 (#5653)
refactor(specs): re-organise response for Composition API (#5744)
fix(specs): update list with NLU permissions (#5769)

4.35.0

chore(scripts): update the jira action (#5678)
chore(scripts): remove component from jira ticket (#5680)
chore(specs): change oneOf order for docs (#5676)
feat(specs): add sortBy query param and sortingStrategy (#5686)
feat(specs): add sortBy trigger on Composition Rules (#5707)
docs(abtests): Added documentation for featureFilters configuration i… (#5688)

4.34.0

feat(specs): allow enablePersonalization query parameter at run time for Composition API (#5651)

4.33.0

feat(specs): add useImagesObjects property in commercetools source input (#5586)
fix(specs): Add title values to key oneOfs (#5581)
fix(specs): update run reason in observability (#5623)
fix(specs): add tags and scope to rules (#5625)

4.32.0

feat(clients): remove schedule capabilities (#5552)
feat(specs): add fallbackParameters to Frequently bought together [RECO-2443] (#5579)

4.31.0

feat(specs): add renderingContent query parameter in Composition API main injection (#5549)
fix(specs): add ACL to missing endpoints (#5529)
feat(specs): add specific documentation for facets query parameter in Composition API (#5477)

4.30.0

chore(scripts): downgrade python version for release (#5482)
fix(specs): ingestion small fix + added source input descriptions (#5515)
feat(specs): add facets query parameter available at run time (#5486)
chore(deps): dependencies 2025-10-20 (#5487)

4.29.1

chore(deps): dependencies 2025-10-13 (#5453)
fix(clients): upgrade linter (#5476)
chore: remove dead links (#5472)
docs: replace links for the new doc (#5478)

4.29.0

feat(specs): add compositions deduplication setting (#5418)
fix(clients): add a default idleConnTimeout (#5442)
chore(deps): dependencies 2025-09-29 (#5393)

4.28.0

feat(specs): add partialNoCreate action to ingestion specs (#5389)

4.27.0

chore(deps): dependencies 2025-09-08 (#5310)
chore(python): remove redundant check (#5338)
fix(specs): normalize spelling of summaries (#5340)
feat(specs): allow filtering transformations type (#5363)
chore(deps): dependencies 2025-09-15 (#5341)
feat(specs): merge composition & composition-full (#5333)

4.26.0

fix(specs): Cross-reference filerPromotes to relevant guide (#5279)
feat(specs): add put task endpoint to ingestion api (#5281)
fix(specs): add getVersion parameter to getSettings (#5254)
fix(python): remove warnings for HighlightResult and SnippetResult (#5284)
chore(website): exclude schema from generated variables file (#5306)
fix(clients): link to support/help center on unreachable hosts (#5305)

4.25.0

fix(clients): prefix tags with v (#5186)
refactor(specs): mutualise code between Search API & Comp API for search query parameters (#5125)
fix(specs): define batch actions (#5242)
feat(specs): add fields for metadata in composition injectedItems (#5241)
fix(python): change badge to correctly reflect supported python versions (#5274)
chore(deps): dependencies 2025-08-11 (#5225)
feat(specs): abtests stopped at (#5275)

4.24.0

feat(clients): add new abtesting-v3 package to clients + stabilize alpha js package (#5157)

4.23.1

refactor(specs): add interface to manipulate query parameter between composition API & Search API (#5123)
fix(specs): value/price clarifications in the Insights API (#5154)
fix(clients): reduce chances of Push rate limiting (#5153)

4.23.0

feat(specs): document runMetadata parameter (#5087)
fix(specs): averageClickPosition return type (#5089)

4.22.1

fix(specs): update sourceRun docs (#5057)
fix(specs): allow one sided rule validity (#5060)

4.22.0

feat(specs): abtesting winsorizedAmount (#5053)

4.21.0

feat(clients): add replaceAllObjectsWithTransformation (#5008)
chore(spec): fix comment of custom path (#5014)
fix(clients): allow chunked requests on WithTransformation methods (#5011)
feat(clients): add replaceAllObjectsWithTransformation (#5013)

4.20.0

chore(deps): dependencies 2025-06-09 (#4943)
feat(specs): update try transformation specs for no-code (#4974)
chore(deps): dependencies 2025-06-16 (#4977)
fix(clients): processingTimeMS should be optional (#5004)
feat(specs): add new ingestion property for push (#5007)

4.19.0

feat(specs): add with transformation helpers (#4931)
chore: add tests for WithTransformation methods (#4936)
fix(clients): consistent naming in transformation region helper (#4937)

4.18.0

fix(specs): typo (#4854)
feat(specs): add global push endpoint (#4855)
fix(specs): updated watchResponse (#4879)
feat(python): add bridge to transformation on search (#4898)
feat(specs): update transformation specs for no-code (#4901)
chore(deps): dependencies 2025-06-02 (#4899)
fix(specs): more indexing actions to push (#4930)
fix(specs): wrong ACL for getSettings (#4933)

4.17.0

fix(specs): add x-acl to insights endpoints (#4822)
feat(scripts): add push to mcp-node on release (#4784)

4.16.5

chore(deps): dependencies 2025-04-28 (#4785)

4.16.4

fix(specs): condition cant be numeric filter (#4726)
fix(specs): event.status can be null (#4727)
fix(specs): add missing recordType collection (#4728)
chore(deps): dependencies 2025-04-14 (#4729)
fix(clients): correctly deserialize SearchResult (#4756)

4.16.3

docs(partialUpdate): add note about multiple operations (#4721)
fix(specs): message is not required in WatchResponse (#4723)

4.16.2

fix(specs): make the updateAt non-null in ingestion (#4697)

4.16.1

chore: deprecate mcm methods (#4694)

4.16.0

feat(specs): add CT Query predicate property (#4654)

4.15.0

chore(deps): dependencies 2025-03-10 (#4566)
fix(python): npe in request options merge method (#4612)
feat(specs): add the owner attributes to ingestion resources (#4616)
fix(python): missing Decimal to float conversion for body serializer (#4618)

4.14.0

feat(specs): add subscriptionAction to ingestion specs (#4587)

4.13.3

chore(guides): some missing snippets + guides (#4477)
chore(scripts): point jira issues to another epic (#4505)
fix(specs): Increase optionalWords visibility in docs (#4559)

4.13.2

chore(deps): dependencies 2025-02-10 (#4432)

4.13.1

guides: add missing snippets to docs (#4391)
fix(specs): responseFields description (#4399)
fix(specs): add a linter to assert that type is present (#4393)

4.13.0

feat(specs): only use shortname in the source input (#4287)
fix(specs): move customRanking and keepDiacriticsOnCharacters to indexSettings (#4324)
chore(deps): dependencies 2025-01-13 (#4325)
fix(specs): optionalFilters additional explanation (#4353)
fix(specs): deprecate task v1 (#4327)
fix(specs): ingestion expected and received events type (#4356)
fix(specs): extend Analytics descriptions (#4360)
fix(specs): remove the processing outcome (#4359)
fix(specs): adjust style for banner descriptions (#4362)
feat(specs): rename composition to composition-full (private) and add composition (public) (#4357)

4.12.0

fix(specs): drop singer from ingestion specs (#4281)
feat(clients): cleanup after replaceAllObjects failure (#3824)
chore(deps): dependencies 2025-01-06 (#4299)
feat(specs): add notification settings to tasks (#4297)
feat(clients): add optionnal scopes to replaceAllObjects (#4296)
chore: revert release (#4314)

4.11.2

chore: trigger auto close pr (#4250)
fix(clients): support dict in helpers (#4254)
fix(specs): endpoint level timeout for ingestion (#4251)

4.11.1

fix(specs): enable watcher for push (#4229)
fix(specs): add ignoreConjugations to AlternativesAsExact (#4230)

4.11.0

fix(specs): different summaries for saveObject/addOrUpdate methods (#4223)
feat(specs): add watch to pushTask ingestion (#4224)

4.10.0

feat(specs): add info and link about indexing rate limits (#4136)
fix(python): expose user_agent on the config (#4141)
fix(specs): nb_api_calls in getLogs response is optional (#4142)
fix(python): do not share parameters for browse methods (#4168)
fix(specs): consequence is required when saving rules (#4146)
fix(specs): saveRule response type (#4170)
feat(clients): allow batch size on objects helper (#4172)
fix(specs): remove SFCC source type (#4190)
fix(specs): add sourceType to listTasks (#4193)
feat(generators): allow per-spec timeouts (#4173)

4.9.2

chore(deps): dependencies 2024-11-18 (#4109)
chore(deps): upgrade openapi-generator to v7.10.0 (#4131)

4.9.1

fix(specs): make the searchParams compatible with v4 (#4108)
fix(specs): remove private beta endpoint from recommend (#4110)

4.9.0

feat(specs): add estimate path and responses (#4057)
feat(specs): update estimate response type (#4101)

4.8.1

fix(specs): add secrets payload for updates (#4061)
fix(clients): update browse iterator (#4058)

4.8.0

feat(specs): add secrets authentications to ingestion (#4054)

4.7.0

feat(specs): add missing message attribute to GetObjectsResponse [skip-bc] (#4029)
fix(specs): support synonyms type in camel case [skip-bc] (#4031)
chore(deps): dependencies 2024-10-28 [skip-bc] (#4032)
feat(clients): expose waitForTasks to batch helpers [skip-bc] (#4030)

4.6.5

fix(specs): results in getObjects is required (#4024)

4.6.4

fix(python): required aggregator parameter in browse_* (#4016)

4.6.3

docs(analytics): constrain pagination only to limit query parameter (#4012)

4.6.2

fix(specs): Typo tolernace on words (#3968)
fix(specs): Add context to hitsPerPage (#3969)
fix(specs): alternativesAsExact is plurals and synonyms (#3974)
fix(specs): Separators are non-alphanumeric characters (#3978)
fix(specs): multiple clients fixes (#3971)

4.6.1

fix(specs): Typos in API descriptions (#3932)
fix(specs): use the read transporter for browse (#3938)
chore: apply codacy fixes (#3935)
fix(specs): correct type for banners [skip-bc] (#3939)

4.6.0

feat(templates): add request_options to python helpers consistently (#3868)
fix(specs): update analytics and abtesting max pagination query limit (#3696)
chore(python): proper type hinting (#3839)
feat(specs): add support for widgets / banners in search for the csharp client (#3870)
fix(specs): correct typos is Search API (#3898)
chore: revert and fix release (#3922)

4.5.0

chore(clients): add workflow to auto-close PR (#3834)
fix(specs): API key description will be obfuscated (#3840)
feat(specs): add recommend batch rules endpoint (#3782)

4.4.6

fix(specs): correct query params for ingestion [skip-bc] (#3830)

4.4.5

fix(python): update deserialization templates and typing issues (#3780)

4.4.4

fix(python): exclude unset API values on model dump (#3777)

4.4.3

fix(specs): recommend remove unsupported query parameters [RECO-2345] [skip-bc] (#3692)
fix(specs): remove models from ingestion specs [skip-bc] (#3774)

4.4.2

fix(python): missing transporter close (#3741)
fix(specs): update search api specs [skip-bc] (#3760)
chore(deps): dependencies 2024-09-16 [skip-bc] (#3704)

4.4.1

fix(specs): remove usage [skip-bc] (#3691)
feat(specs): add (optional) _automaticInsights to search result (#3688)

4.4.0

feat(python): add sync client (#3609)

4.3.0

feat(clients): helper to switch API key in use (#3616)
fix(specs): note on Analytics API server (#3650)
feat(clients): add helper to check if an index exists (#3646)
fix(specs): note on insights API server (#3649)
fix(specs): don’t extend $ref objects (#3623)

4.2.4

fix(specs): usage api (#3624)
fix(specs): no links across API specs (#3643)

4.2.3

fix(specs): ignorePlurals can be a boolean string (#3620)
fix(clients): correly parse usage hosts (#3622)

4.2.2

fix(python): 3.8 compatibility and CI multi-version [skip-bc] (#3613)
fix(specs): ingestion push task payload [skip-bc] (#3607)

4.2.1

fix(specs): partial update operation (#3486)

4.2.0

feat(specs): push source type (#3600)
fix(specs): filter run list by type (#3577)
docs(specs): update api’s length minimum value (#3574)

4.1.1

fix(clients): highlight and snippet results e2e (#3567)
fix(specs): another wrong link (#3570)
chore(specs): breaking change method names mapping table (#3568)
fix(clients): mention main branch instead of master (#3566)
fix(specs): broken link (#3559)

4.1.0

feat(specs): add /schedule endpoint (#3350)

4.0.2

chore(specs): update rendered title for search params (#3553)

4.0.1

fix(specs): delete user token processing time (#3525)

4.0.0

New major version released! Browse our documentation

fix(specs): required ingestion search params (#3516)

4.0.0b31

feat(specs): recursive snippets and highlights result (#3497)

4.0.0b30

feat(specs): add authentications to ingestion transformations (#3494)

4.0.0b29

feat(specs): add generate code endpoint to ingestion specs (#3489)
fix(specs): ingestion docker task input (#3488)
fix(specs): ingestion search endpoint (#3487)

4.0.0b28

feat(specs): add transformation copilot to ingestion (#3479)
fix(specs): ingestion destination reject indexPrefix (#3478)
fix(specs): ingestion destinations and transformations (#3477)
fix(clients): move the license to the root (#3457)
fix(specs): dictionary entry for stopwords has type property (#3456)
fix(specs): body is not required in multiple batch request (#3454)
feat(specs): add runSource endpoint (#3453)
chore(clients): remove mention of GA (#3452)

4.0.0b27

fix(specs): built-in ops accept also int (#3450)
fix(specs): required prop for dictionaryEntry (#3449)
feat(clients): delete unused models (#3445)
fix(specs): proper title with linter (#3444)
fix(specs): getObject return object (#3446)
fix(specs): clarify decompounding limitations (#3227)

4.0.0b26

feat(specs): add v2 endpoints for ingestion (#3416)
fix(specs): add primary to get settings response (#3415)
chore(specs): add eslint rule to avoid cross-references (#3413)
fix(specs): remove cross-references of analytics (#3414)
feat(specs): add v2 endpoints for ingestion (#3410)
fix(specs): remove cross-specs references (#3412)

4.0.0b25

fix(specs): update shopify feature flags (#3380)
feat(clients): add api key helper test (#3338)
fix(specs): recommend non required parameters (#3355)
fix(specs): results is required in GetRecommendationsResponse (#3357)

4.0.0b24

fix(specs): browse response required properties (#3348)
fix(specs): ingestion task and transformation (#3347)
fix(python): browse objects (#3346)
fix(specs): clarify browse parameters (#3333)

4.0.0b23

feat(specs): add redirect to renderingContent (#3296)

4.0.0b22

fix(clients): update ingestion transformations description and fix taggroups (#3265)

4.0.0b21

feat(clients): generate common LICENSE (#3258)
fix(clients): update README snippets and contributing guides (#3257)
feat(clients): add saveObjects, deleteObjects and partialUpdateObjects helpers (#3180)
fix(specs): virtual is a fetchedIndex props (#3255)
fix(specs): add virtual index settings and update renderingContent (#3254)
fix(clients): chunked batch helper size property consistency (#3253)

4.0.0b20

feat(specs): add transformations endpoints to ingestion (#3215)
fix(specs): update discover endpoint (#3212)
feat(specs): add validate endpoint (#3087)
chore(clients): use the ruff python formatter (#3204)
fix(clients): reduce common tests flakyness (#3205)
feat(clients): add chunkedBatch helper for Kotlin and Scala (#3206)
feat(clients): add generateSecuredApiKey to java (#3167)

4.0.0b19

feat(clients): add generate_secured_api_key to ruby (#3166)
fix(clients): safer replaceAllObjects + metis compliant (#3164)
fix(python): remove contact (#3161)

4.0.0b18

fix(clients): remove unused models from lite clients (#3159)
feat(clients): add waitForAppTask helper (#3158)
fix(clients): chunked batch helper (#3154)
fix(specs): rankingInfo required properties (#3157)
feat(specs): add getAppTask endpoint to search (#3156)
fix(specs): dont mention index api keys (#3117)

4.0.0b17

fix(specs): exhaustiveFacetsCount is not deprecated for sffv (#3089)
fix(python): properly remove existing codegen (#3056)
fix(specs): simplify filter types (#3042)

4.0.0b16

feat(specs): promote @kai687 to code owner (#3014)
fix(specs): remove periods on summaries (#3013)

4.0.0b15

fix(specs): attribute and index names case sensitive (#2990)
feat(specs): update shopify source and task inputs (#2987)
fix(specs): Personalization API (#2982)
fix(specs): a/b testing (#2981)

4.0.0b14

fix(specs): recommend api (#2958)
fix(specs): update documentation for consistency (#2976)
feat(clients): add usage client (#2960)
feat(specs): add algoliaInsights auth type (#2959)
fix(specs): usage api (#2954)
fix(specs): crawler api (#2949)

4.0.0b13

fix(specs): query suggestions api (#2924)
fix(specs): ingestion api reference (#2918)

4.0.0b12

fix(specs): more flexible custom methods (#2889)
chore(python): playground lock file (#2893)
fix(python): bump black from 23.11.0 to 24.3.0 (#2892)

4.0.0b11

fix(specs): make languages an enum (#2865)

4.0.0b10

feat(specs): insights api reference (#2859)
feat(specs): add ga4BigqueryExport, streaming and append options to task inputs (#2858)
feat(specs): improve API reference documentation (#2831)

4.0.0b9

feat(specs): Add MappingInput to Task Inputs (#2787)

4.0.0b8

fix(specs): add queryID to search response (#2801)
feat(python): add batch_size to chunked batch (#2769)
chore(specs): remove JSON specs and new worlds logic (#2794)

4.0.0b7

fix(specs): add missing attributes for CT Source update (#2792)
feat(python): add chunked_batch (#2763)
fix(clients): replace all objects (#2762)
feat(python): add replace_all_objects (#2756)
feat(python): add generate_secured_api_key and get_secured_api_key_remaining_validity (#2753)
fix(clients): browse synonyms page not in response (#2757)

4.0.0b6

fix(python): remove default values (#2750)
fix(specs): allow custom fields to be nullable (#2746)

4.0.0b5

feat(specs): add CustomFields to CT Source Input (#2742)
fix(clients): add e2e tests for analytics API (#2737)

4.0.0b4

fix(python): wait for task helper (#2646)

4.0.0b3

fix(specs): correct searchSynonyms parameters (#2595)
feat(specs): import crawler and usage specs from new world repo (#2598)
feat(specs): AB testing tracked user count (#2596)
fix(clients): support the rest of the languages (#2571)
fix(clients): monitoring for JavaScript and Python (#2568)
fix(python): full overwrite data with request_options (#2558)
feat(specs): add acl permissions to operations (#2555)
fix(specs): rename clearAllSynonyms to clearSynonyms (#2553)

4.0.0b2

feat(specs): update Insights API spec (#2376)
chore(clients): provide snippets for all languages (#2518)
feat(clients): generate code snippets from cts (#2511)

4.0.0b1

Bump pre-release to beta.

4.0.0a7

feat(python): improve docstring and fix transporter errors (#2501)
feat(clients): deserialize in e2e and SFFV response (#2500)
chore(clients): add more e2e (#2497)

4.0.0a6

feat(clients): add missing clients (#2479)
fix(python): provide community requested changes (#2478)

4.0.0a5

fix(specs): port recommend changes (#2476)

4.0.0a4

fix(python): release (#2472)

4.0.0a3

feat(python): add browse helpers (#2452)
feat(python): add wait helpers (#2448)
docs(python): add migration guides (#2455)
chore(python): code cleanup (#2456)
fix(python): model parsing (#2454)

4.0.0a2

fix(python): less breaking changes (#2442)
chore(python): cleanup and variable names (#2416)
feat(python): add clients CTS (#2411)
feat(python): add release process (#2372)
chore(python): improve serializer definition (#2402)
feat(python): add CTS (#2373)
fix(python): common response deserializer (#2375)
fix(specs): provide non clashing names for custom methods (#2369)
fix(python): path encoding and request options (#2367)
fix(python): deserializer and unused helpers (#2309)
fix(specs): highlight result map definition (#2312)
feat(python): add Algolia transporter, response deserializer and config setup (#2306)

4.0.0-alpha.1

fix(python): template cleanup and playgrounds (#2286)
feat(python): initial setup for new API client (#2283)

API clients (current)

Clients and methods