Skip to main content
API tests start from natural-language instructions. QA.tech’s API agent turns those instructions into HTTP requests and executable validation code, then records the results for review.

​
Create an API Application

1

Open Applications & Envs

Go to Settings → Applications & Envs and click Create Application.
2

Choose API application

Enter an application name and select API application. API applications are intended for REST and HTTP APIs.
3

Add the first environment

Enter an environment name and the API’s HTTPS base URL, such as https://api.staging.example.com. The first environment becomes the application’s default.
4

Create the application

Optionally mark the environment as production or limit its concurrent tests, then click Create Application.
Add more environments when the same tests should run against multiple deployments, such as staging and production. Every API environment URL must use HTTPS and be reachable from the public internet.

​
Configure Authentication and Test Data

Create reusable values under Settings → Configs, then assign them to the test under Settings → Configs.
1

Create a Custom Fields config

Go to Settings → Configs, click Add config, and choose Custom Fields. Give the config a descriptive name such as API credentials.
2

Add the required values

Add one field for each value the agent needs. Use the header name as the key when a value belongs in a request header.
3

Assign the config

Open the API test, select Settings → Configs, and attach the new config.
4

Reference the configured credentials

In the Goal or Steps, write an instruction such as “Authenticate using the configured API credentials.” Do not paste the values into the test instructions.
QA.tech provides Custom Fields values to the sandbox as environment variables. The agent-generated code uses them to construct request headers, paths, or bodies.

​
Write a Focused API Test

Click Add Test Case, choose Create Test Manually, and complete these fields: Click Generate test to create the test and start its first run. QA.tech then opens the test editor, where you can review the run and add optional Steps to make later runs more prescriptive. API tests do not use Start path or Agent Cache. The environment base URL replaces the start path, and every run generates the code needed for the current API behavior. Dependencies currently control execution order for API tests. They do not pass browser state or output data into the API agent.

​
Example Test

After the first run, you can add these optional Steps:
  1. Send POST /orders with a quantity of 2.
  2. Read the order ID from the response.
  3. Send GET /orders/{id} and verify the returned order.
The agent can save response bodies, parse JSON, reuse the returned ID, and run assertions in the sandbox. You do not need to provide shell, JavaScript, or Python code.

​
Write Reliable Instructions

For negative tests, state the expected rejection explicitly. For example: “Calling GET /account with an expired token returns 401 and an error object containing a string message.”

​
Run and Review

The first run starts when you click Generate test. For later changes in the test editor, click Save & Run. While the test runs, the Action Log shows the agent’s named steps. Select a completed step to review:
  • The network icon for request and response details, status codes, headers, bodies, and Copy as cURL
  • The terminal icon for the generated command, standard output, standard error, and exit status
  • The final action for the Passed or Failed verdict and plain-language summary
An API run has no browser stream, screenshots, or video. The captured HTTP exchanges and command output are the test evidence.
Error means the run ended without a test verdict, for example because the sandbox could not start or the agent exhausted its execution budget. Open the result details for the specific cause. An API behavior that does not match the expected result is reported as Failed.