Voice for API Documentation

Dictate API endpoint documentation as you build them. Capture request/response schemas, auth requirements, and usage examples while the details are fresh.

The Problem

API documentation is perpetually outdated because writing it is a separate task from building the API. Developers implement endpoints, move on to the next feature, and the docs never catch up. External consumers struggle with undocumented or incorrectly documented endpoints.

The Solution

Ummless lets you document each endpoint right after building it by simply explaining how it works. The Technical Documentation preset formats your explanation into structured API docs with endpoint paths, methods, parameters, response schemas, and example calls.

Workflow

Build the endpoint
Implement your API endpoint and verify it works with manual testing.
Open Ummless
Select "Technical Documentation" to generate structured API documentation.
Describe the endpoint
Explain the HTTP method, path, parameters, request body, response format, authentication requirements, and any edge cases.
Review the output
Verify the documentation matches your implementation. Check parameter types and response schemas.
Add to your docs
Paste the documentation into your API reference, whether that's a docs site, Swagger file, or README.

Before & After

Raw Transcript

So the create user endpoint is a POST to /api/v1/users. You need to send a JSON body with name which is a string and email which is also a string and an optional role field that defaults to member. It requires a bearer token in the auth header. On success it returns a 201 with the created user object including the generated ID. If the email is already taken it returns a 409 conflict.

Refined Output

### POST /api/v1/users Create a new user account. **Authentication:** Bearer token required **Request Body:** | Field | Type | Required | Description | |-------|------|----------|-------------| | name | string | Yes | User's display name | | email | string | Yes | User's email address (must be unique) | | role | string | No | User role. Defaults to `member` | **Responses:** - `201 Created` - Returns the created user object with generated `id` - `409 Conflict` - Email address already in use

Suggested Presets

Technical Documentation

Frequently Asked Questions

Does it generate OpenAPI/Swagger format?

The default output is human-readable Markdown. You can create a custom preset that instructs the refinement to output YAML in OpenAPI format.

Can I document multiple endpoints in one session?

Yes. Describe each endpoint clearly, and the preset will organize them into separate sections. For large APIs, consider documenting one endpoint per session for clarity.

Ready to try it?

Download Ummless and start using voice for your workflow.