AI assistant
The assistant panel and the tools it can use for you.
The AI assistant is a chat panel inside Apiboo that can do things, not just talk: send a request, build a collection, read a database schema, write a document, plan a board. You decide which actions run on their own and which ask you first.
It is different from the MCP Server: the assistant lives inside Apiboo, while the MCP server lets agents that run elsewhere (Claude Code, Codex, Claude Desktop) reach your data.
Open the assistant
- Press Ctrl+Shift+A (Cmd+Shift+A on macOS). You can change the key in Settings → Keyboard (Toggle AI panel).
- Click Open AI panel in the footer.
- Or run Toggle AI Panel from the command palette.
The AI Assistant panel docks on the right of every view. Drag its edge to make it wider or narrower.
Some places offer to ask it straight away. Explain next to a failed response, Explain failures on test results and Explain this error on a SQL error open the panel with the question filled in; you send it.
Choose the model
Settings → AI Chat → Provider & model:
| Provider | Needs | Notes |
|---|---|---|
| Apiboo | Signing in | The default. No key needed; the model is chosen by Apiboo and included in your plan, with a monthly quota. |
| Anthropic, OpenAI, Google Gemini, OpenRouter | Your own API key | Apiboo calls the provider directly from your computer. Pick the Model, or Custom…. |
Your own keys are stored encrypted in your Vault (Save key, Test key, Replace key, Remove), so the vault must be unlocked to manage them. If you pick a provider without a saved key, the assistant falls back to Apiboo when it can.
With Apiboo selected, the same page shows your Monthly quota ("… of … tokens") and your Requests per minute. When the quota is used up, Apiboo offers the upgrade; you can also switch to your own key.
Write a message
Type in "Ask the AI assistant… (@ or / for context)". Enter sends, Shift+Enter adds a line, and Stop generating stops a reply.
The assistant doesn't look at your screen. It learns about your work through its tools, and through what you point it at: type @ (or click Add context reference) to reference a collection, a request, an environment, a document, a board or a DB connection.
/clearor Clear session empties the conversation.- An empty panel offers starter prompts such as "What collections do I have, and what is in them?" or "Run my collection and explain anything that fails." A click sends them.
- The footer shows how much context the conversation uses, what is sent to the provider, and a model picker for the next turn.
Conversations are kept per workspace on this computer and deleted when you sign out.
What it can do
| Area | For example |
|---|---|
| Requests and collections | Read collections, environments and the current request; send a request; create collections, folders and requests; move and update requests; run a collection; set variables; write tests and pre-request scripts; switch environments; set auth |
| Boards | Read, create, rename and delete boards; add lists and tasks; update tasks and their descriptions |
| Documents | Read, create, rename, open and delete documents and folders; write or append to a document |
| DB Manager | List connections, read the schema, run SQL (the assistant gets the column names and the number of rows, never the rows) |
| Terminal | List your SSH connections and run a command on one of those servers (never on your own machine) |
| FTP | List connections and folders (read only) |
| Import and code | Import OpenAPI, Swagger, Postman, Insomnia, HAR, Bruno or Hoppscotch; generate code in nine languages; create mock examples and stream connections (WebSocket, SSE, gRPC) |
| Git | Read the git status (read only) |
| Web | Search the web through Apiboo's own search server, and fetch a public web page from your computer |
It sees your SSH and FTP connections by name, and a DB connection by name, engine and database name. Passwords and hosts stay in the Vault.
Auto-run and confirmations
Three switches in the panel's header decide how the assistant behaves:
| Switch | On | Off |
|---|---|---|
| Auto-run | Actions run by themselves, one after another | The assistant asks before each action that sends, runs or changes something |
| Interactive mode | Sending a request uses the request builder, in front of you | Requests run in the background |
| Let AI read responses | The assistant may read response bodies | It can't. Off by default. |
With Auto-run off, these ask first: sending a request, running a collection, reading the last response, running SQL, running a terminal command, updating a task or its description, switching the environment, importing a spec, creating a mock example, fetching a web page, and replacing a document's text.
Some actions always ask, even with Auto-run on: changing a request, setting auth, deleting a document and deleting a board.
The card (Run this action?, Overwrite document?, Delete board?, Delete document?) shows the full command, SQL or URL. Click Confirm (or Delete) to go ahead, or Cancel.