Your Page Title

The Python client has the same methods as the REST API, named in snake case. Use ZeroIndex in scripts and Django or Flask apps, and AsyncZeroIndex with asyncio or FastAPI.

Install

pip install zeroindex

uv add zeroindex

poetry add zeroindex

Set up the client

import os
from zeroindex import ZeroIndex

client = ZeroIndex(
    os.environ["ZEROINDEX_KEY"],
    host="https://api.zeroindex.test",
    timeout=5,
)

hoststrdefault "https://api.zeroindex.test"

Your project’s URL, from the dashboard.

timeoutfloatdefault 10

How long to wait for a response, in seconds.

Add documents and search

products = client.index("products")

task = products.add_documents([
    {"id": 1, "name": "Wireless headphones", "price": 129},
    {"id": 2, "name": "Desk lamp", "price": 59},
])
client.wait_for_task(task.task_uid)

results = products.search("wirless", {"limit": 5})
for hit in results.hits:
    print(hit["name"])

Async

Every method has an async version with the same name.

from zeroindex import AsyncZeroIndex

client = AsyncZeroIndex(os.environ["ZEROINDEX_KEY"])

async def search(query: str):
    return await client.index("products").search(query)

Errors

Failed requests raise ZeroIndexError with the code from the error table.

from zeroindex import ZeroIndexError

try:
    client.index("products").search("lamp", {"filter": "colour = red"})
except ZeroIndexError as error:
    if error.code == "invalid_filter":
        print(error.message)