Documentation

apikumo is an API client and documentation publishing tool. Build and test your API requests in a familiar workspace, then publish beautiful, interactive docs your users can explore — with a built-in Try-it panel, AI assistant, and MCP endpoint, all from the same collection.

• Compose HTTP requests with params, headers, auth, and body
• Organise requests into collections and folders
• Use environments and variables for different stages (dev, staging, prod)
• Publish any collection as a shareable, versioned API doc site
• Push and pull collections from the terminal with the CLI
• Import from curl, Postman, or OpenAPI

Get your first API request sent in under two minutes:

A collection is the top-level container for your API — a tree of requests and folders. It is also the unit that gets published as a doc site.

• Create — click New collection in the workspace sidebar.
• Folders — right-click a collection or folder and choose New folder to group related requests (e.g. by resource or tag).
• Rename — right-click any collection or folder and choose Rename.
• Delete — right-click → Delete. Deleting a collection also unpublishes its doc site.
• Reorder — drag and drop requests or folders to rearrange them. The published sidebar mirrors this order.

A request defines a single API call. Every field you set here becomes part of the live call and can optionally appear in your published docs.

• Method & URL — choose GET / POST / PUT / PATCH / DELETE from the dropdown and type or paste the endpoint URL.
• Query params — use the Params tab to add key-value pairs; they are appended to the URL automatically.
• Headers — add any request headers under the Headers tab.
• Body — choose from raw (JSON, text, XML), form-urlencoded, form-data, or binary file upload.
• Send — press ⌘ Enter or click Send. Response status, body, and headers appear below.

Environments let you define named variables (like a base URL or API key) and swap them without editing each request individually.

• Create an environment — click Environments in the top toolbar → New environment. Name it (e.g. “Production”).
• Add variables — add key-value pairs such as baseUrl = https://api.example.com.
• Use variables — reference them anywhere in a request with double-braces: {{baseUrl}}/users. Unresolved variables are highlighted in yellow.
• Switch environments — select the active environment from the dropdown in the toolbar. Only the active environment's values are substituted at send time.

Turn requests into repeatable test suites — chain test cases as steps, assert on the response, and run the suite from the app or your CI pipeline.

• Test cases — attach one or more assertions to a request: status code, response time, body (JSONPath or raw match), headers, JSON schema, or a custom script.
• Suites — chain existing test cases into ordered steps. Each step can capture values from its response (body, header, or status) and pass them to later steps as variables.
• Run — click Run in the suite editor to execute interactively, or run the same suite from CI with the CLI.

Dashboard

Every run — from the app, the CLI, or CI — is recorded and rolled up on a dashboard: pass rate, a trend chart over recent runs, the runs themselves, and the tests that look unreliable. Open it workspace-wide from Tests in the sidebar, or per collection to scope it to that collection's test cases.

Filter the list by status, by case vs suite, by what triggered the run (manual, CLI, CI, or schedule), or by a specific test. Expand any row to see its assertions or steps without leaving the page.

Reports

Each suite has its own Report tab — the same pass rate, trend, and run list as the dashboard, narrowed to that suite, with every run expandable down to its individual steps.

Export any view you are looking at, filters included, as a PDF to share or a CSV to work with in a spreadsheet. Paid plans export a Summary; Team exports a Detailed report that adds the per-assertion and per-step breakdown of every run. How long run history is kept also depends on your plan — see pricing for what each plan includes.

Configure auth once per request (or inherit it from a collection).

API Key

Choose API Key, enter the header name (e.g. X-API-Key) and your key value. Sent as a request header.

Bearer Token

Choose Bearer and paste your token. apikumo adds the Authorization: Bearer … header automatically.

Basic Auth

Enter a username and password. apikumo encodes them as a Base64 Authorization header.

Environment Variables

Store credentials as variables (e.g. {{apiKey}}) so they are never hardcoded in a request.

Any collection can be published as a public, shareable API doc site in one click.

• Publish — open a collection's menu → Publish docs. A unique URL is generated (e.g. apikumo.com/docs/your-collection).
• Versions — create a new version snapshot to preserve the current state while continuing to edit the live collection.
• Themes — choose a light or dark theme and optionally set a custom subdomain (Pro and above).
• Try-it panel — visitors can make live API calls directly from the docs page. Auth values they enter stay in their browser only.

The apikumo CLI lets you push OpenAPI specs to apikumo from the terminal, useful for CI pipelines and git-based workflows.

Install

macOS:

brew install apikumo/tap/apikumo

macOS, Linux, or Windows via npm:

npm i -g @apikumo/apikumo

Other platforms — download the binary from the Download page.

Authenticate

Run the login command and follow the browser prompt:

apikumo login

Initialize

Bind your repo to an apikumo collection and set the OpenAPI source folder:

apikumo init

Push

Push your OpenAPI spec(s) to apikumo:

apikumo push

To push a single file: apikumo push --file ./openapi.yaml

Run tests

Run a test suite by slug — find the slug with apikumo test list:

apikumo test run checkout-smoke --env Staging

In CI, authenticate with the APIKUMO_TOKEN environment variable instead of running apikumo login. Get the value by running apikumo token show --yes after logging in locally, then paste it into your CI secret store.

Status

Check login, collection, and source folder status:

apikumo status

Bring existing API definitions into apikumo without manual re-entry.

• curl command — go to Import → curl and paste a curl command. apikumo parses the method, headers, and body automatically.
• Postman collection — go to Import → Postman and upload a Postman v2.1 JSON export. Folders, requests, auth, and variables are mapped to apikumo equivalents.
• OpenAPI / Swagger — upload an OpenAPI 3.x or Swagger 2 YAML/JSON file. Each operation becomes a request; schemas populate the documentation fields.

Access all import options from the workspace sidebar → Import button, or from the collection menu → Import into collection.

Organizations let multiple people share workspaces, collections, and billing under one account.

Create an org

Click the org switcher in the sidebar → New organization. Your personal account is a built-in org — no setup needed for solo use.

Invite members

Open the org settings → Members → Invite. Enter an email address and choose a role.

Roles

• Owner — full access including billing and org deletion
• Admin — manage members and workspaces, no billing access
• Editor — create and edit collections and requests
• Viewer — read-only access to shared workspaces

Shared workspaces

Create a workspace inside an org and all org members with Editor or above can collaborate on its collections.