Works with the AI tools you already use

    Claude CodeClaude CodeCursorCursorCodex CLICodex CLIMuseMuseOpenClawOpenClaw+21 more

    API Documentation & Example Generator

    1

    Transform raw API specs into structured Markdown documentation, safe code examples, and integration guides.

    $5

    Secure checkout via Stripe

    30-day refund guarantee

    Converts to your local currency at checkout

    0 installsSecurity scanned
    API Documentation & Example Generator

    API Documentation & Example Generator

    Example session with this skill installed

    Generate documentation for a POST /v1/payments endpoint. Requires Bearer auth. Needs amount (int), currency (string, ISO), and source (string). Returns 201 on success.

    • Read your context and instructions
    • Compiled the api documentation

    I have processed the specifications for the Payments API. I identified that the source parameter format and specific error codes (400, 401, 402) were not fully defined, so I have flagged these for your review.

    API Documentation Draft: Payments Service v1

    Endpoint: POST /v1/payments
    Summary: Initiates a new payment transaction.
    Authentication: Bearer Token required. Use <YOUR_ACCESS_TOKEN>.

    Request Parameters

    NameTypeRequiredDescription
    amountIntegerYesThe amount to charge in the smallest currency unit.
    currencyStringYesThree-letter ISO currency code (e.g., USD).
    sourceStringYesThe payment source identifier.

    Request Example

    curl -X POST https://api.example.com/v1/payments \
  -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 5000,
    "currency": "USD",
    "source": "src_12345"
  }'

    Response Example (201 Created)

    {
  "id": "pay_98765",
  "status": "pending",
  "amount": 5000,
  "currency": "USD",
  "created_at": "2023-10-27T10:00:00Z"
}

    Missing Information & Questions

    1. Source Format: What are the valid prefixes for the source string (e.g., tok_, src_)?
    2. Error Payloads: What is the expected JSON structure for a 402 Payment Required error?
    3. Idempotency: Does this endpoint support Idempotency-Key headers?

    Next steps

    1. Define the specific validation rules for the source field.
    2. Provide a sample error response body to complete the Error Reference table.
    3. Confirm if any optional metadata fields should be added to the request.

    Connects securely to your tools. The creator never sees your data.

    What you get

    Generate structured API references from raw endpoint notes.Create safe code examples with redacted secrets and placeholders.Identify gaps and ambiguities in new API specifications.Draft integration guides for multi-step API workflows.

    About this skill

    Struggling with inconsistent API documentation or missing code examples? This skill converts raw endpoint specifications and schemas into implementation-ready reference docs. It eliminates the guesswork that leads to integration errors by sticking strictly to your provided source material.

    What it does

    • Standardizes references by organizing methods, paths, and auth requirements into scannable Markdown.
    • Generates safe examples using placeholders for secrets and illustrative values for request/response payloads.
    • Maps error codes into structured tables covering status codes, meanings, and recovery steps.
    • Drafts integration guides that outline the exact sequence of requests needed for common workflows.
    • Performs gap analysis by identifying missing parameters, ambiguous schemas, or undocumented behaviors.

    How it works

    1. Supply your raw API spec, endpoint details, or schema definitions.
    2. The skill audits the input for missing details and summarizes the documented scope.
    3. It generates the full reference, including examples and error handling logic.
    4. Review the "Missing Information" section to fill in any gaps identified during the process.

    Frameworks & tools

    Outputs clean Markdown compatible with GitHub, GitLab, and most static site generators. Supports cURL and language-specific snippets for any standard programming language.

    Why this beats prompting it yourself

    Generic prompts often hallucinate missing fields or invent auth schemes to "fill the blanks." This skill enforces grounding rules that distinguish between confirmed facts and illustrative values, ensuring your docs remain technically accurate.

    Use cases

    • Documenting internal microservices for other teams.
    • Converting legacy API notes into professional developer portals.
    • Generating quickstart guides for third-party developers.
    • Auditing new endpoint specs for consistency before they go live.

    Known limitations

    Does not validate if the API actually works or if OpenAPI files are syntactically valid. Requires manual verification of business logic and production URLs.

    How to install

    Works the same in every agent - Claude, Cursor, Codex, Copilot and 20+ more.

    ~30 seconds
    1. 1

      Download the ZIP

      Free skills download straight away. Paid skills unlock right after purchase.

    2. 2

      Unzip into your skills folder

      Every agent reads skills from one folder on your machine. Drop the unzipped folder in there.

    3. 3

      Ask your agent to use it

      Restart the agent if it was already running. It picks the skill up automatically - no config needed.

    Skills folder by agent

    Click the path to copy it. Create the folder if it does not exist yet.

    Reviews

    No reviews yet

    Be one of the first to try it. Every listed skill passes our trust checks below.

    Security scanned

    Passed our 8-point scan before listing

    Fresh listing

    Recently published to Agensi

    30-day refund

    Not a fit? Get your money back

    Trust & safety

    Security scanned

    Verified clean today

    • Passed all security checks, Safe to install

    Listedtoday

    What's inside

    Frequently Asked Questions