Start here
Working in the app
The window, request tabs, the command palette, keyboard shortcuts, zoom and density, light and dark themes, environment colours, the Help panel and tour, and notifications when a run ends.
Finding your way
- The top bar has the open project's name (click it for Home), the search box — Search, run or jump to anything (the command palette) — and, when an environment is chosen, its name.
- The sidebar on the left has the pages: Home (your projects), Test API, Run collection, Compare, History, and Open report — and, at the bottom, Trash (deleted requests, kept 30 days).
- The status bar along the bottom shows whether the engine is ready (and the k6 version), and has Import, Cookies, Certificates and Mock server; on the right, zoom, density, the theme, Help, and the version — click it for About (updates, and where your files are).
Projects
A project is a folder of its own: its saved requests, environments, performance test history, versions and Trash, as plain files. Keep each API — or each client, or each team — in its own project, and keep a project's folder in Git if you like (secret values are never in its files).
Home (top of the sidebar, or the project's name in the top bar) lists your projects, with how many requests and environments each has and, if its folder is in a Git repository, the branch.
| To | Do this |
|---|---|
| Make a project | New project, give it a name, then Create and open. It goes in Documents/APITestCenter Projects/<name> — or Choose… another folder. |
| Use a folder you already have | Open folder… — a project folder from a colleague or a Git repository, or an empty folder |
| Switch project | Click its card. The app reopens on that folder in a second or two. |
| Rename, or take one off the list | ⋯ on its card. Taking it off the list leaves its folder and files where they are. |
My workspace is the folder the app has always used; it's always on the list. Open tabs and the chosen environment are kept per project; theme, zoom and density are the same everywhere. To use a project on more than one computer, keep its folder in OneDrive, Dropbox or Git and Open folder… it on each — see Your work on more than one computer. Projects are a desktop-app feature — with the command line, pick a folder with --data (see CLI and CI).
Settings
Ctrl+, (or the gear at the right of the top bar, or Settings in the command palette) opens every preference in one window:
| Section | What's in it |
|---|---|
| Appearance | Theme (Graphite, Paper, or following your computer), zoom, density, and whether the response goes beside the request or below it |
| Requests | What a new request starts with: timeout, how many redirects to follow, keeping cookies, skipping the TLS certificate check. Saved requests keep their own |
| Network and proxy | No proxy, the computer's proxy variables (HTTPS_PROXY, HTTP_PROXY, NO_PROXY), or a proxy of your own with a user name, password and hosts that go direct; Reach it checks the way out — see below |
| Performance tests | The preset a new performance test starts as: Smoke, Average, Stress, Spike or Soak |
| Running in the background | Desktop app: what closing the window does, Start with Windows, and freeing memory when it's put away — see below |
| AI assistants (MCP) | Ready-to-copy setup for Claude Code, Cursor, VS Code and Claude Desktop — see AI agents (MCP) |
| Command line | atc for terminals and CI: the main commands to copy, --env / --var, exit codes and reports — see CLI and CI |
| Certificates and cookies | Client certificates and trusted CAs; the cookie jar |
| Privacy | Anonymous usage counts — on or off, and exactly what would be sent |
| Data and storage | Where your data folder is, Open folder, kept answers and their size, and the Trash |
| Keyboard shortcuts | Every shortcut (also Ctrl+/) |
| Updates and about | The version, update check, and licenses |
Proxy
Requests go straight to APIs unless a proxy is set. Settings → Network and proxy:
- The computer's (the default) — uses
HTTPS_PROXY/HTTP_PROXYandNO_PROXYif they're set, as curl, git and k6 do; the section shows what's set. - This proxy — an address like
http://proxy.example.com:8080, a user name and password if it asks for one (the password is kept encrypted on this computer, never in the settings file), and the hosts that go direct (.example.com, 10.0.0.5). - None — always direct, even if the computer has proxy variables.
It applies to everything the app sends: Send, collection runs, sign-in (OAuth, SAML), connections, WebSockets and performance tests (k6 gets the same proxy), and to atc on this computer. Requests to this computer (localhost, 127.0.0.1) always go direct. Reach it asks an address for its headers the same way, to check the route.
Request tabs
Each request you open on Test API gets a tab of its own, above the address bar, with its method and name. A tab keeps its request and its last answer, so you can switch between several APIs and come back to each as you left it.
- Opening a saved request opens its tab — or switches to it, if it's open already.
- + at the end of the tabs starts a new request.
- ✕ (or a middle click) closes a tab. If it has changes you haven't saved, the app asks first.
- Right-click a tab (or press the menu key, or Shift+F10, on it) for Close, Close others, Close to the right, Close unchanged (tabs with nothing unsaved), Close all, Duplicate (a copy, not saved) and Copy URL. Closing several asks once if any of them has unsaved changes.
- A dot on a tab means its saved request has changes you haven't saved.
Going to another page and back keeps everything as it was: each tab's answer here, and on Connections the connection, the object and its records, conditions and columns. Open tabs also come back when you restart the app; their answers don't (they're never written to disk) — send again to see them.
The command palette
Press Ctrl+K (⌘K on a Mac) anywhere, or click the search box in the top bar. Type a few letters of what you want — letters can be anywhere in the name, so ord finds Orders API / List orders. Use ↑ and ↓ to move, Enter to run, Esc to close.
| Group | What's in it |
|---|---|
| Go to | Test API, Run collection, Compare, History, Open report |
| Actions | Import requests (Postman, Insomnia, Bruno, OpenAPI, .http, Hurl, HAR). On Test API and Compare also Send request and Run performance test (on Compare: Compare load). |
| Help | Help: what do these words mean?, About APITestCenter — version and updates, Take the 1-minute tour |
| Saved requests | Every saved request, as Collection / Name. Pick one to open it on Test API. |
| Environment | Use no environment, and Use environment: … for each one. The current one is marked current. |
| Theme | Theme: System, Theme: Light, Theme: Dark |
Keyboard shortcuts
On a Mac, use ⌘ where the table says Ctrl.
| Keys | What it does | Where |
|---|---|---|
| Ctrl+K | Open or close the command palette | Anywhere |
| Ctrl+Enter | Send the request once | Test API, Compare |
| Ctrl+Shift+Enter | Run the performance test (on Compare: compare under load) | Test API, Compare |
| Ctrl+S | Save the request | Test API |
| / | Jump to the URL, when you're not typing in a field | Test API, Compare |
| Ctrl+F | Find in the response body (click the body first) | Response panel |
| Esc | Close the palette, a dialog, a menu, or the tour | Anywhere |
| ← / → | Previous / next step | The tour |
Page shortcuts don't work while a dialog is open.
While you customize a report view, more keys work:
| Keys | What it does |
|---|---|
| Ctrl+Z | Undo |
| Ctrl+Shift+Z or Ctrl+Y | Redo |
| Arrow keys | Move the selected widget |
| Shift + arrow keys | Resize the selected widget |
| Enter | Open the widget's settings |
| Delete | Remove the widget |
| Ctrl+D | Duplicate the widget |
Light and dark
The theme button in the status bar moves between System, Light and Dark each time you click it; Theme: in the command palette picks one directly. System follows your computer's setting.
Sizing the panes
On Test API, drag the line between Saved requests and the request to make the panel wider or narrower, and the line between the request and the response to give either more room — side by side, or one above the other (each layout keeps its own). History, Connections and Compare have the same line between their list and the rest. A line can also be moved from the keyboard: Tab to it, then the arrow keys (Shift for bigger steps). Double-click it, or press Enter, to put it back. The sizes are kept on this computer.
Zoom and density
Make everything bigger or smaller with − and + in the status bar, or Ctrl +, Ctrl − and Ctrl 0 (back to 100%) — ⌘ on a Mac. Comfortable and Compact (next to the zoom) change how tall the rows of saved requests and the tabs are. The app remembers both.
Production environments
You decide which environments are production — the app doesn't guess from names. Under Manage environments (the gear next to the environment picker), tick This is production on an environment. While it's in use, a red line runs across the top of the window and its name is red in the top bar, and the app asks before a request that can change data (anything but GET, HEAD and OPTIONS) and before a performance test. Environments that aren't ticked never ask.
The welcome card
When you first open Test API, the right-hand panel shows New here? Start with something safe to test. It uses the practice API built into the app, so nothing real is touched:
| Choice | What it does |
|---|---|
| Try a simple request | Fills in {{practiceApi}}/products with two checks. Press Send. |
| Try a sign-in example | Adds two requests to a Practice collection: Sign in, and My orders, which signs in first and uses the token. See Chaining. |
| Take the 1-minute tour | Starts the tour (below). |
The practice choices are greyed out while the engine is offline.
The card disappears once you send a request. To hide it for good, press ✕ in its corner. To bring it back, open Help and choose Show the getting-started guide on Test API again.
The tour
Take the 1-minute tour points out, one at a time: where the request goes, what to send, trying it once with Send, testing it under load, reading the result, History, and Help. Use Next and Back (or → and ←), Done on the last step, and Skip tour to leave early. Start it from the welcome card, the Help panel, or the command palette.
The Help panel
Click Help in the status bar. The panel has:
- Take the 1-minute tour;
- Show the getting-started guide on Test API again — brings back the welcome card;
- Privacy — opens Settings → Privacy, where anonymous usage counts are turned on or off, with exactly what would be sent. Only the desktop app sends these; see Privacy and your data;
- About APITestCenter — version, updates, your files;
- Guide for this page — the part of this guide about the page you're on;
- a link to this user guide, and to the free lessons;
- the glossary — every word the app uses, in plain language, grouped into Setting up a test, Reading results, and About the app. Type in What does … mean? to search it.
Dialogs have a Guide link at the top, next to the close button: it opens the part of this guide about that dialog, in your browser.
Notifications
When a performance test or a compare ends, the app tells you:
- In the app, a short message appears in the bottom-right corner.
- When the app is not in front, the window or tab title changes — for example to ✓ Performance test finished, or with ✕ when the run failed — until you come back.
- A system notification, if you turned it on with Notify me when done on a running test. Click the notification to bring the app back. Notifications are only shown when you're looking at something else.
While a run is going, the title shows the time left, such as 0:42 left. More: Performance tests.
In the tray
In the desktop app, closing the window while something is running leaves the app in the system tray (the menu bar on macOS), and the work keeps going: a request waiting for its answer, a collection run, a performance test, or a scheduled check that's on. It still notifies when something finishes or fails; click the notification, or the tray icon, to bring the window back. With nothing running, closing the window quits as usual.
The tray icon's menu shows what's running, and has Keep running when the window is closed, Start with Windows, in the tray, and Quit APITestCenter.
Hide to tray in the command palette puts the app there on purpose, with or without anything running — it waits, ready at a click.
Settings → Running in the background:
| When I close the window | What happens |
|---|---|
| Keep running while something's running (the default) | The tray while there's work, quit otherwise. |
| Always keep running in the tray | The window hides; the app waits in the tray. |
| Quit | Whatever is running stops. |
Start with Windows (on macOS, Open at login) opens the app straight into the tray when you sign in, so scheduled checks run without opening it. It's off unless you turn it on — here, in the tray menu, or with Start APITestCenter when I sign in on the installer's last page. Uninstalling turns it off.
A downloaded update installs when the app quits, not when it only goes to the tray.
Freeing memory while it's put away
When the app has been in the tray, or minimized, for a while with nothing running, it rests: it unloads its page and gives that memory back to your computer — typically 100 MB or more after some use, more after big answers or long performance tests. The engine keeps going, so scheduled checks still run and still notify.
Open it again — the tray icon, the taskbar, a notification — and the page loads back where it was, in about a second: the same page, your open tabs with their unsaved edits, and their answers.
It doesn't rest while a request, a collection run or a performance test is running, while a live connection (WebSocket, SSE) is open, or while a dialog is open, since it may hold something you haven't saved. It tries again a minute later.
Settings → Running in the background → Free memory when it's put away: after 2, 10 (the default) or 30 minutes, or never. The tray menu says when it's resting.