Apiboo documentation

DocsAccount & help

Troubleshooting & FAQ

Answers to common problems and questions, and how to report an issue.

Something not working as you expected? Find the symptom below. If your problem isn't here, report it from the app (see Report an issue); every report is read.

Sync

When sync needs your attention, a cloud icon appears in the title bar. Click it to see which part is affected.

The Sync trouble panel open under the cloud icon, listing Personal sync (notes & boards) as Offline
You seeWhat it meansWhat to do
Offline — reconnecting… in the title barApiboo can't reach its servers. You're still signed in.Nothing. Your changes wait on this device and go out when the connection is back.
Offline under a scopeThat scope can't sync right now.Check your connection. It retries on its own.
Needs re-authenticationYour session for that scope has ended.Sign in again. Prefer Switch account over Sign Out, which removes local data (see My boards or documents are gone after signing out).
"Your clock looks off by about N minutes"Your computer's clock is wrong. A wrong clock can make your edits lose to edits from other devices.Correct your system time.
"Cloud sync is available on paid plans"This scope doesn't sync on your plan. Everything is still saved on this device.See plans if you want it synced (see Account & plans).
Your cloud limitsA Free cloud limit is near or reached.Move items to this device, delete some, or upgrade (see See your plan and usage).

Sync scopes are named Personal sync (notes & boards), Team boards, Vault, and your workspaces by name.

My boards or documents are gone after signing out

Sign Out removes this account's data from this computer, except the Vault. Everything in the cloud comes back when you sign in again. Boards and documents that were kept only on this device are removed with it.

To avoid that, move them to the cloud before you sign out (see Boards and documents: cloud or this device), or use Switch account, which keeps everything.

A request fails

  • Request failed with Retry means Apiboo couldn't reach the server: check the URL, that the server is running, and your proxy in Settings → Proxy.
  • A local server with a self-signed certificate: add your CA certificate in Settings → Certificates, or switch on Disable SSL Verification globally there while you develop.
  • The request uses a variable that shows in red: it isn't defined. Click it to add it (see The variable popout).
  • The status is 400 or more: click Explain next to the status to let the AI assistant look at it.
  • Only GET, POST, PUT, PATCH, DELETE, HEAD and OPTIONS can be sent. Another method name fails with "Unsupported HTTP method".
  • A DELETE (or GET) request with a Raw or Form-data body is sent without the body (see Body).

My script doesn't do what I expect

  • "pm.sendRequest is not available in this context": pm.sendRequest works only in a Pre Request script when you send the request yourself, not in post-response scripts or the collection runner (see Call another endpoint: pm.sendRequest).
  • The request wasn't sent: an error in the pre-request script stops the send. The Request not sent notification shows the first line of the error.
  • Nothing from console.log: its output isn't shown in the app. Put the value in a test name or a variable instead.
  • A variable set by a script is gone after a restart: values set with environment.set last for the session only (see Work with variables).
  • A secret variable can't be read: allow scripts to read it (see Secret variables).
  • "Script execution timed out (5000ms)": a script may run for 5 seconds.

Import problems

  • Unrecognized format: Apiboo reads Apiboo, Postman v2, Insomnia v4, OpenAPI 3.x, Swagger 2.0, HAR and Bruno files (see Supported formats).
  • An Insomnia file became several collections: each Insomnia request group becomes its own collection.
  • No auth after an OpenAPI import: security schemes aren't imported. Set the auth on the collection.
  • Postman secrets arrived as normal variables: mark them as secret again.

gRPC: the methods load but Invoke fails

Invoking a method currently asks the server for its definition by reflection, even when you loaded a .proto file. A server without reflection can therefore fail on Invoke (see gRPC).

Updates

When an update is ready, an Update available button appears at the bottom of the rail. You can also check in Settings → General with Check for updates, and choose there how often Apiboo checks by itself.

MessageWhat to do
"Could not check for updates."Check your connection and try again later.
"Could not download or open the update. Please try again."Try again, or download the latest version from apiboo.com/download.
"Installer opened — complete the update, then reopen Apiboo."Finish the installer, then start Apiboo again.

Windows says the installer isn't recognised

A brand-new release can trigger Windows SmartScreen before many people have downloaded it. Apiboo's installers are code-signed; choose More info and then Run anyway.

The app shows "Something went wrong"

Apiboo hit an unexpected error. Click Try again. If it keeps happening, click Copy details and paste them into a report (see Report an issue).

Report an issue

  1. Open Settings → About and click Report an issue. In Help, it's in the footer too.
  2. Pick a Topic: Bug, Feature request, Performance, Billing, Account, Security or Something else.
  3. Add a Subject if you like, and describe What happened?: what you did, what you expected and what happened instead.
  4. Attach screenshots or logs with Add files: up to 5 files, 25 MB each.
  5. Click Send report.

The report includes your app version and operating system, but not your files, requests or credentials. Replies arrive in your notifications. You need to be signed in to send one.

FAQ

Do I need an account? No. Everything except chat, sync, sharing and teams works signed out (see Do you need an account?).

Does Apiboo work offline? Yes. Your data is on your computer. Sync catches up when you're back online.

Where do I change keyboard shortcuts? In Settings → Keyboard. The full list is in Keyboard shortcuts.

How do I move from Postman? Export your collections and environments from Postman and import them (see Import & export). Your pm.* scripts run as they are, with the differences listed in Postman scripts (pm.*).

An AI client says "Connected" but shows no tools. See MCP Server.

Does Apiboo see my requests? Only what you sync or share, or ask the AI assistant about. Requests in a Local workspace otherwise stay on your computer. Anonymous usage data only counts which features are used, and you can switch it off in Settings → General (see Usage data).