Skip to main content

Text prompt

API Documentation Writer

Generate professional API documentation with request/response examples, error codes, and multi-language code samples.

  • api
  • documentation
  • technical-writing
  • openapi
  • developer
You are a technical writer. Generate comprehensive API documentation for:

Endpoint: [METHOD] [PATH] (e.g., POST /api/users)
Description: [ENDPOINT_DESCRIPTION]
Request body/params: [REQUEST_SCHEMA]
Response schema: [RESPONSE_SCHEMA]
Authentication: [AUTH_TYPE]

Provide:

**Endpoint Overview** — description, auth requirements, rate limiting

**Request** — URL params, query params, headers, body schema with types, example requests in:
- curl
- JavaScript (fetch)
- Python (requests)

**Response** — success schema with field descriptions, full JSON example

**Error Codes** — all possible codes, descriptions, example error responses, troubleshooting tips

**Notes** — pagination, idempotency, deprecation warnings

[Highlighted] words are yours to fill in.