aiapi.me
Screenshot Documentation
Getting Started

To create a screenshot, send a GET request with the desired url as query parameter to this api endpoint.

https://aiapi.me/api/v1/screenshot

For instance, to take a full page screenshot of aiapi.me, one can use curl to send a GET request

curl https://aiapi.me/api/v1/screenshot?url=aiapi.me&full_page=true
API Parameters
Parameter
Type
Default
Description
url
string
The url of the website.
full_page
boolean
false
If true, a screenshot of the entire webpage will be taken.
clip_x*
boolean
false
clip_x, clip_y, clip_width, clip_height together define the boundary of an area of interest, a screenshot of this area of interest will be taken. * all four parameters must be present at the same time to take a partial screenshot.
clip_y*
integer
clip_width*
integer
clip_height*
integer
width
int
1440
Browser width in pixels.
height
int
900
Browser height in pixels.
block_cookie_banner
boolean
true
If true, cookie banners will be dismissed before a screenshot is taken.
lazy_load
boolean
false
Some websites perform lazy loads of images and other contents, set lazy_load to true to ensure all content are loaded.
retina
boolean
false
If true, the screenshot will have the highest resolution.
output
string
json
Can be set to json or image. if set to image, raw image data of the screenshot will be returned.
delay
interger
0
Delay X milliseconds before taking the screenshot.