Create test case
curl --request POST \
--url https://api.qa.tech/v1/test-cases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"goal": "<string>",
"applicationShortId": "<string>",
"expectedResult": "<string>",
"resumeFromDependencyProjectTestCaseId": "<string>",
"waitForDependenciesProjectTestCaseIds": [
"<string>"
],
"configShortIds": [
"<string>"
],
"scenarioShortId": "<string>",
"environment": {
"url": "<string>",
"name": "<string>",
"customHeaders": [
{
"domains": [
"<string>"
],
"headers": {}
}
],
"basicAuth": [
{
"domains": [
"<string>"
],
"username": "<string>",
"password": "<string>"
}
]
},
"projectShortId": "<string>"
}
'import requests
url = "https://api.qa.tech/v1/test-cases"
payload = {
"name": "<string>",
"goal": "<string>",
"applicationShortId": "<string>",
"expectedResult": "<string>",
"resumeFromDependencyProjectTestCaseId": "<string>",
"waitForDependenciesProjectTestCaseIds": ["<string>"],
"configShortIds": ["<string>"],
"scenarioShortId": "<string>",
"environment": {
"url": "<string>",
"name": "<string>",
"customHeaders": [
{
"domains": ["<string>"],
"headers": {}
}
],
"basicAuth": [
{
"domains": ["<string>"],
"username": "<string>",
"password": "<string>"
}
]
},
"projectShortId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
goal: '<string>',
applicationShortId: '<string>',
expectedResult: '<string>',
resumeFromDependencyProjectTestCaseId: '<string>',
waitForDependenciesProjectTestCaseIds: ['<string>'],
configShortIds: ['<string>'],
scenarioShortId: '<string>',
environment: {
url: '<string>',
name: '<string>',
customHeaders: [{domains: ['<string>'], headers: {}}],
basicAuth: [{domains: ['<string>'], username: '<string>', password: '<string>'}]
},
projectShortId: '<string>'
})
};
fetch('https://api.qa.tech/v1/test-cases', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qa.tech/v1/test-cases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'goal' => '<string>',
'applicationShortId' => '<string>',
'expectedResult' => '<string>',
'resumeFromDependencyProjectTestCaseId' => '<string>',
'waitForDependenciesProjectTestCaseIds' => [
'<string>'
],
'configShortIds' => [
'<string>'
],
'scenarioShortId' => '<string>',
'environment' => [
'url' => '<string>',
'name' => '<string>',
'customHeaders' => [
[
'domains' => [
'<string>'
],
'headers' => [
]
]
],
'basicAuth' => [
[
'domains' => [
'<string>'
],
'username' => '<string>',
'password' => '<string>'
]
]
],
'projectShortId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.qa.tech/v1/test-cases"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"goal\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"expectedResult\": \"<string>\",\n \"resumeFromDependencyProjectTestCaseId\": \"<string>\",\n \"waitForDependenciesProjectTestCaseIds\": [\n \"<string>\"\n ],\n \"configShortIds\": [\n \"<string>\"\n ],\n \"scenarioShortId\": \"<string>\",\n \"environment\": {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"customHeaders\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"headers\": {}\n }\n ],\n \"basicAuth\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n ]\n },\n \"projectShortId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.qa.tech/v1/test-cases")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"goal\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"expectedResult\": \"<string>\",\n \"resumeFromDependencyProjectTestCaseId\": \"<string>\",\n \"waitForDependenciesProjectTestCaseIds\": [\n \"<string>\"\n ],\n \"configShortIds\": [\n \"<string>\"\n ],\n \"scenarioShortId\": \"<string>\",\n \"environment\": {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"customHeaders\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"headers\": {}\n }\n ],\n \"basicAuth\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n ]\n },\n \"projectShortId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qa.tech/v1/test-cases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"goal\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"expectedResult\": \"<string>\",\n \"resumeFromDependencyProjectTestCaseId\": \"<string>\",\n \"waitForDependenciesProjectTestCaseIds\": [\n \"<string>\"\n ],\n \"configShortIds\": [\n \"<string>\"\n ],\n \"scenarioShortId\": \"<string>\",\n \"environment\": {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"customHeaders\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"headers\": {}\n }\n ],\n \"basicAuth\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n ]\n },\n \"projectShortId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"testCase": {
"id": "<string>",
"name": "<string>",
"url": "<string>"
}
}Test Cases
Create test case
Create a test case in the project. It is created in draft and a burn-in run starts automatically against the application’s default environment, or against environment when given (e.g. a preview deployment or remote tunnel URL).
IMPORTANT: gather context first, or the test will be flaky. This tool records the test exactly as you describe it. It does NOT explore the site to confirm the flow exists, so a vague or unverified goal produces low-value, flaky tests. Before calling, make sure you have:
- Verified the functionality, pages, and UI labels actually exist in the target environment. Do not guess or assume.
- A
goaldescribing a single concrete user flow in plain UI terms, using generic data rather than specific entity names. Specific entities change over time and cause flakiness. - An
expectedResultstating a UI-observable outcome a user can see on screen. - Prerequisites in place: a login/auth dependency via
resumeFromDependencyProjectTestCaseIdwhen the flow needs authentication, plus the rightconfigShortIds. - Checked existing tests with
list_test_casesto avoid duplicates.
If you have not gathered this context, prefer create_chat instead. The QA.tech chat agent crawls the site, grounds the test in what actually exists, sets up login and config dependencies, and verifies the test runs. That is how reliable tests get created. Use this tool directly only when you already know the flow exists and have the details above.
POST
/
v1
/
test-cases
Create test case
curl --request POST \
--url https://api.qa.tech/v1/test-cases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"goal": "<string>",
"applicationShortId": "<string>",
"expectedResult": "<string>",
"resumeFromDependencyProjectTestCaseId": "<string>",
"waitForDependenciesProjectTestCaseIds": [
"<string>"
],
"configShortIds": [
"<string>"
],
"scenarioShortId": "<string>",
"environment": {
"url": "<string>",
"name": "<string>",
"customHeaders": [
{
"domains": [
"<string>"
],
"headers": {}
}
],
"basicAuth": [
{
"domains": [
"<string>"
],
"username": "<string>",
"password": "<string>"
}
]
},
"projectShortId": "<string>"
}
'import requests
url = "https://api.qa.tech/v1/test-cases"
payload = {
"name": "<string>",
"goal": "<string>",
"applicationShortId": "<string>",
"expectedResult": "<string>",
"resumeFromDependencyProjectTestCaseId": "<string>",
"waitForDependenciesProjectTestCaseIds": ["<string>"],
"configShortIds": ["<string>"],
"scenarioShortId": "<string>",
"environment": {
"url": "<string>",
"name": "<string>",
"customHeaders": [
{
"domains": ["<string>"],
"headers": {}
}
],
"basicAuth": [
{
"domains": ["<string>"],
"username": "<string>",
"password": "<string>"
}
]
},
"projectShortId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
goal: '<string>',
applicationShortId: '<string>',
expectedResult: '<string>',
resumeFromDependencyProjectTestCaseId: '<string>',
waitForDependenciesProjectTestCaseIds: ['<string>'],
configShortIds: ['<string>'],
scenarioShortId: '<string>',
environment: {
url: '<string>',
name: '<string>',
customHeaders: [{domains: ['<string>'], headers: {}}],
basicAuth: [{domains: ['<string>'], username: '<string>', password: '<string>'}]
},
projectShortId: '<string>'
})
};
fetch('https://api.qa.tech/v1/test-cases', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qa.tech/v1/test-cases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'goal' => '<string>',
'applicationShortId' => '<string>',
'expectedResult' => '<string>',
'resumeFromDependencyProjectTestCaseId' => '<string>',
'waitForDependenciesProjectTestCaseIds' => [
'<string>'
],
'configShortIds' => [
'<string>'
],
'scenarioShortId' => '<string>',
'environment' => [
'url' => '<string>',
'name' => '<string>',
'customHeaders' => [
[
'domains' => [
'<string>'
],
'headers' => [
]
]
],
'basicAuth' => [
[
'domains' => [
'<string>'
],
'username' => '<string>',
'password' => '<string>'
]
]
],
'projectShortId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.qa.tech/v1/test-cases"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"goal\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"expectedResult\": \"<string>\",\n \"resumeFromDependencyProjectTestCaseId\": \"<string>\",\n \"waitForDependenciesProjectTestCaseIds\": [\n \"<string>\"\n ],\n \"configShortIds\": [\n \"<string>\"\n ],\n \"scenarioShortId\": \"<string>\",\n \"environment\": {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"customHeaders\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"headers\": {}\n }\n ],\n \"basicAuth\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n ]\n },\n \"projectShortId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.qa.tech/v1/test-cases")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"goal\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"expectedResult\": \"<string>\",\n \"resumeFromDependencyProjectTestCaseId\": \"<string>\",\n \"waitForDependenciesProjectTestCaseIds\": [\n \"<string>\"\n ],\n \"configShortIds\": [\n \"<string>\"\n ],\n \"scenarioShortId\": \"<string>\",\n \"environment\": {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"customHeaders\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"headers\": {}\n }\n ],\n \"basicAuth\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n ]\n },\n \"projectShortId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qa.tech/v1/test-cases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"goal\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"expectedResult\": \"<string>\",\n \"resumeFromDependencyProjectTestCaseId\": \"<string>\",\n \"waitForDependenciesProjectTestCaseIds\": [\n \"<string>\"\n ],\n \"configShortIds\": [\n \"<string>\"\n ],\n \"scenarioShortId\": \"<string>\",\n \"environment\": {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"customHeaders\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"headers\": {}\n }\n ],\n \"basicAuth\": [\n {\n \"domains\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n ]\n },\n \"projectShortId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"testCase": {
"id": "<string>",
"name": "<string>",
"url": "<string>"
}
}Body
application/json
Request body for creating a new test case linked to a project
Minimum string length:
1Pattern:
^app(-.+_.+|_.+)$Pattern:
^cfg(-.+_.+|_.+)$Pattern:
^scenario(-.+_.+|_.+)$Environment of applicationShortId to run the initial burn-in against (e.g. a preview URL or remote tunnel URL). Omit to use the application's default environment. Optional customHeaders and basicAuth persist auth or protection-bypass rules on the environment.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.
Pattern:
^proj(-.+_.+|_.+)$Was this page helpful?