Postman collections

We maintain a Postman collection for every API we currently offer, in the public useapi.net Postman workspace. Each collection covers the endpoints of one API, and most requests link back to their page in these docs.

Table of contents

  1. Collections
  2. Use a collection
  3. OpenAPI / Swagger
  4. Machine-readable discovery

Collections

The raw JSON files are the same collections we sync to the workspace, in Postman Collection v2.1 format.

Use a collection

  1. Get your useapi.net API token, see Setup useapi.net.
  2. Open the collection in the workspace and click Fork to copy it into your own workspace. You can also download the raw JSON from the table above and use Import in the Postman app.
  3. Open the collection’s Variables tab and paste your token into api-token. Requests send it as Authorization: Bearer {API token}.
  4. Fill in the other collection variables the requests use, such as the service account email or a jobid returned by an earlier call.
  5. Pick a request, adjust its body or query parameters, and send it. The endpoint’s docs page lists every parameter and response field.

Most generation endpoints are asynchronous. Send the create request first, then call the matching job endpoint with the returned id until the job completes. Every endpoint page also has a Try It form if you would rather test in the browser.

OpenAPI / Swagger

We do not publish separate OpenAPI (Swagger) specs for the current APIs. The Postman collections are the machine-readable description of each API. If your tooling needs OpenAPI, convert the raw collection JSON with a Postman-to-OpenAPI converter, and check the result against the endpoint docs.

Machine-readable discovery

  • /.well-known/api-catalog lists every active API with its docs page and its collection JSON (RFC 9727).
  • /auth.md describes how API authentication works, for AI agents.
  • LLM tools has per-service documentation files, llms.txt, and drop-in context files for Claude Code and Cursor.