Send chat message
curl --request POST \
--url https://api.qa.tech/v1/chat/{chatConversationShortId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"applicationOverrides": [
{
"applicationShortId": "<string>",
"environment": {
"url": "<string>",
"name": "<string>",
"customHeaders": [
{
"domains": [
"<string>"
],
"headers": {}
}
],
"basicAuth": [
{
"domains": [
"<string>"
],
"username": "<string>",
"password": "<string>"
}
]
},
"devicePresetShortId": "<string>",
"issueReporters": {
"accessibility": {
"enabled": true,
"tags": [
"<string>"
],
"disabledRules": [
"<string>"
],
"includeIncomplete": true,
"iframes": true
}
}
}
],
"projectShortId": "<string>"
}
'import requests
url = "https://api.qa.tech/v1/chat/{chatConversationShortId}"
payload = {
"message": "<string>",
"applicationOverrides": [
{
"applicationShortId": "<string>",
"environment": {
"url": "<string>",
"name": "<string>",
"customHeaders": [
{
"domains": ["<string>"],
"headers": {}
}
],
"basicAuth": [
{
"domains": ["<string>"],
"username": "<string>",
"password": "<string>"
}
]
},
"devicePresetShortId": "<string>",
"issueReporters": { "accessibility": {
"enabled": True,
"tags": ["<string>"],
"disabledRules": ["<string>"],
"includeIncomplete": True,
"iframes": True
} }
}
],
"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({
message: '<string>',
applicationOverrides: [
{
applicationShortId: '<string>',
environment: {
url: '<string>',
name: '<string>',
customHeaders: [{domains: ['<string>'], headers: {}}],
basicAuth: [{domains: ['<string>'], username: '<string>', password: '<string>'}]
},
devicePresetShortId: '<string>',
issueReporters: {
accessibility: {
enabled: true,
tags: ['<string>'],
disabledRules: ['<string>'],
includeIncomplete: true,
iframes: true
}
}
}
],
projectShortId: '<string>'
})
};
fetch('https://api.qa.tech/v1/chat/{chatConversationShortId}', 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/chat/{chatConversationShortId}",
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([
'message' => '<string>',
'applicationOverrides' => [
[
'applicationShortId' => '<string>',
'environment' => [
'url' => '<string>',
'name' => '<string>',
'customHeaders' => [
[
'domains' => [
'<string>'
],
'headers' => [
]
]
],
'basicAuth' => [
[
'domains' => [
'<string>'
],
'username' => '<string>',
'password' => '<string>'
]
]
],
'devicePresetShortId' => '<string>',
'issueReporters' => [
'accessibility' => [
'enabled' => true,
'tags' => [
'<string>'
],
'disabledRules' => [
'<string>'
],
'includeIncomplete' => true,
'iframes' => true
]
]
]
],
'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/chat/{chatConversationShortId}"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"applicationOverrides\": [\n {\n \"applicationShortId\": \"<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 \"devicePresetShortId\": \"<string>\",\n \"issueReporters\": {\n \"accessibility\": {\n \"enabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"disabledRules\": [\n \"<string>\"\n ],\n \"includeIncomplete\": true,\n \"iframes\": true\n }\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/chat/{chatConversationShortId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"applicationOverrides\": [\n {\n \"applicationShortId\": \"<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 \"devicePresetShortId\": \"<string>\",\n \"issueReporters\": {\n \"accessibility\": {\n \"enabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"disabledRules\": [\n \"<string>\"\n ],\n \"includeIncomplete\": true,\n \"iframes\": true\n }\n }\n }\n ],\n \"projectShortId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qa.tech/v1/chat/{chatConversationShortId}")
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 \"message\": \"<string>\",\n \"applicationOverrides\": [\n {\n \"applicationShortId\": \"<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 \"devicePresetShortId\": \"<string>\",\n \"issueReporters\": {\n \"accessibility\": {\n \"enabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"disabledRules\": [\n \"<string>\"\n ],\n \"includeIncomplete\": true,\n \"iframes\": true\n }\n }\n }\n ],\n \"projectShortId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"shortId": "<string>",
"url": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "in_progress",
"runs": [
{
"shortId": "<string>",
"status": "<string>",
"result": "<string>",
"url": "<string>"
}
],
"title": "<string>",
"source": "api",
"messages": [
{
"id": "<string>",
"role": "user",
"createdAt": "2023-11-07T05:31:56Z",
"text": "<string>",
"status": "INITIATED",
"isStreaming": true
}
]
}Chat
Send chat message
Send a chat message to an existing conversation.
Returns 202 immediately. Poll get_chat_conversation until conversation status
is completed, failed, or cancelled. Assistant message COMPLETED is not
enough while a test run is still in progress. Wait at least 1s between polls.
POST
/
v1
/
chat
/
{chatConversationShortId}
Send chat message
curl --request POST \
--url https://api.qa.tech/v1/chat/{chatConversationShortId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"applicationOverrides": [
{
"applicationShortId": "<string>",
"environment": {
"url": "<string>",
"name": "<string>",
"customHeaders": [
{
"domains": [
"<string>"
],
"headers": {}
}
],
"basicAuth": [
{
"domains": [
"<string>"
],
"username": "<string>",
"password": "<string>"
}
]
},
"devicePresetShortId": "<string>",
"issueReporters": {
"accessibility": {
"enabled": true,
"tags": [
"<string>"
],
"disabledRules": [
"<string>"
],
"includeIncomplete": true,
"iframes": true
}
}
}
],
"projectShortId": "<string>"
}
'import requests
url = "https://api.qa.tech/v1/chat/{chatConversationShortId}"
payload = {
"message": "<string>",
"applicationOverrides": [
{
"applicationShortId": "<string>",
"environment": {
"url": "<string>",
"name": "<string>",
"customHeaders": [
{
"domains": ["<string>"],
"headers": {}
}
],
"basicAuth": [
{
"domains": ["<string>"],
"username": "<string>",
"password": "<string>"
}
]
},
"devicePresetShortId": "<string>",
"issueReporters": { "accessibility": {
"enabled": True,
"tags": ["<string>"],
"disabledRules": ["<string>"],
"includeIncomplete": True,
"iframes": True
} }
}
],
"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({
message: '<string>',
applicationOverrides: [
{
applicationShortId: '<string>',
environment: {
url: '<string>',
name: '<string>',
customHeaders: [{domains: ['<string>'], headers: {}}],
basicAuth: [{domains: ['<string>'], username: '<string>', password: '<string>'}]
},
devicePresetShortId: '<string>',
issueReporters: {
accessibility: {
enabled: true,
tags: ['<string>'],
disabledRules: ['<string>'],
includeIncomplete: true,
iframes: true
}
}
}
],
projectShortId: '<string>'
})
};
fetch('https://api.qa.tech/v1/chat/{chatConversationShortId}', 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/chat/{chatConversationShortId}",
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([
'message' => '<string>',
'applicationOverrides' => [
[
'applicationShortId' => '<string>',
'environment' => [
'url' => '<string>',
'name' => '<string>',
'customHeaders' => [
[
'domains' => [
'<string>'
],
'headers' => [
]
]
],
'basicAuth' => [
[
'domains' => [
'<string>'
],
'username' => '<string>',
'password' => '<string>'
]
]
],
'devicePresetShortId' => '<string>',
'issueReporters' => [
'accessibility' => [
'enabled' => true,
'tags' => [
'<string>'
],
'disabledRules' => [
'<string>'
],
'includeIncomplete' => true,
'iframes' => true
]
]
]
],
'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/chat/{chatConversationShortId}"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"applicationOverrides\": [\n {\n \"applicationShortId\": \"<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 \"devicePresetShortId\": \"<string>\",\n \"issueReporters\": {\n \"accessibility\": {\n \"enabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"disabledRules\": [\n \"<string>\"\n ],\n \"includeIncomplete\": true,\n \"iframes\": true\n }\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/chat/{chatConversationShortId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"applicationOverrides\": [\n {\n \"applicationShortId\": \"<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 \"devicePresetShortId\": \"<string>\",\n \"issueReporters\": {\n \"accessibility\": {\n \"enabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"disabledRules\": [\n \"<string>\"\n ],\n \"includeIncomplete\": true,\n \"iframes\": true\n }\n }\n }\n ],\n \"projectShortId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qa.tech/v1/chat/{chatConversationShortId}")
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 \"message\": \"<string>\",\n \"applicationOverrides\": [\n {\n \"applicationShortId\": \"<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 \"devicePresetShortId\": \"<string>\",\n \"issueReporters\": {\n \"accessibility\": {\n \"enabled\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"disabledRules\": [\n \"<string>\"\n ],\n \"includeIncomplete\": true,\n \"iframes\": true\n }\n }\n }\n ],\n \"projectShortId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"shortId": "<string>",
"url": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "in_progress",
"runs": [
{
"shortId": "<string>",
"status": "<string>",
"result": "<string>",
"url": "<string>"
}
],
"title": "<string>",
"source": "api",
"messages": [
{
"id": "<string>",
"role": "user",
"createdAt": "2023-11-07T05:31:56Z",
"text": "<string>",
"status": "INITIATED",
"isStreaming": true
}
]
}Path Parameters
Pattern:
^chat(-.+_.+|_.+)$Body
application/json
Request body for sending a chat message
The message text to send. Example: 'Generate a login flow test for staging'.
Minimum string length:
1Optional per-application environment overrides. Optional customHeaders and basicAuth on environment persist auth or protection-bypass rules.
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(-.+_.+|_.+)$Response
202 - application/json
The request has been accepted for processing, but processing has not yet completed.
Conversation data with recent messages (newest first).
Pattern:
^chat(-.+_.+|_.+)$Dashboard URL for the conversation.
Overall conversation lifecycle. in_progress while the assistant is working or a background test run / research task is still going. Assistant message COMPLETED is not enough — starting a run ends the current turn. Poll until this is completed, failed, or cancelled.
Available options:
in_progress, completed, failed, cancelled Test runs started from this conversation, newest first. Empty until a run is created. Use shortId with get_run (testCases = all) or nested test-case short IDs from that call with get_run_test_case.
Show child attributes
Show child attributes
Where the conversation originated. api for conversations created via this API, ui for the dashboard, github/gitlab for VCS-triggered chats, and system for everything else.
Available options:
api, ui, github, gitlab, system Recent messages, newest first. Empty on creation; poll get_chat_conversation to retrieve. Internal wake messages are omitted.
Show child attributes
Show child attributes
Was this page helpful?