Skip to content

API testing

Describe the requests to send and the responses you expect. We send each request to your API base URL and show the status code and body we received next to what you expected.

Base URL

Choose API when you create the project and enter the API base URL. To change it later, set Backend URL in the project's Settings. You can also set it when you import endpoints. API tasks do not start without it.

Import endpoints

Open API Endpoints in your project and click Import new. Choose Postman, OpenAPI / Swagger, Insomnia, cURL commands or manual entry. Upload the file or enter its URL, check the API base URL, review the endpoints we found and click Complete import.

Endpoints are grouped into modules, and the agent reads their parameters and schemas before it sends requests. If you imported from a URL, Re-sync spec fetches it again.

  • OpenAPI / Swagger
  • Postman
  • Insomnia
  • cURL

Write the task

Select endpoints on API Endpoints and click Use in task, or choose API task in the message box. List the requests and the responses you expect:

Task
Create an order with POST /orders for product 42 with quantity 2. Read it back with GET /orders/{id} and check the total is twice the product price. Then send the same POST without quantity and expect a 400 with a validation error.

Put auth tokens or API keys in the task, or ask the agent to remember them in project memory.

Contract checks

With an OpenAPI spec, the agent can generate requests from it and check status codes, content types and response schemas.

Results

The report shows each request, the status and body we received, and whether they matched. A wrong status or body is filed as a bug with the request that reproduces it. API tasks have no browser recording.