API Reference
Every Tachyon REST endpoint, its parameters, and its response shape.
Tachyon exposes a single flat REST API over HTTP — no GraphQL, no gRPC, no SDK required. All request and response bodies are JSON.
- Collections — create, list, fetch, and delete collections
- Documents — index, fetch, and delete documents
- Search — search and autocomplete
- Configuration — health, metrics, and analytics
- Errors — error response shape and codes
Base URL
All examples assume a locally running instance:
http://localhost:8108Authentication
Requests are authenticated with the x-tachyon-api-key header. See
Configuration → Authentication for the
full admin-key vs. search-key behavior — every endpoint below notes what
access level it requires.
Live, interactive docs
A running Tachyon instance also serves this same API as interactive Swagger
UI at /docs on the instance itself, and as a raw OpenAPI schema at
/api-docs/openapi.json — useful for generating client code, distinct from
this website's own /docs section.