Install

Pick the package for your system, install it, and open ApiWorkbench. The app needs no account and no setup.

New to snaps, .deb files or APKs? Installing apps explains each kind of package.

Which package to use

System	Package
Ubuntu and other Linux with snap	Snap Store
Debian, Ubuntu, Linux Mint	.deb
Any other Linux	Tarball
Windows	Microsoft Store or zip
Android	APK

Linux and Windows packages exist for x64 (Intel and AMD) and arm64 processors. The downloads are on the 1.4.0 release page.

Linux: Snap Store

sudo snap install apiworkbench

The snap is published for amd64 and arm64, and updates itself.

The snap is strictly confined: it can open and save files in your home folder. To use files on USB drives and other removable media, run:

sudo snap connect apiworkbench:removable-media

The snap also installs the command-line runner as apiworkbench.cli. See Command line.

Linux: .deb (Debian, Ubuntu)

1. Download the file for your processor from the release page:

   • apiworkbench_1.4.0_amd64.deb for x64
   • apiworkbench_1.4.0_arm64.deb for arm64

2. Optional: download the matching .sha256 file into the same folder and check the download.

   sha256sum -c apiworkbench_1.4.0_amd64.deb.sha256

   The command prints OK when the file is intact.

3. Install it.

   sudo apt install ./apiworkbench_1.4.0_amd64.deb

   Use _arm64.deb in both commands on an arm64 machine.

The .deb installs the app as apiworkbench and the command-line runner as apiworkbench-cli.

Linux: tarball (other distributions)

The tarball runs from any folder and needs GTK 3 (the libgtk-3-0 package on Debian-based systems).

tar -xzf ApiWorkbench-1.4.0-linux-x64.tar.gz
./ApiWorkbench-1.4.0-linux-x64/apiworkbench

On arm64, use ApiWorkbench-1.4.0-linux-arm64.tar.gz and the ApiWorkbench-1.4.0-linux-arm64 folder.

Fedora, openSUSE and Arch

Release 1.4.0 has no .rpm, Arch package, AppImage or Flatpak. Use the snap or the tarball on these systems.

Windows

Microsoft Store. Open the ApiWorkbench page in the Microsoft Store and select the install button. The Store keeps the app up to date.

Zip download.

1. Download ApiWorkbench-1.4.0-windows-x64.zip (or ApiWorkbench-1.4.0-windows-arm64.zip for an ARM PC) from the release page.

2. Unzip it to a folder you want to keep, for example a folder in your user profile.

3. Run apiworkbench.exe from that folder.

The zip also contains the command-line runner. It has no installer and does not update itself: to update, download the new zip.

Android

1. On your phone or tablet, download ApiWorkbench-1.4.0.apk from the release page.

2. Open the downloaded file. Android asks you to allow installs from the app you used to download it. Allow it, then select Install.

A ApiWorkbench-1.4.0.apk.sha256 file is on the same page if you want to check the download on a computer first.

macOS and iOS

ApiWorkbench runs on macOS and iOS, but release 1.4.0 has no package for them. To use it there, build it from the source code with Flutter on a Mac:

flutter build macos --release

After you install

Open ApiWorkbench. It starts with one empty request tab and an empty Collections panel.

Your work is saved on your device as you go. Files and data says where. Nothing is uploaded or synced. To keep a copy elsewhere, or before you remove the app, export your workspace.

Update

Package	How it updates
Snap	Automatically. Run sudo snap refresh apiworkbench to update now.
Microsoft Store	Through the Store
.deb, tarball, zip, APK	Download and install the new version the same way

The app does not check for updates itself. New versions are listed on the releases page.

Uninstall

Package	Command or action
Snap	sudo snap remove apiworkbench
.deb	sudo apt remove apiworkbench
Tarball, zip	Delete the folder
Microsoft Store, Android	Uninstall it like any other app

Next steps

• Tour of the window
• Send your first request
• Import from Postman