curl --request POST \
--url https://api.qa.tech/v1/chat/change-review/prepare \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prUrl": "<string>",
"context": "<string>",
"forceNewConversation": false,
"triage": {
"enabled": true,
"prompt": "<string>"
},
"disableReviewComments": true,
"actor": "<string>",
"branch": "<string>",
"commitHash": "<string>",
"commitMessage": "<string>",
"repository": "<string>",
"projectShortId": "<string>"
}
'import requests
url = "https://api.qa.tech/v1/chat/change-review/prepare"
payload = {
"prUrl": "<string>",
"context": "<string>",
"forceNewConversation": False,
"triage": {
"enabled": True,
"prompt": "<string>"
},
"disableReviewComments": True,
"actor": "<string>",
"branch": "<string>",
"commitHash": "<string>",
"commitMessage": "<string>",
"repository": "<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({
prUrl: '<string>',
context: '<string>',
forceNewConversation: false,
triage: {enabled: true, prompt: '<string>'},
disableReviewComments: true,
actor: '<string>',
branch: '<string>',
commitHash: '<string>',
commitMessage: '<string>',
repository: '<string>',
projectShortId: '<string>'
})
};
fetch('https://api.qa.tech/v1/chat/change-review/prepare', 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/change-review/prepare",
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([
'prUrl' => '<string>',
'context' => '<string>',
'forceNewConversation' => false,
'triage' => [
'enabled' => true,
'prompt' => '<string>'
],
'disableReviewComments' => true,
'actor' => '<string>',
'branch' => '<string>',
'commitHash' => '<string>',
'commitMessage' => '<string>',
'repository' => '<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/chat/change-review/prepare"
payload := strings.NewReader("{\n \"prUrl\": \"<string>\",\n \"context\": \"<string>\",\n \"forceNewConversation\": false,\n \"triage\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"disableReviewComments\": true,\n \"actor\": \"<string>\",\n \"branch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitMessage\": \"<string>\",\n \"repository\": \"<string>\",\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/change-review/prepare")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prUrl\": \"<string>\",\n \"context\": \"<string>\",\n \"forceNewConversation\": false,\n \"triage\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"disableReviewComments\": true,\n \"actor\": \"<string>\",\n \"branch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitMessage\": \"<string>\",\n \"repository\": \"<string>\",\n \"projectShortId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qa.tech/v1/chat/change-review/prepare")
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 \"prUrl\": \"<string>\",\n \"context\": \"<string>\",\n \"forceNewConversation\": false,\n \"triage\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"disableReviewComments\": true,\n \"actor\": \"<string>\",\n \"branch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitMessage\": \"<string>\",\n \"repository\": \"<string>\",\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
}
]
}Prepare change review
Start a GitHub pull request’s change review before its preview is deployed. Call it when the PR opens or gets a new commit. Returns 202 with the review conversation, reused the same way as POST /chat/change-review.
The agent reads the change and creates the tests it plans to run, without running them. Once the preview is deployed, send POST /chat/change-review with applicationOverrides for the same head commit: QA.tech treats it as the deployment being ready, and the waiting review runs its tests there.
Send commitHash from CI (pull_request.head.sha) on every prepare call so a new push is triaged and prepared for that commit, not a stale head still in the database. A new commit always gets a fresh prepare; a repeat call for the same commit does nothing if that commit already has a review round in the conversation.
Poll get_chat_conversation until its status is completed, failed, or cancelled; a prepared conversation completes once the tests are created.
curl --request POST \
--url https://api.qa.tech/v1/chat/change-review/prepare \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prUrl": "<string>",
"context": "<string>",
"forceNewConversation": false,
"triage": {
"enabled": true,
"prompt": "<string>"
},
"disableReviewComments": true,
"actor": "<string>",
"branch": "<string>",
"commitHash": "<string>",
"commitMessage": "<string>",
"repository": "<string>",
"projectShortId": "<string>"
}
'import requests
url = "https://api.qa.tech/v1/chat/change-review/prepare"
payload = {
"prUrl": "<string>",
"context": "<string>",
"forceNewConversation": False,
"triage": {
"enabled": True,
"prompt": "<string>"
},
"disableReviewComments": True,
"actor": "<string>",
"branch": "<string>",
"commitHash": "<string>",
"commitMessage": "<string>",
"repository": "<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({
prUrl: '<string>',
context: '<string>',
forceNewConversation: false,
triage: {enabled: true, prompt: '<string>'},
disableReviewComments: true,
actor: '<string>',
branch: '<string>',
commitHash: '<string>',
commitMessage: '<string>',
repository: '<string>',
projectShortId: '<string>'
})
};
fetch('https://api.qa.tech/v1/chat/change-review/prepare', 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/change-review/prepare",
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([
'prUrl' => '<string>',
'context' => '<string>',
'forceNewConversation' => false,
'triage' => [
'enabled' => true,
'prompt' => '<string>'
],
'disableReviewComments' => true,
'actor' => '<string>',
'branch' => '<string>',
'commitHash' => '<string>',
'commitMessage' => '<string>',
'repository' => '<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/chat/change-review/prepare"
payload := strings.NewReader("{\n \"prUrl\": \"<string>\",\n \"context\": \"<string>\",\n \"forceNewConversation\": false,\n \"triage\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"disableReviewComments\": true,\n \"actor\": \"<string>\",\n \"branch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitMessage\": \"<string>\",\n \"repository\": \"<string>\",\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/change-review/prepare")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prUrl\": \"<string>\",\n \"context\": \"<string>\",\n \"forceNewConversation\": false,\n \"triage\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"disableReviewComments\": true,\n \"actor\": \"<string>\",\n \"branch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitMessage\": \"<string>\",\n \"repository\": \"<string>\",\n \"projectShortId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qa.tech/v1/chat/change-review/prepare")
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 \"prUrl\": \"<string>\",\n \"context\": \"<string>\",\n \"forceNewConversation\": false,\n \"triage\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"disableReviewComments\": true,\n \"actor\": \"<string>\",\n \"branch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitMessage\": \"<string>\",\n \"repository\": \"<string>\",\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
}
]
}Body
Prepare a change review for a GitHub pull request before its preview is deployed
When true, the agent does not post its review comments to the pull request. The review still runs and is stored in QA.tech, and the GitHub check run is still reported. Use it when you do not want comments on the PR, for example during evaluation. Stored on the review conversation, so later reviews of this PR also stay silent until a request sends false. Omit to keep the conversation's current setting (comments are posted by default).
Response
The request has been accepted for processing, but processing has not yet completed.
Conversation data with recent messages (newest first).
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.
in_progress, completed, failed, cancelled Was this page helpful?