curl --request POST \
--url https://api.qa.tech/v1/rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"content": "<string>",
"applicationShortId": "<string>",
"labelFilter": "<string>",
"scenarioShortIds": [
"<string>"
],
"urlPathFilter": "<string>",
"sortOrder": 123,
"projectShortId": "<string>"
}
'import requests
url = "https://api.qa.tech/v1/rules"
payload = {
"title": "<string>",
"content": "<string>",
"applicationShortId": "<string>",
"labelFilter": "<string>",
"scenarioShortIds": ["<string>"],
"urlPathFilter": "<string>",
"sortOrder": 123,
"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({
title: '<string>',
content: '<string>',
applicationShortId: '<string>',
labelFilter: '<string>',
scenarioShortIds: ['<string>'],
urlPathFilter: '<string>',
sortOrder: 123,
projectShortId: '<string>'
})
};
fetch('https://api.qa.tech/v1/rules', 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/rules",
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([
'title' => '<string>',
'content' => '<string>',
'applicationShortId' => '<string>',
'labelFilter' => '<string>',
'scenarioShortIds' => [
'<string>'
],
'urlPathFilter' => '<string>',
'sortOrder' => 123,
'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/rules"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"labelFilter\": \"<string>\",\n \"scenarioShortIds\": [\n \"<string>\"\n ],\n \"urlPathFilter\": \"<string>\",\n \"sortOrder\": 123,\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/rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"labelFilter\": \"<string>\",\n \"scenarioShortIds\": [\n \"<string>\"\n ],\n \"urlPathFilter\": \"<string>\",\n \"sortOrder\": 123,\n \"projectShortId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qa.tech/v1/rules")
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 \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"labelFilter\": \"<string>\",\n \"scenarioShortIds\": [\n \"<string>\"\n ],\n \"urlPathFilter\": \"<string>\",\n \"sortOrder\": 123,\n \"projectShortId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"rule": {
"id": "<string>",
"title": "<string>",
"content": "<string>",
"applicationShortId": "<string>",
"labelFilter": "<string>",
"scenarioShortIds": [
"<string>"
],
"urlPathFilter": "<string>",
"sortOrder": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}
}Create rule
Create a rule: a standing instruction injected into a QA.tech agent’s context. Agent rules support filters to target specific applications, labels, scenarios or URL paths.
curl --request POST \
--url https://api.qa.tech/v1/rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"content": "<string>",
"applicationShortId": "<string>",
"labelFilter": "<string>",
"scenarioShortIds": [
"<string>"
],
"urlPathFilter": "<string>",
"sortOrder": 123,
"projectShortId": "<string>"
}
'import requests
url = "https://api.qa.tech/v1/rules"
payload = {
"title": "<string>",
"content": "<string>",
"applicationShortId": "<string>",
"labelFilter": "<string>",
"scenarioShortIds": ["<string>"],
"urlPathFilter": "<string>",
"sortOrder": 123,
"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({
title: '<string>',
content: '<string>',
applicationShortId: '<string>',
labelFilter: '<string>',
scenarioShortIds: ['<string>'],
urlPathFilter: '<string>',
sortOrder: 123,
projectShortId: '<string>'
})
};
fetch('https://api.qa.tech/v1/rules', 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/rules",
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([
'title' => '<string>',
'content' => '<string>',
'applicationShortId' => '<string>',
'labelFilter' => '<string>',
'scenarioShortIds' => [
'<string>'
],
'urlPathFilter' => '<string>',
'sortOrder' => 123,
'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/rules"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"labelFilter\": \"<string>\",\n \"scenarioShortIds\": [\n \"<string>\"\n ],\n \"urlPathFilter\": \"<string>\",\n \"sortOrder\": 123,\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/rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"labelFilter\": \"<string>\",\n \"scenarioShortIds\": [\n \"<string>\"\n ],\n \"urlPathFilter\": \"<string>\",\n \"sortOrder\": 123,\n \"projectShortId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qa.tech/v1/rules")
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 \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"applicationShortId\": \"<string>\",\n \"labelFilter\": \"<string>\",\n \"scenarioShortIds\": [\n \"<string>\"\n ],\n \"urlPathFilter\": \"<string>\",\n \"sortOrder\": 123,\n \"projectShortId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"rule": {
"id": "<string>",
"title": "<string>",
"content": "<string>",
"applicationShortId": "<string>",
"labelFilter": "<string>",
"scenarioShortIds": [
"<string>"
],
"urlPathFilter": "<string>",
"sortOrder": 123,
"createdAt": "<string>",
"updatedAt": "<string>"
}
}Body
Which QA.tech agent the rule applies to: chat steers the AI chat assistant, agent steers the test agent during runs, pr_review steers PR review checks.
chat, agent, pr_review 1 - 2001 - 10000Only apply the rule to tests running against this application (agent rules only)
^app(-.+_.+|_.+)$Only apply the rule to test cases carrying this label (agent rules only)
Only apply the rule to test cases in these scenarios (agent rules only)
^scenario(-.+_.+|_.+)$Only apply the rule to tests whose start URL path contains this substring (agent rules only)
Rules are applied in ascending sort order
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.
^proj(-.+_.+|_.+)$Was this page helpful?