Apiboo documentation

DocsGetting started

Projects: one switcher for everything

Pick a project in the title bar and API Requests, Boards, Documents, connections and the Graph all show that project.

A project gathers the API workspace, boards, documents and connections that belong together. Pick it once in the title bar and every tool that works on your project shows that project, with no separate switcher per tool.

The project switcher

The project switcher open over Boards: All projects, No project, the personal project Shop with a check mark, New project… and Manage projects…

The switcher sits at the left of the title bar. It lists:

EntryWhat you see
All projectsEverything, as before projects existed
No projectOnly what is in no project yet, so you can sort it in
PersonalYour own projects
One group per teamThat team's projects
New project… / Manage projects…Create one, or open the Projects page

Type to search, use ↑ ↓ and Enter to pick. Apiboo remembers the project per device and opens it again on the next start.

The switcher shows on API Requests, History, Boards, Documents, FTP, DB Manager, Terminal, Graph and Projects. Calendar, Chat, Vault and Settings are not part of a project, so it is hidden there.

What follows the project

ToolUnder a project
API RequestsOpens the project's API workspace. Picking a workspace in the workspace switcher moves to its project too.
BoardsOnly the project's boards. The Personal / team chips are hidden.
DocumentsMain and the project's documentation spaces, see Documentation spaces
FTP / SFTP and TerminalThe project's connections first, under the project's name, then Other connections (collapsible). Nothing is hidden.
DB ManagerThe project's connections first in the tree.
GraphThe project and what it contains. Its own Show project dropdown changes the same project as the title bar.
AI assistantKnows the active project; boards, documents and folders it creates go into it.

Under No project each tool shows what is in no project. Under All projects nothing is filtered.

Running terminal sessions and open database tabs stay open when you switch projects; only the lists change.

Put things into a project

  • Anything you create while a project is picked (a board, a top-level document or folder, an SSH or database connection) goes into that project.
  • From a list: a board's ⋯ menu and a document's right-click menu have Add to project ›, and under a project Remove from the project. Under a project, an FTP / SFTP or Terminal connection's row menu has Add to the project or Remove from the project.
  • From the project page: open Projects, open the project and search. Add from your workspace lists what you can add; Add all adds every listed item at once.

An item can be in several projects. Removing it from a project, or deleting the project, never deletes the item: it moves back to No project.

A team project holds only that team's items, and everyone in the team sees it.

The project's API workspace

A project's page: the Shop project with its API workspace dropdown set to Shop, the search field and its one board

On the project's page, API workspace picks the workspace that API Requests opens for it, or None. A team project can only use a workspace that is shared with that team. Viewers in a team see the workspace but can't change it.

Documentation spaces

The Documents switcher under the Biz project: Main with a check mark, the space Guides, New space… and Manage spaces…

Under a project, the Documents switcher no longer lists Personal or your teams. It lists Main and the project's own documentation spaces, so one project can keep its API docs, runbooks and notes apart.

  • Main holds the project's pages that are in no other space.
  • New space… creates one with a name, an icon and a colour, and opens it.
  • Manage spaces… renames, recolours, reorders (drag) and deletes them. Deleting a space never deletes a page: its pages go back to Main.
  • A page is in one space at a time. Move it with Move to space › in its right-click menu, or drag it onto a space in the switcher. A page inside a folder moves with its folder.
  • A new top-level page or folder lands in the space that is open.

Apiboo remembers the open space per project on this device. Under All projects the Documents sidebar is the same as before.

Git workspaces

A git-backed API workspace writes its project into the repository's apiboo.yaml (its id, name and colour; nothing else). When you or a teammate clone the repository, the new workspace lands in that project, or in a new personal project with the same name and colour if you don't have it. A device where the workspace is in no project keeps the file as it is, so devices don't rewrite each other's file.

AI agents (MCP)

An agent connected over MCP sees which items are in a project through graph_project, which needs the Graph read permission (see The Graph for AI agents). The board and document tools don't take a project filter, so an agent without the Graph permission learns nothing about your projects.