Driftstack docs

Reference and guides for integrating with the Driftstack API, using the SDKs, and running the desktop GUI client against cloud or self-hosted control planes. Looking for product info? driftstack.dev has pricing, security, and the rest.

Get started

If you have an API key, start here.

Quickstart

Signup → API key → first session in five minutes. TypeScript, Python, Go.
SDK installation

Install + configure @driftstack/sdk (TS), driftstack-sdk (Python), or sdk-go.
License activation

Activate the desktop GUI client against cloud or self-hosted control planes.

Concept guides

What changes when you start running real workloads.

Profile management

Persistent identities — cookies, storage, stealth state across sessions.
Session lifecycle

States, concurrency caps, idle timeout, error shapes, recovery semantics.
Team RBAC — invite, accept, act-as

End-to-end multi-user team setup: invite + accept flow, X-Driftstack-Account header, owner / admin / member roles, audit-log review.
Live video for agent sessions

Subscribe to the LiveKit room hosting an agent session and render the video. Token mint, connect, input forwarding, reconnect.

Reference

Spec-level depth for the contracts you build against.

API versioning

Additive vs breaking, deprecation cycle, when /v2/* is justified.
Webhook events

Event types, payload shape, signature verification, retry policy.
SDK versioning

How SDKs version independently of the HTTP API contract.
API keys

Mint, list, rotate, revoke. 24h grace period on rotation.
Webhook replay

Replay a single delivery on demand — same idempotency key, fresh attempt.
Team RBAC

Invite, accept, list, remove. Owner / admin / member roles.
Agent sessions

Natural-language decompose-and-execute on top of driver sessions. AI / manual / pair modes; live SSE transcript.
BYOK Anthropic

Bring your own Anthropic API key — encrypted at rest, decrypted in-memory only.
Bundled LLM

Opt-in deployment-managed Anthropic budget for accounts that don't want to manage their own key.
Recipes

Snapshot a finished agent-session into a replayable recipe — intent_log + transcript without re-paying decompose cost. Write-only at v1.0; read / list / execute / delete land at v1.1.
OAuth 2.0

Third-party clients acting on a customer's behalf — Authorization Code with PKCE.
Idempotency keys

Stripe-pattern `Idempotency-Key` header for safe retries on create-style POSTs.
Pagination

Cursor-based pagination across every list endpoint; request + response shape, opaque-cursor semantics, drive-to-completion loops.
Prometheus metrics

Operator-facing GET /metrics catalogue + suggested PromQL alerts.

Looking for something else?

The canonical source for anything not yet rendered here is the repository docs/ tree. The marketing site has product pages at /pricing, /security, and /self-hosted. Email support@driftstack.dev if you need a specific page prioritized.