New to Corsair? See API access, authentication, and error handling.
Devices
list
devices.list
List device presets. User agent strings are not stored.
Risk: read
devices full type
devices full type
Shots
animate
shots.animate
Record a page as a video or GIF (default or scroll scenario). Returns a link to the file. Spends a request from the plan.
Risk: write
GET /animate with response_type=json. scenario is default or scroll, duration 1-30 s, format mp4, mov, avi, webm or gif. Returns screenshotUrl.
Output
bulk
shots.bulk
Build up to 20 screenshot requests at once; with execute true they run now (one plan request each) and each url gets its status.
Risk: write
POST /bulk. options apply to every url. Returns the /take url built for each request with access_key removed; with execute true (default false) the requests run now and results gives each one’s status.
options full type
options full type
results full type
results full type
take
shots.take
Screenshot a url, HTML or Markdown as an image or PDF, with viewport, device, full page, selector, blocking and caching options. Returns a link to the file. Spends a request from the plan.
Risk: write
POST /take with a JSON body and response_type=json, so long html or markdown fits. Pass exactly one of url, html or markdown. Options include format (png, jpg, webp, pdf and more), full_page, selector, viewport_width/height, viewport_device (an id from devices.list), delay, wait_until, the block_* switches, dark_mode and cache/cache_ttl. Returns screenshotUrl, and cacheUrl when cache is true. The target URL is not stored.
Output
Usage
get
usage.get
Read the current plan usage and request bucket.
Risk: read
usage full type
usage full type