Capture a screenshot

curl --request GET \
  --url https://api.scrinly.com/render/screenshot \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.scrinly.com/render/screenshot', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scrinly.com/render/screenshot",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scrinly.com/render/screenshot"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.scrinly.com/render/screenshot")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "success": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "statusUrl": "<string>",
  "type": "screenshot",
  "message": "<string>",
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

Screenshots

Capture a screenshot

Returns JPEG or PNG bytes unless storage, regions, asynchronous delivery, or Visual Style Guide requires a JSON result.

Every option that fits in a URL is available here. These are POST-body only and are refused with 400 in a query string, because URLs are recorded in logs, browser history and caches: headers, cookies, webhookSecret, and customer-storage credentials (storage_access_key_id, storage_secret_access_key, storage_application_key_id, storage_application_key). Customer-storage destinations (storage_provider, storage_bucket, storage_endpoint, storage_region, storage_public_domain) need those credentials, so use POST for them too.

GET

render

screenshot

Capture a screenshot

curl --request GET \
  --url https://api.scrinly.com/render/screenshot \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.scrinly.com/render/screenshot', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scrinly.com/render/screenshot",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scrinly.com/render/screenshot"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.scrinly.com/render/screenshot")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "success": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "statusUrl": "<string>",
  "type": "screenshot",
  "message": "<string>",
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

{
  "success": false,
  "error": "<string>",
  "type": "<string>",
  "code": "<string>",
  "retryable": true,
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Scrinly-Provider-API-Key

string

write-only

Ephemeral OpenAI BYOK for Visual Style Guide. Server-to-server and synchronous only.

Maximum string length: 1024

Query Parameters

url

string<uri>

required

Pattern: ^https?://

format

enum<string>

default:jpg

Available options:

jpg,

png

quality

integer

default:80

Required range: 1 <= x <= 100

width

integer

default:1280

Required range: 320 <= x <= 3840

height

integer

default:720

Required range: 240 <= x <= 2160

device

string

Server-supported device preset; overrides width and height.

fullPage

boolean

default:false

theme

enum<string>

default:light

Available options:

light,

dark

timeout

integer

default:30

Required range: 10 <= x <= 60

waitUntil

enum<string>

default:load

Navigation readiness strategy. Network-idle modes are opt-in for pages that eventually become quiet.

Available options:

load,

domcontentloaded,

networkidle0,

networkidle2

Hide common cookie-consent banners before capture.

blockAds

boolean

default:true

Block common ad networks and hide ad slots.

blockChatWidgets

boolean

default:false

Hide third-party chat and support widgets.

blockPopups

boolean

default:false

Hide newsletter and promotional popups.

blockAccessibilityWidgets

boolean

default:false

Hide floating accessibility-overlay launchers.

hideSelectors

string

Comma-separated CSS selectors to hide before capture, e.g. .promo,#chat. Commas inside (), [] or quotes do not split. The POST body takes an array.

clickSelectors

string

Comma-separated CSS selectors to click, in order, before capture. Same splitting rules as hideSelectors.

scrollToElement

string

CSS selector to scroll into view before capture.

store

boolean

default:false

storage_path

string

regions

boolean

default:false

Adds ordered full-page crops and two credits; implies full-page storage.

styleGuide

boolean

default:false

Adds a GPT-5.6 Luna Visual Style Guide; implies regions and stored full-page capture.

regenerate

boolean

default:false

Bypasses only the seven-day Style Guide cache. Requires styleGuide=true.

cache

boolean

default:false

async

boolean

default:false

design

boolean

default:false

Add raw observed design evidence (colors, fonts, spacing) to the JSON result. One credit.

webhookUrl

string<uri>

Deliver the result to this URL; implies async=true. Send webhookSecret in a POST body to sign deliveries.

priority

enum<string>

default:normal

Queue priority for asynchronous jobs.

Available options:

low,

normal,

high

storage_return_location

boolean

default:false

Include the provider location of the stored object in media.

Response

Binary or JSON screenshot result. JSON may be partial when an add-on failed.

The response is of type string.

Overview

Endpoints

Capture a screenshot

Authorizations

Headers

Query Parameters

Response