Create beginner Works with: Any AI

API Documentation Writer

Few shot Has example

Create clear developer docs from endpoint details.

The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.

[VERIFY] is an editorial flag, not a blank to fill. Wherever the prompt shows [VERIFY], check that item against a reliable source before you use it.

Write clear developer documentation for my API endpoints. Product and audience: [PRODUCT_AND_AUDIENCE]. Authentication method: [AUTH_METHOD]. Endpoint details (method, path, parameters, request body, response, errors): [ENDPOINT_DETAILS]. Base URL and versioning: [BASE_URL_AND_VERSIONING].

Match the documentation style of this example for one endpoint:

### Create an invoice
POST /v1/invoices
Creates a draft invoice for a customer.
Parameters (JSON body): customer_id (string, required) - the customer to bill; currency (string, required) - three-letter ISO code, such as "usd"; items (array, required) - one or more line items; due_date (string, optional) - ISO 8601 date, defaults to 30 days from creation.
Example request: a curl command with a placeholder token.
Example response (201): a JSON body with id, status "draft", and total.
Errors: 400 invalid_request (missing field), 401 unauthorized, 404 customer_not_found, 429 rate_limited.
Notes: invoices stay in draft until finalized; send an Idempotency-Key header to retry safely.

Document every endpoint I provided in that style, plus: a "Getting started" page with a first call in under five minutes, an authentication guide, an error reference table, pagination and rate limit explanation, and a changelog template. Use realistic fake values, never real keys, and mark undocumented behavior as [VERIFY]. Keep sentences short.

Verify every fact, figure and claim in the output against your own records or the official documentation, and have a qualified professional check anything with legal, safety or financial consequences before you rely on or publish it.

Fill in before use

Optional: type your details and the prompt above updates. Nothing is saved or sent.

Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.

### Create a project
POST /v1/projects
Creates a project in your workspace.
Parameters (JSON body): name (string, required) - 1 to 80 characters; template_id (string, optional) - copy structure from a template; visibility (string, optional) - "private" (default) or "team".
Example request: curl -X POST https://api.example.com/v1/projects -H "Authorization: Bearer YOUR_TOKEN" -d '{"name": "Website redesign"}'
Response (201): {"id": "prj_8f3", "name": "Website redesign", "visibility": "private"}
Errors: 400 invalid_request, 401 unauthorized, 409 name_taken, 429 rate_limited.
Notes: names are unique per workspace. Send an Idempotency-Key header to retry safely. [CONFIRM] rate limit value.

• documentation
• developer-experience