Skip to main content

Software Development

API Documentation Generator

API Documentation Generator produces complete, accurate API documentation that reduces time-to-first-successful-call to under 15 minutes for a competent developer. It covers every endpoint with parameters, response schemas, and error states — not just the happy path — plus an authentication guide, quickstart walkthrough, and working code examples. Backend engineers, platform teams, and developer relations leads use it to ship APIs with documentation that actually helps developers integrate, instead of sending them to a Slack channel or support queue. It works from OpenAPI specs, route files, codebase excerpts, or plain descriptions. What makes it production-grade is accuracy. It never invents undocumented behavior. It marks every ambiguity for clarification. It enforces syntactically correct code examples with placeholder values. Every output is ready to publish, not a rough draft needing another round of review.

Nexus CertifiedClaude CodeCodexOpenClawGoogle Antigravity
apidocumentationdeveloper-experienceopenapitechnical-writing

One-Time Purchase

$19.99

Sample Output

Meridian Analytics API Reference (v2)

At a glance

REST API over HTTPS. Bearer-token auth, JSON request and response bodies, ISO 8601 timestamps. Two stable resource families today: datasets (read) and reports (read + write). Async generation pattern on reports — submit, poll for status, fetch the result. Rate limit is 60 req/min per API key.


Authentication

All requests require an Authorization header:

Authorization: Bearer YOUR_API_KEY

Keys are issued per-organization in the Meridian dashboard at Settings → API Keys. Keys are scoped per environment — generate separate keys for development, staging, and production. A key can be rotated without downtime by creating a new one before revoking the old.

Rate limits

60 requests per minute per API key. A 429 response includes a Retry-After header (seconds). Clients should back off exponentially with jitter and respect that header. Sustained 429s indicate the workload needs an enterprise plan, not a tighter retry loop.


Endpoints

v2 endpoint surface

/v2/datasets — list datasets in your orgGET
/v2/datasets/:id — fetch a single datasetGET
/v2/reports — create a new report (async)POST
/v2/reports/:id — fetch report status and resultGET
/v2/reports/:id — delete a generated reportDELETE

POST /v2/reports — Create a Report

Submits a report for asynchronous generation. Returns immediately with a report ID; poll GET /v2/reports/:id until status is complete.

Request body

FieldTypeRequiredDescription
dataset_idstringYesID of the source dataset
report_typeenumYesOne of summary, detailed, executive
date_range.startISO 8601YesInclusive start date
date_range.endISO 8601YesInclusive end date
filtersobjectNoKey-value filter pairs applied to the dataset
include_rawbooleanDeprecatedRemoved in v3 — use report_type=detailed

Success — 201 Created

{
  "id": "rpt_a1b2c3d4",
  "status": "processing",
  "dataset_id": "ds_x9y8z7",
  "report_type": "summary",
  "created_at": "2026-04-12T14:30:00Z",
  "estimated_completion": "2026-04-12T14:32:00Z"
}

Errors

CodeHTTPDescriptionResolution
INVALID_DATASET400Dataset ID does not exist or is not visible to your orgVerify via GET /v2/datasets
UNAUTHORIZED401Invalid or expired API keyRegenerate from the dashboard
RATE_LIMITED429Over 60 req/minBack off exponentially; respect Retry-After
GENERATION_FAILED422Dataset is empty for the requested rangeWiden the date range or pick a different dataset

Example

curl -X POST https://api.meridian.example.com/v2/reports \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "dataset_id": "ds_x9y8z7",
    "report_type": "summary",
    "date_range": { "start": "2026-01-01", "end": "2026-03-31" }
  }'

Quickstart

First successful call in under 5 minutes

Sign up at meridian.example.com; navigate to Settings → API Keys1
Generate a development API key and copy it2
List datasets: curl -H "Authorization: Bearer YOUR_KEY" https://api.meridian.example.com/v2/datasets3
Pick a dataset ID; create a report with POST /v2/reports4
Poll GET /v2/reports/:id until status is "complete"5

Deprecation notice

The include_raw field is deprecated and will be removed in v3. Migrate to report_type=detailed, which returns the same payload. Sunset date is the v3 GA — see the migration guide.


This sample illustrates the skill's output format. Endpoints, response shapes, and error codes are illustrative.

View full sample →

All sales final. No refunds on digital products.

Includes support for Claude Code, Codex, OpenClaw, and Google Antigravity in the same license.

Also in Product Documentation & Onboarding

Bundle price: $55. Compare this skill with the full workflow bundle or Pro access.

Best for

Backend teams shipping a public or partner-facing API who need OpenAPI-grounded reference docs plus a quickstart and code samples, without staffing a dedicated docs writer. Most valuable when the API has 20–200 endpoints and the source-of-truth spec is current.

Not ideal for

GraphQL-first APIs where the schema is the doc and the generated REST-style reference doesn’t map cleanly. Also a poor fit when the OpenAPI spec is stale or incomplete — the generator will faithfully document whatever is in the spec, including the wrong things.

Included in this purchase

  • Claude Code, Codex, OpenClaw, and Google Antigravity skill files.
  • Setup guidance for the right adapter in your workspace.
  • One-time license for the purchased skill version.

Setup

Plan for a short setup in the repository or workspace where the skill will run. Some coding familiarity helps for implementation-heavy outputs.

Claude CodeCodexOpenClawGoogle Antigravity

Related Skills

Code Generation & Review
Featured
Code Generation
Generates, reviews, debugs, and executes code in sandboxed workflows. Useful for implementation, refactoring, and technical problem solving.
Claude CodeCodexOpenClawGoogle Antigravity
codingdebuggingcode-review

$19.99

One-time license

View Skill
Code Generation & Review
Intelligent PR Composer
Generates pull request descriptions that capture context, alternatives considered, test plan, risk areas, and reviewer guidance beyond a simple diff summary. Useful for teams that want senior-quality PRs without manual authoring.
Claude CodeCodexOpenClawGoogle Antigravity
pull-requestscode-reviewgit

$19.99

One-time license

View Skill
Code Generation & Review
Code Review Requester
Produces a structured code review brief identifying high-risk sections, performance or security concerns, and a minimum reading path for time-constrained reviewers. Useful for accelerating review cycles and reducing back-and-forth.
Claude CodeCodexOpenClawGoogle Antigravity
code-reviewcollaborationpull-requests

$19.99

One-time license

View Skill

Future Updates

This purchase includes the current version of the skill. If you want future adapter updates — meaning compatibility and packaging updates as supported platforms evolve — plus new catalog additions included automatically, upgrade to Pro.

Upgrade to Pro