Overview

The Etoile API. Index documents, search them.


Base URL

https://etoile.dev/api/v1

Authentication

Pass your API key as a Bearer token:

Authorization: Bearer YOUR_API_KEY

Key types:

  • Secret key — required for indexing, deleting, updating
  • Public key — can be used for search (safe for client-side)

Endpoints

POST/api/v1/index

Index a document.

POST/api/v1/search

Search documents.

DELETE/api/v1/documents

Delete a document.

PATCH/api/v1/documents

Update document metadata.


Response format

Success returns the payload directly. Errors look like:

{
"error": "Human-readable message"
}

Limits

ParameterTypeDescription
Query lengthmax 150 charsSearch query limit.
Search resultsdefault 10, max 100Use limit and offset.
Titlemax 200 charsDocument title.
Collection namemax 50 charsNamespace.
Metadata sizemax 10,000 charsJSON.stringify(metadata).length