Drıftstack docs
Docs

API reference

This page lists every request you can send Driftstack over the web — in API terms, every endpoint. The Driftstack HTTP API surface lives at https://api.driftstack.dev. Every endpoint is versioned under /v1/*; new majors land with explicit deprecation cycles per the policy below.

What's here

The API covers what your program needs to run Driftstack. Your account, API keys, team, billing and orders are managed in the Driftstack dashboard.

  • Sessions — create, navigate, interact, capture, wait, destroy. Session lifecycle + concurrency caps.
  • Agent sessions — AI-driven automation: give a task in plain words, read the outcome. Works alongside regular sessions.
  • Recipes — save a finished agent-session's intent_log as a durable reference (no copy of its transcript). The current API supports create / list / read / delete; it does not expose recipe execution.
  • Profiles — persistent identity slots; create, list, get, patch, clone, delete. Snapshots — capture / list / restore / delete.
  • Account proxies — register your own proxies and VPNs (SOCKS5, OpenVPN, WireGuard); route a session's traffic through one. Passwords encrypted at rest, never echoed.
  • Usage — current-period meter for sessions / api-calls / data transfer with tier caps surfaced.
  • Bundled LLM — month-to-date spend on Driftstack's bundled AI model against the cap set in the dashboard.
  • Account limits — your rate limits and counted limits, the figure enforced now and how much is in use, in one read.
  • Who am I — the account, key, tier and scopes behind an API key.
  • Help — your support conversations with Driftstack: ask a question or report a problem, read the replies, close what is resolved.
  • Status page API — public snapshot, incident feed (REST + SSE), and the 30-day SLA report. No authentication needed.
  • Versioning policy — additive vs breaking changes, deprecation cycle, when /v2/* is justified.
  • Webhook endpoints — register, list, update, delete, and test webhook endpoints; rotate signing secrets with a 24-hour dual-signing grace.
  • Webhook events catalog — every event type Driftstack emits, payload shape, signature verification, retry policy.
  • Replaying deliveries — customer self-service replay for failed and DLQ webhook deliveries.

Building an app that acts for other Driftstack customers? That is OAuth 2.0, which has its own page: OAuth apps.

Practical use

Other reference surfaces

  • OpenAPI spec. Live at https://api.driftstack.dev/openapi.json; rendered via Scalar UI on the API host at /docs/. The spec is the contract for SDK consumers.
  • Authentication. Customer API keys are ds_live_… on every plan, the free trial included, and are created in the dashboard. Every request sends the key in a Bearer header.
  • Rate limits. Per-plan token-bucket policy. Response headers include x-ratelimit-remaining; 429 responses include retry-after. IP-based gates also apply on the unauthenticated status endpoints.