Suede AI Agent StudioTemplatesStart buildingOpen workspace
Navigation menu

API Docs Generator

Engineering template

Paste route handler code or an OpenAPI spec, get human-readable endpoint docs with examples.

Built for
Dev tools teams and API-first agents generating readable docs from raw code or an OpenAPI spec instead of writing them by hand.
  • Free to test
  • $0.06 per endpoint set, paid to you
  • You keep 100% of every sale

What API Docs Generator takes and returns

You give it

  • source text

router.post('/orders/:id/cancel', requireAuth, async (req, res) => { const { reason } = req.body; if (!reason) return res.status(400).json({ error: 'reason required' }); ... res.status(200).json({ orderId: req.params.id, status: 'cancelled' }); });

You get back

The api docs, with these fields:

  • endpoints

{ endpoints: [{ method: 'POST', path: '/orders/:id/cancel', summary: 'Cancel an order', parameters: [{ name: 'id', in: 'path', type: 'string', required: true, description: 'Order ID' }, { name: 'reason', in: 'body', type: 'string', required: true, description: 'Cancellation reason' }], response_example: '{ orderId: 123, status: cancelled }', status_codes: [{ code: 200, meaning: 'Order cancelled' }, { code: 400, meaning: 'Missing reason' }] }] }

How the 3-step flow works

API docs drafted straight from your source code or spec. Paste in route handler code or an OpenAPI/Swagger spec and it returns per-endpoint documentation: method, path, parameters with types, example requests and responses, and status codes, all derived only from what's actually in the code or spec.

  1. Input

    Takes the source.

  2. Claude

    Claude works as a technical writer.

  3. Output

    Returns the api docs.

The brief behind API Docs Generator

You are a technical writer who turns raw code (route handlers, function signatures) or an OpenAPI/Swagger spec into clear, human-readable API documentation. You infer parameters, request/response shapes, and status codes only from what is actually in the input; you never invent a field, parameter, or status code that is not present in the code or spec. When authentication, rate limits, or error handling are not shown in the input, you omit those sections rather than guessing. You write example requests and responses using only field names and types that appear in the source. Output strict, valid JSON only, no prose, no markdown.

Generate documentation for the API code or spec below. Return STRICT JSON only: { "endpoints": [{ "method": string, "path": string, "summary": string, "parameters": [{ "name": string, "in": "path"|"query"|"body"|"header", "type": string, "required": boolean, "description": string }], "request_example": string|null, "response_example": string|null, "status_codes": [{ "code": number, "meaning": string }] }] }. Use only parameters, types, and status codes present in the input; do not invent fields that are not in the code or spec.

What API Docs Generator can earn

Set your price per endpoint set. Callers pay in USDC over x402, and every settled call routes to your wallet.

Your price per endpoint set
Routes to your wallet each month$1803,000 paid calls at $0.06 · Suede AI takes 0% of the sale

Put API Docs Generator to work

All 3 steps open wired, priced at $0.06 per endpoint set.

Good work starts with a clear flow.

Give an agent a job. Connect the steps. See how the work becomes a service someone else can call.

Input
Reason
Output

A workflow you can inspect

Make the steps visible.

Start with a template or describe the job. Connect inputs, reasoning, and output on the canvas.

Explore templates
Canvas in motionProduct visualization · 20 sec
Read the visual description

A stylized organization chart opens into a workflow canvas. Input and reasoning nodes connect, the flow branches, and the run moves through its steps. The film ends with Suede AI Agent Studio. Music only; no spoken narration.