Start here

Which API do I need?

Website Screenshot World publishes two APIs. They share an authentication scheme and nothing else — different keys, different hosts, different paths, different limits. Picking the right one takes about a minute.

Two APIs, two keys

Both APIs are authenticated with the same X-Api-Key header, but each takes a key of its own: an Instant Snap API key starts with wsw_api_, an Auto Schedule API key with wsw_autoapi_, and neither opens the other. Everything else about them is separate too, deliberately: they solve different problems and are metered differently.

The same names in the app

In the app, the Instant Snap API's keys are on the Instant Snap API tab under Developer Tools › API Keys, and its captures are listed on the Instant Snap API page. The Auto Schedule API’s keys are on the Auto Schedule API tab.

They are not on the same host

A path copied from one product and sent to the other will not work. The Instant Snap API lives on api.websitescreenshotworld.com; the Auto Schedule API lives on autoapi.websitescreenshotworld.com. Every example in this reference shows the full URL for that reason.

Which one do I need?

ValueMeaning
I have a URL and want an image backInstant Snap API. One request in, one file out, no setup in the app.
I already built a schedule and want to fire it earlyAuto Schedule API. It triggers the schedule you configured, with its Web Profile.
I want captures on a cadenceNeither — that is an Auto Schedule in the app. No code needed.
I want a capture after my deploy finishesEither. The Instant Snap API if the settings live in your code; the Auto Schedule API if they live in a Web Profile.
I want the file written to my own S3 bucketInstant Snap API — it can deliver straight to a bucket you own.

Instant Snap API at a glance

On-demand capture. You describe the page and the rendering you want in the request body, and the API answers with the file, a link to it, or a receipt for a delivery to your bucket. Nothing has to exist in the application first.

  • Images, videos and PDFs, or the page's readable text as Markdown or plain text
  • Desktop or emulated mobile, viewport or full page
  • Custom headers, cookies, locale, time zone and geolocation
  • Three response modes: the raw file, a JSON envelope, or delivery to your S3 bucket
Instant Snap API — capture a page
curl -X POST https://api.websitescreenshotworld.com/instant-snap/v1/captures \
  -H "X-Api-Key: wsw_api_0123456789ab_your_secret" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "response_type": "json",
    "media_category": "image",
    "format": "png"
  }'

Auto Schedule API at a glance

A trigger, not a capture engine. It has exactly one endpoint, it takes no request body, and it fires a schedule that already exists in your account — with that schedule’s URL, its Web Profile, its delivery settings and its retention.

  • One endpoint, one path parameter, no body
  • The capture is identical to pressing Quick Capture in the app
  • Calling it twice while a capture is already running is safe — it tells you so and does nothing
Auto Schedule API — trigger a schedule
curl -X POST \
  https://autoapi.websitescreenshotworld.com/auto-schedule/v1/web-pages/8f14e45f-ceea-467a-9d0b-2c0b6f1a9e77/trigger-now \
  -H "X-Api-Key: wsw_autoapi_0123456789ab_your_secret"

Base URLs

ValueMeaning
https://api.websitescreenshotworld.com/instant-snap/v1Instant Snap API. All capture endpoints hang off this prefix.
https://autoapi.websitescreenshotworld.com/auto-schedule/v1Auto Schedule API. The trigger endpoint hangs off this prefix.

Always over HTTPS

Your API key travels in a plain request header, so always call the https:// address shown above, never http://.

OpenAPI documents

Each API publishes its contract as an OpenAPI 3.1 document, served by the API itself. It describes every endpoint and field of that API, it needs no API key to read, and it changes only with a release.

Paste either address into Postman's Import dialog to get a collection with every endpoint, or hand it to a code generator such as OpenAPI Generator to produce a typed client in your own language. Both documents declare the X-Api-Key header as their authentication, so an imported collection carries that header as its authorization: set your key there once.

Download both documents
curl -o instant-snap.openapi.json https://api.websitescreenshotworld.com/instant-snap/v1/openapi.json
curl -o auto-schedule.openapi.json https://autoapi.websitescreenshotworld.com/auto-schedule/v1/openapi.json

Did this page answer your question?

Tell us what is missing