Capture a screenshot - Scrinly API

curl --request POST \
  --url https://api.scrinly.com/render/screenshot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com",
  "fullPage": true,
  "store": true,
  "storage_path": "screenshots"
}
'

"<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
  }
}

POST

/

render

/

screenshot

curl --request POST \
  --url https://api.scrinly.com/render/screenshot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com",
  "fullPage": true,
  "store": true,
  "storage_path": "screenshots"
}
'

"<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

Body

application/json

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 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

Available options:

load,

domcontentloaded,

networkidle0,

networkidle2

blockAds

boolean

blockChatWidgets

boolean

blockPopups

boolean

blockAccessibilityWidgets

boolean

hideSelectors

string[]

clickSelectors

string[]

scrollToElement

string

headers

object

write-only

Show child attributes

cookies

object[]

write-only

Show child attributes

store

boolean

default:false

storage_path

string

storage_provider

enum<string>

Available options:

b2,

s3,

r2

storage_bucket

string

storage_endpoint

string<uri>

write-only

storage_region

string

storage_access_key_id

string

write-only

storage_secret_access_key

string

write-only

storage_application_key_id

string

write-only

storage_application_key

string

write-only

storage_public_domain

string<uri>

storage_return_location

boolean

default:false

regions

boolean

default:false

design

boolean

default:false

Advanced raw observed design evidence.

styleGuide

default:false

regenerate

boolean

default:false

Requires Style Guide; bypasses only its AI cache.

cache

boolean

default:false

async

boolean

default:false

webhookUrl

string<uri>

webhookSecret

string

write-only

priority

enum<string>

default:normal

Available options:

low,

normal,

high

Response

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

The response is of type string.