Documentation

API docs your developers will love

Build a world-class API documentation platform with interactive references, auto-generated code samples, and comprehensive guides. Ship developer documentation that drives adoption and reduces support burden.

docs.yourcompany.com/api/v2
API ReferenceUsersList Users
GET/api/v2/users

Returns a paginated list of users in the current organization. Supports filtering by role, status, and creation date.

Query Parameters
page
integer
Page number
per_page
integer
Items per page
role
string
Filter by role
Response Schema
{
"data": [
{ "id": 1, "name": "...", "email": "..." }
],
"meta": { "total": 142, "page": 1 }
}
Interactive API Reference

Explore endpoints with live requests

Ditch static documentation that quickly goes stale. Mihari's API documentation platform auto-generates an interactive reference from your OpenAPI or Swagger specification. Developers can read parameter descriptions, see type information, and fire real API calls without leaving the browser. Every endpoint includes request and response examples that update automatically as your API evolves.

  • Auto-generated from OpenAPI/Swagger specifications with real-time sync
  • In-browser "Try it" console for sending live API requests
  • Type-safe parameter validation with inline error messages
  • Request and response examples for every endpoint and status code
  • Authentication helper that manages tokens across all test requests
API Reference — Monitors
GET/api/v2/monitors
POST/api/v2/monitors
GET/api/v2/monitors/{id}
PATCH/api/v2/monitors/{id}
DELETE/api/v2/monitors/{id}
POST/api/v2/monitors/{id}/pause
POST/api/v2/monitors
Try it
Request Body
{
"url": "https://api.acme.com",
"type": "http",
"interval": 60
}
201 Created
{
"id": 847,
"url": "https://api.acme.com",
"status": "active"
}
Code Samples
cURL
JavaScript
Python
PHP
Ruby
Go
curl -X GET \
"https://api.mihari.io/v2/monitors" \
-H "Authorization: Bearer sk_live_abc123" \
-H "Content-Type: application/json" \
-d '{
"page": 1,
"per_page": 25
}'
Auto-generated from your OpenAPI spec
Copy
Code Samples

Ready-to-use code in every language

Reduce time-to-first-call with auto-generated code samples in the languages your developers use every day. From cURL and JavaScript to Python, PHP, Ruby, Go, and C# — every endpoint ships with copy-paste code that works out of the box. Samples stay synchronized with your API specification, so they never go out of date.

  • Auto-generated samples in cURL, JavaScript, Python, PHP, Ruby, Go, and C#
  • One-click copy with syntax highlighting and line numbers
  • Samples update automatically when your API specification changes
  • Custom SDK templates for your official client libraries
Guides & Tutorials

Comprehensive guides that onboard fast

API references alone aren't enough. Mihari's developer documentation platform lets you create rich guides, tutorials, and quickstart walkthroughs with full Markdown support, embedded code snippets, diagrams, and images. Add a table of contents, breadcrumb navigation, and contextual links to help developers find answers without searching.

  • Rich Markdown editor with live preview, images, and embedded media
  • Auto-generated table of contents and breadcrumb navigation
  • Step-by-step tutorial format with numbered sections and code blocks
  • Cross-link between guides, API reference, and changelog entries
  • Multi-language support for global developer audiences
Guides
GuidesGetting Started

Setting up your first monitor

This guide walks you through creating your first uptime monitor in under five minutes. You'll learn how to configure an HTTP check, set up alerting, and view your first response time metrics.

1
Create your project

Navigate to the dashboard and click "New Project" to set up your monitoring workspace.

$ mihari projects create --name "Production API"
2
Add a monitor

Define the endpoint URL, check interval, and expected status code for your HTTP monitor.

Customization & Branding

Your brand, your docs experience

Make your developer documentation a seamless extension of your product. Customize every aspect — colors, typography, logos, favicon, and layout. Host on your own custom domain with automatic SSL. Choose between light and dark themes, configure navigation structure, and add custom CSS for pixel-perfect branding.

Your documentation portal looks and feels like a first-party product, not a third-party hosted page. White-label options ensure complete brand consistency across your developer experience.

Appearance Settings
acme-logo.svg uploaded
#7c3aed
docs.acme.com
SSL Active
Dark
Light
Auto
Changelog
v2.1.0
v2.1.0LatestMarch 5, 2026
AddedWebhook endpoint for real-time monitor events
AddedBulk operations for monitors (pause, resume, delete)
ImprovedResponse time accuracy with microsecond precision
FixedRate limiter returning incorrect retry-after header
v2.0.0BreakingFebruary 18, 2026
BreakingPagination switched from offset to cursor-based
AddedOAuth2 PKCE authentication flow
ImprovedError responses now include machine-readable codes
v1.9.2January 30, 2026
FixedTimezone handling in cron-based monitor schedules
Versioning & Changelogs

Version your API, communicate changes

Keep developers informed as your API evolves. Publish structured changelogs with tagged additions, improvements, fixes, and breaking changes. Maintain multiple API versions simultaneously with a version selector, and give developers clear migration guides when breaking changes are introduced. Every changelog entry links to the relevant documentation so developers know exactly what changed.

  • Side-by-side version comparison with highlighted differences
  • Structured changelog entries with Added, Improved, Fixed, and Breaking tags
  • Version selector dropdown available on every documentation page
  • Auto-generated migration guides for breaking changes
  • RSS feed and webhook notifications for new changelog entries

Built-in search and usage analytics

Lightning-fast documentation search powered by a purpose-built index. See what your developers search for, which pages they visit most, and where they drop off. Use analytics insights to improve your documentation, fill content gaps, and reduce support tickets.

Instant Search

Full-text search across all pages, endpoints, and code samples. Results in under 50ms.

Page Analytics

Track page views, time on page, and bounce rates. Identify your most and least visited docs.

Feedback Collection

Inline "Was this helpful?" feedback on every page. Route suggestions to your content team.

Ship docs developers love

Create an API documentation platform that delights developers and drives adoption. Beautiful, interactive, and always up to date. Free to get started.