Apiboo documentation

DocsGetting started

The rail & settings

The tool rail on the left, keyboard basics and where the settings live.

The rail is the column of icons down the side of the window. Every tool in Apiboo has a button there, and the title bar holds the rest: settings, sync, teams and your account. This page explains both, lists every settings page and covers the keyboard basics.

The rail

The rail with every tool shown, the API Client button active and the Chat, Calendar and Help group at the bottom

Click an icon to switch to that tool. Hover over an icon to see its name.

ButtonOpens
API ClientYour requests, folders and collections (the paper-plane icon). See Collections & runner.
HistoryEvery request you sent. See History.
GitYour workspaces, documents and boards in your own git repositories. A dot means changes are waiting. Desktop only. See Git.
DB ManagerDatabase connections and queries. See DB Manager.
FTP / SFTPFiles on your servers. See FTP / SFTP & file editor.
TerminalLocal shells and SSH sessions. See Terminal.
Mail catcherTest emails caught on your machine. See Mail catcher.
ProjectsProjects that group your work. See Projects & Graph.
Task ManagerYour boards. See Boards.
DocumentsNotes, specs and wikis. See Documents.
VaultSecrets and passkeys. See Vault.
GraphHow your items link together. See Projects & Graph.
ChatTeam channels and direct messages. See Chat.
CalendarAppointments. See Calendar.

Chat and Calendar sit together at the bottom of the rail, because you use them alongside whatever else you're doing. Below them is Help & docs, which opens this documentation over any tool (see Help & docs).

Chat and Mail catcher show a badge with the number of unread items. When an update is ready, an Update available button appears at the bottom of the rail as well.

Show and hide tools

You don't have to see every tool. Settings → Appearance → Your tools lists them all with a switch each:

  1. Open Settings (see Open settings) and choose Appearance.
  2. Scroll to Your tools.
  3. Switch off the tools you don't need, or pick a Role preset to reset the list to a role's recommended tools.

A hidden tool stays installed. Its data is untouched, and its keyboard shortcuts and links still open it. At least one tool always stays on the rail. The same choice is offered on the first launch (see Your tools).

The title bar

On the API tools (API Client and History) the left side of the title bar holds the workspace switcher (see Switch workspaces). The right side holds, from left to right:

ItemWhat it does
Environment pickerPicks the active environment for your requests. See Variables & environments.
Mock serverStarts and stops the local mock server. See The local mock server.
Settings (gear)Opens Settings.
Offline labelShows Offline — reconnecting… while Apiboo can't reach its servers. You stay signed in.
Sync statusAppears only when sync needs your attention. See Sync.
TeamsYour teams, with a count badge. See Teams.
NotificationsInvitations and other notices.
AccountYour avatar, first name and plan, for example "Maya · Pro".

The environment picker and the mock server only show on the API tools; other tools can put their own controls there instead.

Open settings

Open Settings in any of these ways:

  • click the gear in the title bar;
  • open the account menu and choose Settings;
  • press Ctrl+K and run the Settings command.

The search box at the top left (Search settings) filters the pages. It finds rows too: typing "proxy", "2FA" or "invoices" takes you to the page that has them.

Settings pages

Settings open on Appearance: Theme, Density & Layout, Effects and Your tools
PageWhat you set there
GeneralLanguage, Time format (12-hour or 24-hour), Restore last session on launch, Check for updates (On launch, Daily or Never), and the current Version with a Check for updates button.
AppearanceColor scheme (System, Light or Dark), Accent color (presets or any hex colour), Density (Compact, Balanced or Spacious), Sidebar position (Left or Right), UI font size, Navigation tooltips, the loading Transition effect, and Your tools.
EditorThe code editor's Font family, Font size, Tab size, Word wrap, Sticky scroll and Auto-format JSON on send, and the Default response view (Pretty, Raw or Preview).
ProxyRoute requests through a proxy server on this device.
NotificationsDesktop notifications and Notification sound for chat, Keep running in the system tray, and Open Apiboo when you sign in to your computer.
ChatShow link previews and Send read receipts.
AI ChatYour AI provider, model and API key. The key is stored in your Vault. See AI assistant.
AccountProfile, password, security and account deletion, and Git providers → Open Git page (Git accounts are signed in on the Git page, see Accounts).
BillingYour plan, subscription, invoices and cloud usage. See Account & plans.
KeyboardEvery shortcut. Click Edit on a row to remap it, or Reset all.
CertificatesClient certificates, custom CA certificates, and Disable SSL Verification globally for servers with self-signed certificates.
MCP serverLets Claude and other MCP clients work with your documents and boards. See MCP Server.
Privacy & DataSend usage data, local encryption, data export and account deletion.
ExtensionsThe installed extensions, each with an on/off switch and its own page with its settings and permissions.
AboutBuild info, the software licence statement, the terms of service, the privacy policy and other resources.

Open Apiboo when you sign in to your computer is on after you install or update. When you sign in to Windows, macOS or Linux, Apiboo starts in the system tray (on a Mac, in the menu bar) without opening its window, so reminders, chat and the MCP server are ready. Opening Apiboo yourself shows the window as usual. You can turn it off here, or in your system's own list (Windows: Task Manager › Startup apps; macOS: System Settings › General › Login Items; Linux: your desktop's startup applications). Apiboo respects that and never turns it back on by itself.

Keyboard basics

Mod below means Ctrl on Windows and Linux and ⌘ on macOS.

ShortcutAction
Mod+KCommand palette
Mod+TNew tab
Mod+EnterSend request
Mod+SSave request
Mod+E or F2Rename
Mod+DDuplicate
Mod+Shift+AToggle the AI panel
Ctrl+` | Toggle DevTools

Most of these can be remapped in Settings → Keyboard; Send request and Save request are fixed. The full list, including the DB Manager and Terminal shortcuts, is in Keyboard shortcuts.