To make a screenshot request to the ScreenshotsCloud API use the following format:

https://api.screenshots.cloud/v1/screenshot/[API_KEY]/[TOKEN]/?[PARAMETERS]

API Implementations

We have API implementations already written for you to use in a number of languages. If you have need for an implementation in a language not listed here please contact support@brushd.com.

npm install screenshotscloud

yarn add screenshotscloud

const ScreenshotsCloud = require('screenshotscloud');

const SCREENSHOTSCLOUD_KEY = 'my-key-generated-at-screenshots-dot-cloud';
const SCREENSHOTSCLOUD_SECRET = 'mysecretstringgeneratedatscreenshotsdotcloud';

const screenshotscloud = ScreenshotsCloud(SCREENSHOTSCLOUD_KEY, SCREENSHOTSCLOUD_SECRET);

const screenshotUrl = screenshotscloud.screenshotUrl({
	"url": "openai.com/research", 
	"width": 800
});

const ScreenshotsCloud = require('screenshotscloud');
const request = require('request'); // make sure to npm install request or yarn add request to your project first
const fs = require('fs');

const SCREENSHOTSCLOUD_KEY = 'my-key-generated-at-screenshots-dot-cloud';
const SCREENSHOTSCLOUD_SECRET = 'mysecretstringgeneratedatscreenshotsdotcloud';

const screenshotscloud = ScreenshotsCloud(SCREENSHOTSCLOUD_KEY, SCREENSHOTSCLOUD_SECRET);

const screenshotUrl = screenshotscloud.screenshotUrl({
	"url": "openai.com/research", 
	"width": 800
});

request.get(screenshotUrl, {encoding: 'binary'}, function(error, response, imageBody) {
	let screenshotResult = imageBody;

	// and if you want to save it to disk
	fs.writeFileSync('screenshot.png', screenshotResult, 'binary');
});

These special parameters combined allow you to upload your screenshot request directly to Amazon Web Services S3.

These special parameters when used together allow you to log in to a website before taking the screenshot. The username and password are currently added to the resulting screenshot URL in plaintext (except for our NodeJS implementation which encrypts credentials, this will expand to most implementations in the future) so for security reasons we highly recommend that you download the resulting image and host it on your own service while using this feature.

If you are downloading the screenshot directly you may find some of our HTTP response headers useful.

If the website of the screenshot you're taking is temporarily unavailable we will send a 400 HTTP error with a JSON encoded object of the error and not cache the request, allowing you to retry the request. If you're displaying the generated screenshot urls directly on your website we'll periodically keep retrying the request until a valid screenshot is available.