Skip to main content
The Docket API lets you integrate Docket into your workflows by creating tests, triggering runs, and managing reusable modules programmatically. Base URL:

​
Authentication

All API requests require an X-API-KEY header. You can find your API key in your Docket account CI/CD tab.
Keep your API key secret. Do not expose it in client-side code or public repositories.

​
Key concepts

​
Blueprint types

Docket organizes tests using blueprint types:

​
Step types

Steps define the actions your test performs. Each step has a type that determines its behavior:

​
Device types

Tests can target different device types: Modules are device-agnostic — a single module can be referenced from a browser test at one viewport and from a mobile test on a phone. The runtime selects the right internal cache per execution config, so each combination of device / viewport / zoom stays sharp on its own.

​
Endpoints

Create Test

Create a new test blueprint with steps

Run Test

Trigger a test run for one or more tests

Get Test Run

Retrieve results for a specific test run

List Tests

List all test blueprints in your account

Create Module

Create a reusable module

Get Module

Retrieve a specific module by ID

List Modules

List modules with optional filtering

Update Module

Update an existing module