Introduction
The ZeroIndex REST API. Every endpoint takes and returns JSON, and every request is authenticated with a key.
Use the API directly from any language, or through one of the official SDKs, which wrap the same endpoints. Every example in this reference shows cURL, JavaScript and Python.
Base URL
https://api.zeroindex.test/v1Requests go to the region your project lives in. You can find your project’s URL in the dashboard under Settings.
Authentication
Send an API key as a bearer token in the Authorization header. Admin keys can call every endpoint. Search keys can only call the search endpoints. Read more in Authentication.
curl https://api.zeroindex.test/v1/indexes \
-H "Authorization: Bearer $ZEROINDEX_KEY"Asynchronous writes
Endpoints that change data return 202 Accepted with a task instead of waiting for the change to finish. The change is searchable once the task succeeds, usually in under a second.
{
"taskUid": 8812,
"indexUid": "products",
"status": "enqueued",
"type": "documentAdditionOrUpdate",
"enqueuedAt": "2026-10-15T09:14:02Z"
}Pagination
List endpoints take limit and offset query parameters and return the total alongside the results.
How many results to return, from 1 to 100.
How many results to skip.
Rate limits
| Key | Limit |
|---|---|
| Search key | 1,000 requests per second |
| Admin key | 100 requests per second |
When you go over a limit, the API answers with 429 and a Retry-After header that says how many seconds to wait.