Account and team

Projects

Group the indices and API keys of one shop or one environment, and keep staging apart from production.

What a project is

A project groups the indices and the API keys of one shop or one environment. It is also the boundary for keys. A key of one project can never see the indices of another. Every organization starts with one project called Default.

Use one project per environment, for example Shop staging and Shop production. A script that runs with the staging key then cannot change the production catalog by mistake. Use one project per shop when one team runs several shops.

All projects of an organization share its plan. Documents, searches and indices count against the plan across all projects together.

See your projects

Organization → Projects shows one card per project with its indices. Click a card to open the project. The project id is part of the URL, /app/p/<project id>/indices, and the REST routes take the same id.

GET/v1/orgs/:orgId/projectsAny member of the organizationGET/v1/projects/:projectIdAny member of the organization, or a secret key of the project

A project of an organization you do not belong to answers 404 PROJECT_NOT_FOUND, the same as one that does not exist. A secret key of another project gets the same answer.

Create a project

Click New project, enter a name of 1 to 100 characters and click Create project. Creating projects needs the admin or owner role. Two projects may have the same name, so pick names that tell them apart.

POST/v1/orgs/:orgId/projectsAdmin or owner of the organization

curl -X POST https://api.zaproo-search.com/v1/orgs/$ORG_ID/projects \
  -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{"name": "Shop production"}'

The answer is the new project with its id. Then create the project's indices and its API keys. A new project has neither.

There is no route to rename or delete a project yet.

What lives in a project

Indices, each with its mapping, documents, search profiles, synonyms, ranking rules and autocomplete. See Indices.
API keys that act on the project's indices. See API keys.
Tasks, the history of document uploads and reindexing for every index of the project.
The MCP connection page, with the command that connects an AI agent to the project. See MCP setup.

Common mistakes

Testing on the production project. Create a staging project with its own keys and index, and copy settings over when they work.
Using one secret key for every environment. A key belongs to one project. Create a key in each project, so you can revoke one without breaking the other.

Organizations, members and roles

What an organization holds, how to add members, and what owners, admins and members may do.

API keys