All products

Write Postman API documentation with AI

Document the decisions a caller needs to make, keep valuable collection examples and distinguish a team workspace update from publishing a public reference.

Write Postman API documentation with AI when a request works for its author but leaves the next developer guessing whether a field is required or an error is safe to retry. The api-documentation skill starts from an agreed contract and the existing collection. It helps an agent turn verified behaviour into explanations that matter to a caller.

An OpenAPI description may define the interface, while the collection contains carefully maintained examples and assertions. Generating new requests is therefore a comparison step, not a reason to erase the team’s existing work. The delivery route also matters when material is suitable for colleagues but not for a public reference.

What it does

  • Explain required inputs, authentication scopes and side effects.
  • Include a useful error example alongside a successful response.
  • Compare generated requests with existing scripts and examples.
  • Leave uncertain behaviour open until the contract or a test establishes it.
  • Choose between a local review, an authorised workspace update and public documentation.

Install and use

  1. Supply a permitted collection or specification, fictional sample values and the intended audience. Use the official Postman tools and appropriate permissions for any workspace or publishing action.
  2. Ask, “Document the order endpoint, include the validation failure and show what would change in our existing collection.”
  3. Review the examples for accuracy and sensitive data before sharing them with their intended readers.

FAQ

Source

Made by Postman. Original skill: api-documentation, published on GitHub under the Apache-2.0 licence.

View on GitHub