About the Dopl API Beta

The REST API of the Device SDK

Agents reach Dopl today through the hosted MCP server. The Device SDK adds a REST API for your own product and your own users, with a TypeScript SDK and a project MCP server on top of it. It is live for design partners: Dopl issues your project's keys while the developer portal is being built, and @dopl/sdk is available on request.

Base URL

JSON over HTTPS at https://www.usedopl.com/api/v1.

Authentication

Send a project secret key as Authorization: Bearer sk_test_… or sk_live_… from your server. Publishable pk_… keys may only create Connect sessions. Each key carries scopes that decide which routes it can call. See Projects, environments and keys.

Idempotency

Deliver and device actions take an idempotency_key in the body, and optionally the same value in an Idempotency-Key header; when both are sent they must match. A retry with the same key and the same body returns the first response, status included, without acting twice. The same key with a different body fails with idempotency_conflict.

Asynchronous actions

Deliver and device actions answer 202 with a status: queued, delivered, done, failed or needs_confirmation. A question holds the request for up to 200 seconds while the user answers, unless you send Prefer: respond-async, which answers at once. If it is not answered by then, the status is still delivered or queued, and you read the answer later with Get an action, passing the delivery_id or action_id.

Request IDs

Every response carries a Request-Id header, which is the ID of the event Dopl recorded for the call.

Errors

Every error has the same shape, with a stable code and a retryable flag. See Errors.

Versions

The API is versioned by date and each project is pinned to one version. The current version is 2026-10-27.