River
Y CombinatorBacked by Y Combinator

TechnicalFree

Generate request/response example

Give the endpoint and what it does, and get a matching example request and JSON response, plus a typical error, for your API docs.

Context to provide

River's Request/Response Example Generator creates complete, working API examples. You provide endpoint and purpose, and the AI generates realistic curl command and JSON response. Perfect for API documentation showing developers exactly how to use your API.

Unlike placeholder examples, we create realistic, copy-pasteable examples. The AI understands REST conventions, generates appropriate request bodies, and shows complete response structures.

This tool is perfect for API writers documenting endpoints, backend developers creating examples, technical writers improving API docs, and teams showing developers how to integrate.

Creating Effective API Examples

Good API examples are complete, realistic, and copy-pasteable. Show actual JSON with realistic data. Include authentication headers. Display full responses with all fields. Examples should work if developer copies them (after adding their API key). Complete examples reduce support questions.

How It Works

  1. Specify endpoint

    Provide endpoint and what it does

  2. AI generates example

    Creates request and response

  3. Add to documentation

    Include in API docs for developers

What You Get

  • Complete curl request command
  • Realistic JSON request body
  • Full JSON response with all fields
  • Proper headers and authentication
  • Copy-ready once you swap in your real address and key

Common questions

Are the examples working or just templates?

Templates with realistic data. Replace YOUR_API_KEY and example values with real ones. Structure and format work. Developers can copy, update credentials, and run successfully.

Should I include error examples too?

Yes. Show both success and error responses. Developers need to handle both. Include common error cases (400, 401, 404, 422) with example error responses.

What about examples in other languages besides curl?

Curl is universal starting point. From curl, developers understand HTTP request structure. Many tools generate language-specific examples from OpenAPI specs automatically. Start with curl, add others if needed.

Generate request/response example

Describe what you need, add any files you have, and your workspace opens with the work already underway.