Skip to main content
GET
Capture a screenshot

Authorizations

Authorization
string
header
required

Customer API key from the Scrinly dashboard.

Query Parameters

url
string<uri>
required
Maximum string length: 2048
Pattern: ^https?://
format
enum<string>
default:jpg
Available options:
jpg,
png
quality
integer
default:80
Required range: 1 <= x <= 100
width
integer
default:1920
Required range: 100 <= x <= 3840
height
integer
default:1080
Required range: 100 <= x <= 2160
fullPage
boolean
default:false
theme
enum<string>
default:light
Available options:
light,
dark
design
boolean
default:false
async
boolean
default:false
store
boolean
default:false
timeout
integer
default:30
Required range: 10 <= x <= 60

Response

Raw image bytes, or JSON when storage or design extraction is enabled.

The response is of type string.