Developer Tools

REST API, TypeScript SDK, CLI, webhooks, and API keys. Everything you need to build on Lifestream Vault.

Complete REST API

Every feature of Lifestream Vault is accessible through the REST API. OpenAPI 3.0 specification with interactive Swagger UI documentation. Bearer token and API key authentication. Consistent error responses with proper HTTP status codes.

api-demo

# Create a document via the API

$ curl -X PUT https://vault.lifestreamdynamics.com/api/v1/vaults/my-vault/documents/hello.md \

-H "Authorization: Bearer lsv_k_abc12345" \

-d '{"content": "# Hello World\n\nMy first document."}'

# Response

{ "path": "hello.md", "title": "Hello World", "status": "created" }

TypeScript SDK

A type-safe client library built on ky. Install via npm, authenticate with your API key, and manage vaults, documents, search, and more. Promise-based interface with full TypeScript definitions for request and response types.

sdk-example.ts

# Install the SDK

$ npm install @lifestreamdynamics/vault-sdk

# Use the client

import { LifestreamVaultClient } from "@lifestreamdynamics/vault-sdk";

const client = new LifestreamVaultClient({ apiKey: "lsv_k_..." });

const doc = await client.documents.get("my-vault", "hello.md");

Command-line interface

The lsvault CLI lets you manage documents from the terminal. Push and pull files, search across vaults, manage API keys, and automate workflows with shell scripts. Built with Commander for a familiar CLI experience.

cli

# Push local files to vault

$ lsvault push ./docs/ --vault my-vault

Uploaded 12 documents (3 new, 9 updated)

# Search from the terminal

$ lsvault search "deployment guide" --vault my-vault

projects/deploy-guide.md (0.95)

Scoped API keys

Create API keys with granular permissions. Restrict access to specific vaults, set read/write/admin scopes, and rotate keys without downtime. Keys use the lsv_k_ prefix and are verified by 8-character prefix lookup for fast authentication.

api-keys

# Create a read-only key for a specific vault

$ curl -X POST .../api-keys -d '{"name":"ci-reader","scopes":["read"],"vaultId":"..."}'

{ "key": "lsv_k_a1b2c3d4...", "prefix": "a1b2c3d4" }

Related Features

CLI Tool

Manage vaults from the command line

TypeScript SDK

Type-safe client library

API Keys

Scoped permissions and vault restrictions

Webhooks

Event-driven HTTP notifications

Documentation

Comprehensive guides and API reference

Ready to get started?

Create your free account and explore every feature — no credit card required.

Start Free Explore the API