For Developers
API-first document management for developer workflows. Build, automate, and integrate with tools you already know.
How It Works
Get your API key
Generate API keys with granular scopes — read-only, write, or admin — and optional vault restrictions. HMAC request signing secures write operations. Keys use an 8-character prefix for fast verification without exposing the full token.
Install the SDK or CLI
The TypeScript SDK provides type-safe programmatic access for building integrations and automations. The CLI enables shell scripting, CI/CD pipelines, and quick document operations from the terminal. Both support all API operations including search, sync, and bulk updates.
Push your documents
Create, read, update, and delete documents via REST API. Atomic writes with temp-file-and-rename prevent partial reads. Content deduplication via SHA-256 hash checking skips unchanged writes automatically, keeping sync efficient.
Automate with webhooks
Configure outbound webhooks for document lifecycle events — create, update, delete. Each delivery includes HMAC signatures for verification. Built-in retry logic with exponential backoff ensures reliable delivery. Monitor delivery status and debug failures from the dashboard.
Search and integrate
Full-text search with websearch syntax, ranked results, and highlighted snippets. Filter by frontmatter metadata, tags, or specific vaults. Paginated results handle large document collections efficiently. Semantic search via AI embeddings finds conceptually related content.
Key Features
REST API
OpenAPI 3.0 documented, Bearer token + API key auth
TypeScript SDK
Type-safe client library built on ky
CLI Tool
Push, pull, search, and manage from the terminal
Webhooks
Event notifications with HMAC verification
Scoped API Keys
Granular permissions per vault and operation
Full-Text Search
PostgreSQL-powered search across all documents
HMAC Signing
Cryptographic request signing for secure write operations
Version Control
Diff, restore, and pin versions programmatically via API
Start building today
Create your free account and see how Lifestream Vault fits your workflow.