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 three different types of identifiers. Make sure you use the correct one:
ID TypeFormatWhere You See ItUse In APIExample
Project UUID36-character UUIDCode examples, GitHub Actions settingsPath parameter: /api/projects/{projectUuid}/runs550e8400-e29b-41d4-a716-446655440000
Short ID6-character alphanumericBrowser URLs, test result pagesRequest body: "testPlanShortId": "abc123"abc123
API TokenUUID stringAPI settings pageHeader: Authorization: Bearer {token}32fc11c3-9be4-4bb9-a220-7a4ca4427335

​
Next Steps

​
Base URL

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