Getting started

Requestarium is a desktop API client for teams of any size. This guide takes you from install to your first shared request in about five minutes.

1. Install the app

Download the build for your platform from the download section and install it like any other desktop app.

2. Sign in

Sign in with Google, GitHub, LinkedIn, or Facebook, or create an account with your email and a password. Email sign-ups get a 6-digit code to confirm the address. You can turn on two-factor authentication later in Settings → Security; see Account & security.

3. Create a collection

Open Collections and create your first collection, or click Import OpenAPI to generate one from an existing spec. Collections hold folders and requests; folders can define shared auth, variables, and scripts for everything inside them.

4. Send your first request

1. Add a request to the collection.
2. Pick a protocol or method — HTTP, GraphQL, gRPC, or WebSocket.
3. Enter the URL, for example https://httpbin.org/get.
4. Click Send. The response panel shows status, duration, headers, and body.
5. Click Save to keep the request in the collection.

5. Add an environment

Environments let the same request run against Local, Staging, and Production.

1. Open the environment selector in the Collections header and create an environment, for example Local.
2. Add a variable host with the value http://127.0.0.1:8080.
3. Change the request URL to {{host}}/healthz and send it again.

See Environments for groups and variable resolution.

6. Work with your team

Requests in a personal workspace stay private. Move a collection to a team workspace to share it, together with its environments, with your teammates. The Free plan includes up to 3 people, 3 collections with up to 30 requests each, 3 environments, and 7 days of run history; see pricing for larger teams. Running requests is never limited.

7. Run from a terminal, CI, or an AI agent

The same collections run from the command line with the Requestarium CLI (Node.js 20.10 or later):

npm install -g @requestarium/cli
requestarium login
requestarium run-collection "Users API" --env Local --bail

requestarium mcp starts an MCP server, so Claude Code, Cursor, or VS Code Copilot Chat can list, edit, and run your collections. See CLI & MCP and the CLI reference.

Next steps

• Collections — every tab for each protocol.
• Scripts — pre-request and post-response automation.
• Import & export — bring existing APIs in and take them out.
• Editors & IDEs — your collections in VS Code and JetBrains IDEs.
• CLI & MCP — run collections in CI and let AI agents use them.