Generate Comprehensive API Reference Guides

API Reference Guide Creator helps produce developer-facing documentation for APIs. It organizes material around an overview, authentication, resource endpoints, error handling, rate limiting, SDKs, and changelog information. Endpoint entries can describe HTTP methods, paths, required and optional parameters, request bodies, successful responses, and common error responses. The source demonstrates user resource operations, including retrieving an individual user and creating an account, with example requests and JSON payloads.

The guide can also define data schemas, such as a User object with an identifier, email, and creation timestamp. It supports examples in curl, JavaScript, Node.js, Python, and YAML, and discusses advanced reference topics such as filtering, pagination, sorting, selecting response fields, webhooks, batch operations, and idempotency keys.

Use this guide when documenting an API for developers who need to implement requests, understand responses, and handle errors. It is suited to APIs with multiple resources or behaviors that need a consistent reference format. Use the source material for the actual endpoint paths, authentication requirements, parameter rules, response fields, status codes, and rate limits.

Do not present illustrative values such as api.example.com, YOUR_API_KEY, or the sample user records as real production details. Do not claim that an endpoint, SDK, limit, webhook, or response schema exists unless the API specification or implementation confirms it. Use testing examples before publication and verify execution against the implementation.

Inputs include API specifications, endpoint definitions, authentication details, request and response examples, error formats, schema definitions, rate limit behavior, and changelog information. OpenAPI and Swagger specifications can serve as documentation inputs. Postman collections and available client libraries can also inform the reference.

The output is a structured reference grouped by resource, with method and path, parameter descriptions, request examples, response schemas, and error explanations. A User example includes id, email, created_at, and nested profile fields. The source also shows a validation error structure with a code, message, field-level details, and request identifier. Keep examples representative and label required versus optional inputs clearly.

This guide is for API developers and technical writers preparing reference material for people integrating with an API. Product teams can use its structure to make endpoint behavior, data shapes, errors, and client options easier to find. Before publishing, reviewers should compare every documented detail and runnable example with the actual API source.

curl -X GET "https://api.example.com/v1/users" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"