The main interface of Apidog is divided into these key areas:Header: Top navigation with project management and user settings.
Sidebar: Left panel for accessing core features.
Workbench: Central area with directory tree, tabs, and environment selector.
Footer: Bottom bar for status, tools, and community links.
| Feature | Description |
|---|
| Home | Access your personal homepage with teams, projects, and API hub. |
| Project Tabs | Switch between projects. Click the button next to the name to open in a new window. |
| Upgrade/Plan | View your team's current plan. |
| Refresh | Reload project data. Note: This closes all open tabs. |
| Settings | Configure local settings like appearance and proxy. |
| Notifications | Check team activity alerts. |
| Avatar | Manage account settings and access tokens. |
To switch projects, click any project tab in the header.
Use the Sidebar to quickly access frequently used features like APIs and Tests.
Workbench#
The Workbench is the central workspace for managing project elements.Directory Tree#
The directory tree organizes project components hierarchically.| Feature | Description |
|---|
| Branches and Versions | Switch branches or manage versions. Default is main branch. |
| Search and Filter | Search endpoints (not folders or cases). |
| Create New | Add endpoints, requests, schemas, etc. |
| <Project Name> | High-level project view. |
| Endpoints | Organize endpoints and cases in folders. |
| Schemas | Manage schemas in folders. |
| Components | Reusable response components. |
| Admin API | Contains tools for the admin to batch process data |
| Quick Requests | Organizes quick requests made in this project |
To create a new endpoint, click the Create New icon in the directory tree.
Tabs#
Clicking an element opens a tab. Tabs support types like Endpoint, Schema, Request, and Markdown.Browsing Mode: Single-click opens italic tabs that overwrite on new clicks.
Editing Mode: Double-click or edit to make tabs normal (prevents overwriting).
More: Close tabs (all, current, or others).
Use double-click for persistent tabs during multi-element editing.
Environment Selector#
Select environments for testing APIs. Switch between dev, staging, or production to ensure requests use correct settings.Example: Click the environment dropdown in the workbench to change contexts.The footer provides status and utility tools.| Feature | Description |
|---|
| Collapse/Expand | Toggle directory tree visibility. |
| Online | Shows connection status. Offline affects sync. |
| Agent | Select agent for requests (Apidog Web only). |
| Cookies | Manage cookies. |
| Trash | View deleted items (auto-deleted after 30 days). |
| Community | Join Apidog community on Discord, Slack, X, or Email. |
Check Online status to ensure team synchronization.
Next Step
Learn Basic Concepts in Apidog 
