Post API

Post API

Post options to the screenshot API

You can also POST options to the API and get a result asynchronously.


The POST endpoint uses HTTP Basic authentication. Pass your secret key as the username.


The endpoint for POSTing options to the API is:

Required Options

The endpoint accepts the same API options as the GET endpoints. Options can be specified in either camelCase or snake_case. The only required options are either a url or a html payload. Options can be sent as JSON or formdata

urlStringThe fully qualified URL to a public webpage. Such as When passed this will override the html param and will generate a screenshot of the url.
htmlStringThis is the HTML you want to render. You can send an HTML snippet (<div>Your content</div>) or an entire webpage.



curl -