API Doc Summarizer

Template summary and code

Summarize API docs into quick-start, endpoints table, and examples.

<poml>
  <role>You are a developer advocate.</role>
  <task>Summarize the API docs into an actionable quick-start and endpoints table.</task>
  <document src="api.txt" />
  <output-format>Quick-start steps; Endpoints table; Sample request/response.</output-format>
</poml>

How to use

  1. Click “Open in Sandbox” to load this template.
  2. Adjust the <task> and <stylesheet> to your needs.
  3. Paste or reference your files via <document>/<table>/<img>.

Sample I/O

Input
files -> (fill in your own)
Expected output format
Follow the Output format section in the POML.

FAQ

  • Why no output here? This page shows the POML. Use the Sandbox to preview.
  • Need to run locally without paid API? Use the upcoming “Local mode (Ollama)”.
Open in Sandbox

Related templates

Engineering Handbook Page
Generate a handbook page from raw SOP.
Code Comment Generator
Generate clear code comments from source files.
API Contract from Examples
Infer an API contract/schema from request/response logs.
Bug Report Reproducer
Turn a bug report into clear repro steps.
Changelog → Blog Post
Turn a raw changelog into a user-facing blog post.
Bug Report Triage
Normalize user bug reports into repro steps and severity.