Skip to content

Create a Project ​

index4.ai is project-scoped. Every ingested document, every embedding, every search result lives inside one project namespace. You create that namespace through the index4.ai console — there's no curl required, no JWT bootstrap, no separate API setup step.

What a project is ​

FieldMeaning
idInternal UUID, used in /projects/{projectId} admin paths.
project_idClient-facing slug (alphanumeric + underscores, ≤64 chars). Server-assigned at creation.
nameHuman-readable display name. You choose it.
productAlways grill for index4.ai projects (a literal API value). Cannot be changed later.
account_idOwning account. Defaults to the authenticated account.
orga_idIf set, the project belongs to an organisation and is governed by its quota and member roles.
storage_baseInternal storage prefix. Read-only.

Create a project — console workflow ​

  1. Open the index4.ai console and sign in.
  2. Open your projects and start a new one.
  3. Enter a project name.
  4. Optionally pick an organisation — leave it empty for a personal project.
  5. Confirm to create the project.

The console hands back a poma_proj_gr_… API key in the confirmation dialog. Copy it immediately — it's shown once. Treat it like a database password and put it straight in your secret manager. If you lose it, rotate the key (see below).

Need to provision projects programmatically (CI, multi-tenant onboarding, customer-spawned namespaces)? Use POST /projects from the API reference. These docs intentionally don't duplicate the HTTP calls — the console is the supported path for human-operated setup.

Personal vs. organisation-scoped projects ​

The choice is the organisation selector at creation time:

  • No organisation → the project is owned by your account. Its quota counts against your personal plan.
  • A named org → the project is owned by that organisation. The caller (you) must be owner or admin in that org; member is rejected. The project's quota counts against the org's plan, and other admins can manage it.

Create or browse organisations in the same console: filter by name, create new ones, or remove ones you no longer need.

Inspect, rotate, delete ​

Each lifecycle action is available in the index4.ai console and over the API:

ActionAPI
ListGET /projects — every project you can see: your personal ones and any in organisations where you're a member.
InspectGET /projects/{projectId}
RotatePOST /projects/{projectId}/generateApiKey — returns a fresh poma_proj_gr_… API key.
DeleteDELETE /projects/{projectId} — see below for what it does.

The same actions are exposed by GET /projects, GET /projects/{id}, POST /projects/{id}/generateApiKey and DELETE /projects/{id} in the API reference for scripted lifecycle management.

What "delete" really means ​

Deleting a project (in the console or via DELETE /projects/{id}) is a soft delete:

  • The project disappears from your project list and stops serving requests.
  • Deleted projects can be listed with GET /projects/deleted and brought back with POST /projects/{id}/restore.

If you only want to remove a single document, call DELETE /docs/{docId} (Document management) — that keeps the project intact.

Next ​