Overview
The Etoile API. Index documents, search them.
Base URL
https://etoile.dev/api/v1Authentication
Pass your API key as a Bearer token:
Authorization: Bearer YOUR_API_KEYKey types:
- Secret key — required for indexing, deleting, updating
- Public key — can be used for search (safe for client-side)
Endpoints
POST
/api/v1/indexIndex a document.
POST
/api/v1/searchSearch documents.
DELETE
/api/v1/documentsDelete a document.
PATCH
/api/v1/documentsUpdate document metadata.
Response format
Success returns the payload directly. Errors look like:
{
"error": "Human-readable message"
}Limits
| Parameter | Type | Description |
|---|---|---|
Query length | max 150 chars | Search query limit. |
Search results | default 10, max 100 | Use limit and offset. |
Title | max 200 chars | Document title. |
Collection name | max 50 chars | Namespace. |
Metadata size | max 10,000 chars | JSON.stringify(metadata).length |