Indexes

An index is a crawled website turned into searchable pages. Creating one starts a background crawl, so the index begins in a pending state and moves to indexed when it finishes. Indexes always resolve to your account’s default workspace. There is no workspace_id parameter on any index endpoint. Any authenticated token can reach them.

The index endpoints do not use the data envelope. GET /api/v1/indexes returns a bare JSON array, and the single item and create endpoints return bare objects.

List indexes

GET /api/v1/indexes

curl 'https://app.nemu.cc/api/v1/indexes' \
  -H 'Authorization: Bearer <access_token>'

const indexes = await nemu.indexes.list();

[
  {
    "id": "idx_1",
    "workspace_id": "ws_1",
    "base_url": "https://example.com",
    "title": "Example docs",
    "page_count": 24,
    "status": "INDEXED",
    "error": null,
    "created_at": "2026-01-04T10:22:00.000Z",
    "updated_at": "2026-01-04T10:30:00.000Z"
  }
]

string

One of PENDING, INDEXING, INDEXED, or FAILED.

The crawled pages themselves are not returned by the API. Only the index metadata is.

Get an index

GET /api/v1/indexes/{id}

Returns a bare index object.

Create an index

POST /api/v1/indexes

string

required

The site to crawl.

string

A label for the index. Max 500 characters.

integer

default:"20"

A cap on how many pages to crawl, from 1 to 50.

const index = await nemu.indexes.create({
  url: "https://example.com",
  title: "Example docs",
  max_pages: 50,
});

{
  "id": "idx_1",
  "status": "PENDING"
}

Poll GET /api/v1/indexes/{id} until status leaves PENDING and INDEXING.

Delete an index

DELETE /api/v1/indexes/{id}

{ "success": true }

Get started

Setup

API reference

List indexes

Get an index

Create an index

Delete an index

​List indexes

​Get an index

​Create an index

​Delete an index

List indexes

Get an index

Create an index

Delete an index