Skip to content
← Retour à l’index API
POST /batch/create

Create batch screenshot job

Options

Les options sont regroupées pour faciliter la lecture, sur le modèle d’une documentation centrée sur les paramètres.

Essential

browser

body enum(chrome, firefox, brave) Facultatif

Exemple : chrome

Browser to use for screenshot (chrome, firefox, or brave)

country

body string Facultatif

Exemple : us

ISO country code. Defaults to "us" when omitted.

Two-letter country code for routing the browser through a target country. Use this when validating localization, legal notices, pricing, and geo-specific rendering.

delay

body integer Facultatif

Exemple : 5

Aucune description dans la spécification OpenAPI.

hide_ads

body boolean Facultatif

Exemple : false

Aucune description dans la spécification OpenAPI.

Enable ad filtering for cleaner captures and visual diffs. On some browser targets, behavior may vary depending on native filtering support.

hide_popups

body boolean Facultatif

Exemple : false

Aucune description dans la spécification OpenAPI.

Attempt to hide cookie banners and popup overlays before capture so outputs focus on page content.

screen_height

body integer Facultatif

Exemple : 1280

Aucune description dans la spécification OpenAPI.

screen_width

body integer Facultatif

Exemple : 1024

Aucune description dans la spécification OpenAPI.

size

body enum(screen, page) Facultatif

Exemple : screen

Aucune description dans la spécification OpenAPI.

Request

cookie

body string Facultatif

Aucune description dans la spécification OpenAPI.

header

body string Facultatif

Custom HTTP header(s)

post_data

body string Facultatif

Aucune description dans la spécification OpenAPI.

referer

body string Facultatif

Aucune description dans la spécification OpenAPI.

Page

max_wait

body integer Facultatif

Exemple : 0

Aucune description dans la spécification OpenAPI.

script

body string Facultatif

Aucune description dans la spécification OpenAPI.

trackers

body string Facultatif

JSON-encoded trackers array

Browser

dark

body boolean Facultatif

Exemple : false

Aucune description dans la spécification OpenAPI.

strict_ssl

body boolean Facultatif

Exemple : true

Aucune description dans la spécification OpenAPI.

Automation

steps

body string Facultatif

JSON-encoded steps array

Screenshot

cache

body integer Facultatif

Exemple : 86400

Cache duration in seconds

shot_interval

body integer Facultatif

Exemple : 0

Aucune description dans la spécification OpenAPI.

shots

body integer Facultatif

Exemple : 1

Aucune description dans la spécification OpenAPI.

target

body string Facultatif

CSS selector to capture an element

CSS selector of the element to capture. If provided, capture is scoped to the matched element instead of the full viewport/page.

App

apps

body integer[] Facultatif

App configuration IDs to run after each screenshot is finished

file

body string Obligatoire

Text file with one URL per line

filename_template

body string Facultatif

Exemple : {domain}/{yyyy}{mm}{dd}-{id}.png

Template for output filenames inside the ZIP archive. Supports variables: {id}, {domain}, {shot}, {browser}, {country}, {yyyy}, {mm}, {dd}, {date}, {random}, {tags}, {url}. If {id} is absent, it is injected automatically to guarantee unique filenames. The filename column in the CSV/TSV file overrides this template per row.

name

body string Facultatif

Batch name for reference

Output & Format

html

body boolean Facultatif

Exemple : false

Aucune description dans la spécification OpenAPI.

Geolocation

geo_enable

body boolean Facultatif

Exemple : false

Enable geolocation emulation

geo_latitude

body number Facultatif

Override latitude for geolocation

geo_longitude

body number Facultatif

Override longitude for geolocation

language

body string Facultatif

Override language/locale (e.g., en-US)

timezone

body string Facultatif

Override timezone (e.g., America/New_York)

Device

device_landscape

body boolean Facultatif

Use landscape orientation

device_mobile

body boolean Facultatif

Enable mobile emulation

device_name

body string Facultatif

Device name to emulate (e.g., iphone_15_pro)

device_scale

body number Facultatif

Device scale factor

device_touch

body boolean Facultatif

Enable touch input

PDF Options

pdf

body boolean Facultatif

Exemple : false

Aucune description dans la spécification OpenAPI.

pdf_background

body boolean Facultatif

Exemple : false

Aucune description dans la spécification OpenAPI.

pdf_format

body enum(a4, letter, legal) Facultatif

Exemple : letter

Aucune description dans la spécification OpenAPI.

pdf_landscape

body boolean Facultatif

Exemple : false

Aucune description dans la spécification OpenAPI.

pdf_margin

body string Facultatif

Exemple : 0px

Aucune description dans la spécification OpenAPI.

pdf_margin_bottom

body string Facultatif

Exemple : 0px

Aucune description dans la spécification OpenAPI.

pdf_margin_left

body string Facultatif

Exemple : 0px

Aucune description dans la spécification OpenAPI.

pdf_margin_right

body string Facultatif

Exemple : 0px

Aucune description dans la spécification OpenAPI.

pdf_margin_top

body string Facultatif

Exemple : 0px

Aucune description dans la spécification OpenAPI.

pdf_one_page

body boolean Facultatif

Exemple : false

Aucune description dans la spécification OpenAPI.

Réponses

200

Batch created

▾ 
{
  "success": true,
  "data": [
    {
      "id": 98765,
      "status": "processing",
      "count": 150,
      "processed": 0,
      "failed": 0,
      "error": ""
    }
  ]
}
400

Invalid request

▾ 
{
  "error": "Request validation failed",
  "code": "VALIDATION_ERROR",
  "fields": {
    "url": [
      "URL is required"
    ],
    "country": [
      "Country code must be ISO 3166-1 alpha-2"
    ]
  }
}
401

Unauthorized

▾ 
{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}
403

Insufficient balance

▾ 
{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}
413

File too large

▾ 
{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}
500

Server error

▾ 
{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}