Composition API client

The Composition API client is part of the algoliasearch package. You can install this package with pip:

1
pip install 'algoliasearch>=4,<5'

To use the Composition client, add this import to your files:

1
from algoliasearch.composition.client import CompositionClientSync

To create an instance of the client:

1
2
# In an asynchronous context, you can use CompositionClient instead, which exposes the exact same methods.
client = CompositionClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

Async code

To use the Composition client in async environments, add these imports instead:

1
2
import asyncio
from algoliasearch.composition.client import CompositionClient

The client supports the async with statement to automatically close open connections.

1
2
3
async def run():
    async with CompositionClient(ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY) as client:
        # client.search(...)

The method names are the same for synchronous and asynchronous methods.

List of methods

Each method makes one request to the Composition API.

Search