OpenAPI & Postman

We publish the OpenAPI 3.1 spec and a ready-to-import Postman collection. Use them to generate a client SDK, test with Bruno/Hoppscotch, or auto-build internal tooling.

Download

Both files are served straight from the MentionsAPI site, so you can hot-link them from tooling that fetches spec URLs directly.

/openapi.json
OpenAPI 3.1 spec

Full machine-readable API contract. Feeds Swagger UI, Redoc, openapi-generator, orval, and any editor that speaks OpenAPI.

/mentionsapi.postman_collection.json
Postman Collection v2.1

Pre-built requests for every endpoint with auth variables wired up. Import once and start poking the API.

Import into Postman

  1. Open Postman and click Import in the top-left of the workspace.
  2. Choose Link and paste https://mentionsapi.com/mentionsapi.postman_collection.json, or drop the downloaded JSON file into the Import dialog.
  3. After import, open the collection's Variables tab and set apiKey to a live token from the dashboard.
  4. Expand the Ask folder and send POST /v1/ask to verify everything is wired up.

Prefer the command line? Grab the file and open it via File → Import:

bash
curl -fsSL https://mentionsapi.com/mentionsapi.postman_collection.json \
  -o mentionsapi.postman_collection.json

Generate an SDK

Point openapi-generator-cli at the hosted spec to scaffold a fully typed client. The example below builds a typescript-fetch client, but any generator that accepts an OpenAPI 3.1 URL works the same way.

bash
openapi-generator-cli generate \
  -i https://mentionsapi.com/openapi.json \
  -g typescript-fetch \
  -o ./mentionsapi-client

Popular swap-ins: -g python, -g go, -g rust, -g kotlin. Or use Orval / Hey API for a tighter TypeScript experience.

Use with Bruno / Hoppscotch

Both tools accept the OpenAPI URL directly. Bruno stores requests as plain files in your repo (nice for diffing); Hoppscotch runs in the browser and is handy for quick checks.

bash
# Bruno
File -> Import Collection -> OpenAPI v3 spec
Paste: https://mentionsapi.com/openapi.json

# Hoppscotch
Settings -> Import / Export -> Import from OpenAPI
Paste: https://mentionsapi.com/openapi.json

Stay in sync

Both the OpenAPI spec and the Postman collection are regenerated on every release. Tools that cache by URL should refresh on deploy or hit https://api.mentionsapi.com/openapi.json directly (served with a short cache). If your build pipeline pins to a specific version, lock against the info.version field — we bump it whenever the contract changes.