Skip to main content
The QA.tech REST API allows you to programmatically control test runs, create test cases, check results, and integrate QA.tech into your CI/CD pipelines and automation workflows.

​
What Can You Do?

  • Start test runs programmatically from CI/CD pipelines or scripts
  • Create test cases via API for importing tests or generating them dynamically
  • Check run status and retrieve test results
  • Create environments for preview deployments or dynamic test environments
  • View metrics and test execution data

​
Quick Start

Here’s a complete example to start a test run: 
curl -X POST https://app.qa.tech/api/projects/YOUR_PROJECT_UUID/runs \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "integrationName": "API",
    "testPlanShortId": "abc123"
  }'
What you need:
  1. API Token - Found in Settings → Integrations → API
  2. Project UUID - Your project’s 36-character UUID (see finding instructions below)
  3. Test Plan Short ID - The 6-character ID from your test plan URL

​
Authentication

All API endpoints require Bearer token authentication. Include your API token in the Authorization header: 
Authorization: Bearer YOUR_API_TOKEN
Where to find your API token:
  1. Navigate to Settings → Integrations → API in your project dashboard
  2. Your API token is displayed on the API integration page
  3. Copy the token and use it in the Authorization header
Your API token is project-specific. Each project has its own token. Keep your token secure and never commit it to version control.

​
Finding Your Project UUID

Your project UUID is required for all API requests. It appears in code examples but is not shown as a separate labeled field in the API integration page.

​
Option 1: From API Integration Page

1

Go to Settings

Navigate to Settings → Integrations in your project
2

Select API Integration

Click on the API integration card
3

Find UUID in Code Examples

Look at the curl code examples on the page. Your project UUID is embedded in the URL path:/api/projects/YOUR-PROJECT-UUID/runsIt’s the long UUID string between /projects/ and /runs (36 characters with dashes)

​
Option 2: From GitHub Actions Integration

If you’re using GitHub Actions integration:
1

Go to GitHub Actions Integration

Navigate to Settings → Integrations → GitHub Actions
2

Copy QATECH_PROJECT_ID

You’ll see a labeled field QATECH_PROJECT_ID with a copy button - this is your project UUID

​
Understanding Different IDs

QA.tech uses multiple types of identifiers. Make sure you use the correct one for each API request: Short IDs vs UUIDs:
  • Short IDs (6-character alphanumeric): Used for Test Plans, Applications, and Environments. Easy to find in the UI.
  • UUIDs (36-character format with dashes): Used for Projects, Device Presets, and internal resources. Required for certain API operations.
ID TypeFormatWhere You See ItUse In APIExample
Project UUID36-character UUIDCode examples, GitHub Actions settingsPath parameter: /api/projects/{projectUuid}/runs550e8400-e29b-41d4-a716-446655440000
Device Preset UUID36-character UUIDSettings -> Device Presets (see finding instructions below)Request body: "devicePresetId": "a1b2c3d4-e5f6-4789-a012-3456789abcde"a1b2c3d4-e5f6-4789-a012-3456789abcde
Test Plan Short ID6-character alphanumericBrowser URLs, test result pagesRequest body: "testPlanShortId": "abc123"abc123
Application Short ID6-character alphanumericSettings -> Applications (Short ID column)Key in applications objectgXeBl2
Environment Short ID6-character alphanumericSettings -> Applications -> [App] -> Environmentsenvironment.short_id fieldaB3xY9

​
Finding Application Short IDs

The Application Short ID is the key you use in the applications object when overriding environments via API.
1

Go to Applications

Navigate to Settings -> Applications in your project
2

Find Short ID Column

The Short ID appears in its own column in the applications table
3

Copy Short ID

Click the three-dot menu (⋮) next to any application and select Copy Short ID

​
Finding Environment Short IDs

The Environment Short ID references an existing environment in API requests (using environment.short_id).
1

Go to Application Settings

Navigate to Settings -> Applications -> [Select Application]
2

Find Environment Short ID

In the Environments section, the Short ID appears above each environment name in monospace font
3

Copy Short ID

Hover to reveal the copy icon, or click the three-dot menu (⋮) and select Copy Short ID

​
Finding Device Preset UUIDs

The Device Preset UUID is used to override device configurations in API requests (using devicePresetId in the applications object).
1

Go to Device Presets

Navigate to Settings -> Device Presets in your project
2

Find Device Preset UUID

Hover over a device preset name to see a tooltip with the UUID, or open browser developer tools (F12) and inspect the preset element to find the UUID in the HTML attributes
3

Copy UUID

Copy the full 36-character UUID (format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
Device Preset UUIDs are 36-character UUIDs, not Short IDs. They look different from Short IDs (which are 6 characters) and Project UUIDs (which are also 36 characters but used in different places). Make sure you’re copying the Device Preset UUID, not the Project UUID.

​
Next Steps

​
Base URL

All API requests are made to: 
https://app.qa.tech/api