Beta. The Device SDK 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. Agents that act for one signed in Dopl user can use the hosted MCP server instead.
Your company is an organization in Dopl, and each product you build is a project inside it. A project holds everything the API touches: its keys, its context profiles, its end users, their devices and connections, and the event log.
Environments
Every project has a test and a live environment with separate keys and data. A test key can never read or write live data, simulated devices exist only in test, and you switch to real devices by changing the key.
API keys
| Key | Where it is used | What it can do |
|---|---|---|
sk_test_… and sk_live_… | Your server only | Every route its scopes allow |
pk_… | Your web or mobile app | Only create Connect sessions |
Send a key as Authorization: Bearer <key>. Dopl stores only a hash of each key, so a key is shown once when it is created, and rotating a key keeps the old one working for an overlap window, 24 hours by default, so you can deploy without downtime. While the developer portal is being built, Dopl issues and rotates your project's keys for you.
Scopes
Each key carries coarse scopes, and a call outside them fails with insufficient_scope.
| Scope | Routes |
|---|---|
connect | Create a Connect session, exchange a public token, list and revoke connections |
devices:read | Get context |
actions:write | Deliver, run a device action and get an action |
analytics:read | Reserved for the analytics API |
Request IDs
Every response carries a Request-Id header. It is the ID of the event Dopl recorded for that call, so quote it when you contact support.
Versions
The API is versioned by date, and each project is pinned to one version, currently 2026-10-27, so a change on our side never breaks your integration silently. The SDKs follow semantic versioning.