Skip to main content
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 belong to a workspace, so pass workspace_id on reads and writes. Reads need models:read and writes need models:write.

List indexes

string
One of PENDING, INDEXING, INDEXED, or FAILED.

Get an index

Create an index

string
required
The workspace the index belongs to.
string
required
The site to crawl.
string
A label for the index.
integer
A cap on how many pages to crawl.

Delete an index