Docs API Client Cluster Overview

Cluster Overview

Each cluster has an Overview dashboard with a rich description editor, endpoint documentation, and usage statistics.

Overview Dashboard

Select a cluster and click its name (or the OVR tab) to open the Cluster Overview — a rich dashboard for managing your API collection.

Header Badges

The overview header displays key metadata as badges:

  • Visibility — PUBLIC or PRIVATE
  • Sync status — SYNCED or LOCAL
  • Request count — Total API requests in the cluster
  • Folder count — Number of folders
  • Variable count — Defined cluster variables
  • Version — Current sync version number

Description

The Description section is a rich-text editor for documenting your API collection. The toolbar supports:

  • Bold, italic, underline, strikethrough
  • Bullet list, numbered list
  • Headings (H1, H2, H3, Normal text)
  • Links, inline code, horizontal rules

The description also includes a stats sidebar showing HTTP method distribution (visual bar chart), quick actions (e.g., AI Generate, Import File, Export), and method counts.

Documentation

The Documentation section provides two areas:

  • Notes — A rich-text editor for team documentation, API guides, and usage notes
  • Endpoint Reference — An auto-generated reference of every request in the cluster. Each endpoint shows its method, URL, and collapsible detail sections for query parameters, headers, request body, and auth configuration.

Requests

The Requests section gives a flat list view of all requests in the cluster — useful for scanning everything at a glance without navigating the folder tree.

Last updated 12 hours ago