Skip to main content
Ask AI

API Testing Workspace

The API Testing Workspace is a Postman-style environment for inspecting and re-running the API requests captured by your tests. When a run is made up of API tests, TestRelic opens it here instead of the browser Session Workspace, giving you a request-centric layout built for debugging service calls.

When a run opens here​

Runs are routed to the API Testing Workspace automatically when all of their tests are API tests. TestRelic recognizes API tests when they are:

  • Tagged @api.
  • Located under an api/ path.
  • Part of a dedicated API project.
  • Written with the API request fixture.

A run that mixes browser and API tests opens in the standard workspace, with API requests still surfaced per session. For how to author API tests, see API Testing.

Collection tree​

The left rail organizes the run's requests as a navigable collection tree, grouped by test and request. Select any entry to load its full request and response into the inspector. The tree mirrors the structure of your suite, so related calls stay together.

Request / response inspector​

The inspector shows the complete detail of the selected call:

  • Request — method, URL, headers, query parameters, and body.
  • Response — status code, headers, body, timing, and size.
  • Cookies — structured and masked so you can confirm which cookies were set or sent without exposing their secret values.

For a tour of the analytics a captured API call contains, see API Test Reports.

Replay proxy​

The replay proxy lets you re-send a captured request directly from the workspace. Adjust the URL, headers, query parameters, or body and run it again to reproduce a failure or confirm a fix — without leaving TestRelic or wiring up a separate API client. Responses from a replay are shown in the same inspector so you can compare them against the original capture.

Environment-variable vault​

The environment-variable vault stores reusable values — base URLs, tokens, and other secrets — that you can reference when replaying requests. Values held in the vault are masked in the interface and substituted at send time, so you can replay authenticated requests without pasting secrets into each call.

Keep secrets in the vault

Store API tokens and other sensitive values in the environment-variable vault rather than hard-coding them into a replayed request. Vault values are masked in the UI.

Analyze with Ask AI​

Every request and result carries an inline Analyze action that hands the captured call to Ask AI. Use it to get a plain-language explanation of a failing response, a summary of what a request did, or suggested next steps — with the request and response already attached as context.