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: 
https://api.docketqa.com

​
Authentication

All API requests require an X-API-KEY header. You can find your API key in your Docket account CI/CD tab. 
curl -X GET https://api.docketqa.com/test_blueprint/list \
  -H "X-API-KEY: your-api-key"
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:
TypeValueDescription
Integration"integration"A standard end-to-end test with a sequence of steps.
Account (Module)"module"A login/account module with stored credentials and a starting URL.
Step Module"step_module"A reusable set of steps that can be embedded in other tests. Created via the Modules API.

​
Step types

Steps define the actions your test performs. Each step has a type that determines its behavior:
TypeDescription
"act"AI-driven browser action (click, type, navigate, etc.)
"assert"AI-driven assertion that verifies page state
"step_module"Execute a reusable module inline
"api"Make an HTTP request (GET, POST, PUT, DELETE)
"trigger_run"Trigger another test blueprint as a sub-run
"key"Press a keyboard key (recorded step)
"type"Type text into the focused element (recorded step)
"mouse_move"Move mouse to coordinates (recorded step)
"left_click"Left click at coordinates (recorded step)
"right_click"Right click at coordinates (recorded step)
"double_click"Double click at coordinates (recorded step)
"triple_click"Triple click at coordinates (recorded step)
"left_click_drag"Click and drag (recorded step)
"scroll"Scroll the page (recorded step)
"wait"Wait for a duration (recorded step)
"deeplink"Open a deep link URL (mobile only)

​
Device types

Tests can target different device types:
DeviceValueDescription
Desktop browser"browser"Default. Runs in a remote Chromium browser.
Android"android"Runs on an Android device/emulator.
iOS"ios"Runs on an iOS device/simulator.

​
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 step module

Get Module

Retrieve a specific module by ID

List Modules

List modules with optional filtering

Update Module

Update an existing module