Transform a stored screenshot (URL form)

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

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

fetch('https://api.scrinly.com/render/screenshot/{id}/transform', 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/{id}/transform",
  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/{id}/transform"

	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/{id}/transform")

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

{
  "success": true,
  "type": "transform",
  "assetId": "<string>",
  "screenshotId": "<string>",
  "source": {
    "type": "screenshot",
    "bounds": {
      "x": 1,
      "y": 1,
      "width": 16384,
      "height": 16384
    },
    "regionId": "<string>",
    "partId": "<string>"
  },
  "executedPlan": [
    {}
  ],
  "provenance": {
    "sourceSha256": "<string>",
    "sourceBounds": {
      "x": 1,
      "y": 1,
      "width": 16384,
      "height": 16384
    },
    "outputSha256": "<string>",
    "engine": {
      "backend": "browser-v1",
      "version": "screenshot-transform-v1",
      "browser": "<string>",
      "codec": "canvas-2d-v1"
    },
    "sourceKind": "stored-part",
    "parentScreenshotSha256": "<string>",
    "sourceCoordinateSpace": "screenshot",
    "operationCoordinateSpace": "stored-part"
  },
  "media": {
    "stored": true,
    "url": "<string>",
    "contentType": "image/jpeg",
    "width": 123,
    "height": 123,
    "bytes": 123,
    "sha256": "<string>",
    "key": "<string>",
    "location": "<string>"
  },
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  },
  "referenceExpiresAt": "2023-11-07T05:31:56Z",
  "cacheHit": true
}

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

{
  "success": true,
  "type": "transform",
  "screenshotId": "<string>",
  "results": [
    {
      "success": true,
      "type": "transform",
      "assetId": "<string>",
      "screenshotId": "<string>",
      "source": {
        "type": "screenshot",
        "bounds": {
          "x": 1,
          "y": 1,
          "width": 16384,
          "height": 16384
        },
        "regionId": "<string>",
        "partId": "<string>"
      },
      "executedPlan": [
        {}
      ],
      "provenance": {
        "sourceSha256": "<string>",
        "sourceBounds": {
          "x": 1,
          "y": 1,
          "width": 16384,
          "height": 16384
        },
        "outputSha256": "<string>",
        "engine": {
          "backend": "browser-v1",
          "version": "screenshot-transform-v1",
          "browser": "<string>",
          "codec": "canvas-2d-v1"
        },
        "sourceKind": "stored-part",
        "parentScreenshotSha256": "<string>",
        "sourceCoordinateSpace": "screenshot",
        "operationCoordinateSpace": "stored-part"
      },
      "media": {
        "stored": true,
        "url": "<string>",
        "contentType": "image/jpeg",
        "width": 123,
        "height": 123,
        "bytes": 123,
        "sha256": "<string>",
        "key": "<string>",
        "location": "<string>"
      },
      "credits": {
        "charged": 1,
        "refunded": 1,
        "net": 1
      },
      "referenceExpiresAt": "2023-11-07T05:31:56Z",
      "cacheHit": true,
      "index": 7
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  },
  "error": "<string>",
  "code": "<string>",
  "retryable": true
}

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

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

GET

render

screenshot

{id}

transform

Transform a stored screenshot (URL form)

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

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

fetch('https://api.scrinly.com/render/screenshot/{id}/transform', 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/{id}/transform",
  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/{id}/transform"

	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/{id}/transform")

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

{
  "success": true,
  "type": "transform",
  "assetId": "<string>",
  "screenshotId": "<string>",
  "source": {
    "type": "screenshot",
    "bounds": {
      "x": 1,
      "y": 1,
      "width": 16384,
      "height": 16384
    },
    "regionId": "<string>",
    "partId": "<string>"
  },
  "executedPlan": [
    {}
  ],
  "provenance": {
    "sourceSha256": "<string>",
    "sourceBounds": {
      "x": 1,
      "y": 1,
      "width": 16384,
      "height": 16384
    },
    "outputSha256": "<string>",
    "engine": {
      "backend": "browser-v1",
      "version": "screenshot-transform-v1",
      "browser": "<string>",
      "codec": "canvas-2d-v1"
    },
    "sourceKind": "stored-part",
    "parentScreenshotSha256": "<string>",
    "sourceCoordinateSpace": "screenshot",
    "operationCoordinateSpace": "stored-part"
  },
  "media": {
    "stored": true,
    "url": "<string>",
    "contentType": "image/jpeg",
    "width": 123,
    "height": 123,
    "bytes": 123,
    "sha256": "<string>",
    "key": "<string>",
    "location": "<string>"
  },
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  },
  "referenceExpiresAt": "2023-11-07T05:31:56Z",
  "cacheHit": true
}

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

{
  "success": true,
  "type": "transform",
  "screenshotId": "<string>",
  "results": [
    {
      "success": true,
      "type": "transform",
      "assetId": "<string>",
      "screenshotId": "<string>",
      "source": {
        "type": "screenshot",
        "bounds": {
          "x": 1,
          "y": 1,
          "width": 16384,
          "height": 16384
        },
        "regionId": "<string>",
        "partId": "<string>"
      },
      "executedPlan": [
        {}
      ],
      "provenance": {
        "sourceSha256": "<string>",
        "sourceBounds": {
          "x": 1,
          "y": 1,
          "width": 16384,
          "height": 16384
        },
        "outputSha256": "<string>",
        "engine": {
          "backend": "browser-v1",
          "version": "screenshot-transform-v1",
          "browser": "<string>",
          "codec": "canvas-2d-v1"
        },
        "sourceKind": "stored-part",
        "parentScreenshotSha256": "<string>",
        "sourceCoordinateSpace": "screenshot",
        "operationCoordinateSpace": "stored-part"
      },
      "media": {
        "stored": true,
        "url": "<string>",
        "contentType": "image/jpeg",
        "width": 123,
        "height": 123,
        "bytes": 123,
        "sha256": "<string>",
        "key": "<string>",
        "location": "<string>"
      },
      "credits": {
        "charged": 1,
        "refunded": 1,
        "net": 1
      },
      "referenceExpiresAt": "2023-11-07T05:31:56Z",
      "cacheHit": true,
      "index": 7
    }
  ],
  "credits": {
    "charged": 1,
    "refunded": 1,
    "net": 1
  },
  "error": "<string>",
  "code": "<string>",
  "retryable": true
}

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

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

Path Parameters

string

required

An unexpired screenshotId belonging to the authenticated account.

Pattern: ^scr_

Query Parameters

preset

enum<string>

Named output shape: og-image, twitter-card, thumbnail, square, full-width. Named output shape. Explicit fields override it.

preset	size	fit	format
`og-image`	1200 × 630	cover	webp 80
`twitter-card`	1200 × 600	cover	webp 80
`thumbnail`	400 wide	contain	webp 75
`square`	1080 × 1080	cover	jpeg 85
`full-width`	1920 wide	contain	webp 80

On a whole full-page screenshot, the fixed-shape presets (og-image, twitter-card, square) take the top of the page at their aspect ratio. Set region, bounds or fit to choose differently.

Available options:

og-image,

twitter-card,

thumbnail,

square,

full-width

region

string

Cut this saved region (e.g. region-1) from the screenshot. Requires a capture with regions=true.

part

string

With region: part id or index (0 = first).

savedCrop

boolean

default:false

With region + part: use the stored crop file instead of cutting original pixels. Use it for pages whose whole screenshot exceeds 64 MP or 24 MiB.

bounds

string

x,y,width,height in screenshot pixels.

Pattern: ^\d+,\d+,\d+,\d+$

width

integer

Output width. Give one side to keep the aspect ratio.

Required range: 1 <= x <= 32768

height

integer

Output height.

Required range: 1 <= x <= 32768

fit

enum<string>

How to fit both sides: contain may pad, cover may crop, fill may stretch. Default contain.

Available options:

contain,

cover,

fill

background

string

Padding / transparency fill for contain and JPEG.

Pattern: ^#[0-9a-fA-F]{6}$

format

enum<string>

Output encoding. Default: same family as the source.

Available options:

jpeg,

png,

webp

quality

integer

Lossy quality. Default 80 (or the preset's).

Required range: 1 <= x <= 100

cache

boolean

default:true

Reuse an identical stored output (refunded). Defaults to true on GET.

async

boolean

default:false

Return 202 and a status URL instead of waiting.

webhookUrl

string<uri>

Deliver the result here; implies async.

Response

All outputs completed

Option 1
Option 2

success

any

required

type

any

required

assetId

string

required

Pattern: ^ast_

screenshotId

string

required

Pattern: ^scr_

source

object

required

Show child attributes

executedPlan

object[]

required

Ordered crop/resize and optional encoding. Format may occur once, last. Otherwise retain source format, lossy quality 80.

Required array length: 1 - 4 elements

provenance

object

required

Show child attributes

media

object

required

Show child attributes

credits

object

required

Show child attributes

referenceExpiresAt

string<date-time>

required

cacheHit

boolean

required

Overview

Endpoints

Transform a stored screenshot (URL form)

Authorizations

Path Parameters

Query Parameters

Response