Authentication

ZeroIndex uses bearer tokens. Send your key in the Authorization header of every request.

curl https://api.zeroindex.test/v1/indexes \
  -H "Authorization: Bearer zi_admin_4f8a2c91e7"

Header

Kinds of keys

There are two kinds of keys. You can create as many of each as you need.

• Admin keys start with zi_admin_. They can create and delete indexes, change settings and add documents.
• Search keys start with zi_search_. They can only search, so they are safe to use in a browser or a mobile app.

Scoped search keys

A scoped key limits a search key to some indexes or adds a filter to every query. Use one to make sure each customer only sees their own documents.

const key = client.keys.createScoped({
  parent: process.env.ZEROINDEX_SEARCH_KEY,
  indexes: ["tickets"],
  filter: "account_id = 4821",
  expiresIn: "1h",
});

Questions