Skip to main content
The Chat API enables programmatic interaction with QA.tech’s AI Chat Assistant. Create conversations, send messages, start change reviews, and poll for responses—all via REST API. This is ideal for integrating QA.tech’s AI capabilities into your automation workflows, project management systems, or custom tooling.

​
When to Use This API

  • Automated test creation – Send context from your system to create tests without opening the QA.tech UI
  • PR/Change reviews – Automatically trigger AI-powered change reviews from CI/CD pipelines
  • Custom integrations – Build buttons or workflows in your project management tools that interact with QA.tech Chat
  • AI-assisted QA workflows – Let your automation systems communicate with QA.tech’s AI assistant
For simpler chat interactions, consider using the CLI chat command which handles polling automatically: qatech chat "Create a login test"

​
Authentication

All endpoints require Bearer token authentication. Create your API key in the QA.tech dashboard: Organization Settings → API Keys. The key is shown only once, at creation. See the API Introduction for details.

​
Endpoints

For full request, response, and error details, see the generated reference pages:

​
How Conversations Work

Chat processing is asynchronous. Creating a conversation or sending a message returns 202 Accepted immediately with an empty messages array — the assistant’s reply is not included. To read the reply, poll Get Chat Conversation until the most recent assistant message reaches the COMPLETED status. We recommend polling every 2-5 seconds.
Assistant responses typically complete within 10-60 seconds depending on the complexity of the request. Test creation and execution may take several minutes.
You can target a specific application environment for the conversation — for example a preview deployment or an uploaded mobile build — by passing application overrides when creating it. See the Start Chat Conversation reference for the override format.

​
Change Reviews

Start Change Review Chat creates a conversation that initiates an AI-powered review of code changes. It supports two modes:
  • PR mode – Provide a pull request URL (GitHub or GitLab) and QA.tech fetches the changes
  • Raw changes mode – Provide a change description and a git diff directly, useful when the changes are not in a hosted PR
Both modes accept optional extra context to help the AI understand the changes, and require application overrides specifying which environment to review against. For GitHub pull requests (mode: "pr", vcsProviderId: "github"), an explicit change-review request also creates or updates the QA.tech / PR Review check on the PR. This applies even when Auto-run on PRs is disabled in the GitHub App integration. See PR Review check on GitHub. PR mode also accepts optional postMerge options (enabled, and optional prompt). When set, they override the GitHub App integration post-merge settings for that PR after it merges. See Post-merge agent.

​
Attributing a Review to a Commit

Both modes accept the same optional git fields as Start Run: branch, commitHash, commitMessage, actor, and repository. Populate them from your CI context so the runs the review starts show the branch and commit in the dashboard, and so list_runs can filter them by branch or commitHash. In PR mode these fields are optional: when they are omitted, QA.tech falls back to the head branch and head commit recorded for the pull request. Send them explicitly when the deployment you are reviewing was built from a different commit.