API docs · Draft scaffold · Hiring managers · API / platform docs reviewers
Draft scaffold Zero invented vocabulary Public API

Public API documentation sample

Structure for a getting-started guide plus thin API reference against a real public API (e.g. OpenWeather, Stripe test mode, or another free OpenAPI surface). Choose the API and write the body in a separate editorial pass. No AgentVector / Codex / Verdict terms on this page.

Contents

Goal

TODO: One sentence — what a developer can do after reading this guide.

TODO: Name the chosen public API and link to its official docs / OpenAPI.

Audience

TODO: Assumed skill level, tools (curl / Postman / language SDK), time to first successful call.

Getting started

  1. TODO: Prerequisites (account, API key, environment)
  2. TODO: First request (copy-pasteable)
  3. TODO: Expected response
  4. TODO: Next useful call

API reference (thin)

TODO: 2–4 endpoints in a table: method, path, purpose, auth, example.

TODO: Optional: embed or link an OpenAPI fragment; do not invent fields.

Troubleshooting

TODO: Common errors (401, rate limit, bad params) with fixes.

← Portfolio · Process