OpenAPI and Postman integration
The whole API, in a file your tools already understand
The Instant Snap API and the Auto Schedule API each publish their contract as an OpenAPI 3.1 document. Import it into Postman to try every endpoint, or hand it to a code generator for a typed client in a language we do not ship a library for.
At a glance
- Format
- OpenAPI 3.1, JSON
- Reading it
- Public, no API key needed
- Authentication
- X-Api-Key header, declared in the document
- Changes
- Only with a release
What you can do with it
Try every endpoint in Postman
Paste a document's address into Postman's Import dialog and you get a collection with every endpoint and field. Insomnia and Bruno import it the same way.
Generate a client
Hand the document to a generator such as OpenAPI Generator for a typed client in Rust, Kotlin, Swift, Dart or anything else it supports.
Authentication already set
Both documents declare the X-Api-Key header as their security scheme, so an imported collection carries it: set your key once.
Ready for AI tools
Agents and coding assistants that read OpenAPI can call the API from the document alone, field descriptions included.
Import it into Postman
- 1
Copy a document's address
Instant Snap API: https://api.websitescreenshotworld.com/instant-snap/v1/openapi.json. Auto Schedule API: https://autoapi.websitescreenshotworld.com/auto-schedule/v1/openapi.json.
- 2
Import
In Postman choose Import, paste the address and confirm. A collection with every endpoint appears.
- 3
Set your key
Open the collection's authorization, which is already the X-Api-Key header, and paste your key: wsw_api_ for Instant Snap, wsw_autoapi_ for Auto Schedule.
FAQ
Questions about OpenAPI and Postman
Should I generate a client or use a library?
Use an official library if there is one for your language - Node.js, Python, Java, .NET, Go, PHP or Ruby. They add retries with idempotency keys, typed errors and webhook verification, which a generated client does not. Generate a client for any other language.
Do I need an API key to download the documents?
No. The documents are public and are served by the APIs themselves. Calling the endpoints they describe needs a key.
How often do the documents change?
Only with a release, so a collection or client you build from today's document stays valid until the next one.
More integrations
AI assistants (MCP)
Connect Claude, Cursor, VS Code or any MCP client to our server, then ask the assistant to capture a page or read what it says.
Client libraries
Official libraries for Node.js, Python, Java, .NET, Go, PHP and Ruby, with retries, typed errors and webhook verification built in.
Webhooks
A signed POST to your endpoint when a capture finishes or fails, a page changes, a delivery completes or a sitemap run ends.
Try it on your own pages
Start a free trial, create an API key, and your first capture is a few minutes away.