{ "openapi": "3.0.1", "info": { "title": "Screenshotone", "description": "ScreenshotOne is a fast, developer- and marketer-friendly tool for high-quality website screenshots with device emulation. Capture accurate desktop and mobile views via API—perfect for testing, previews, marketing, and automated workflows.", "version": "1.0", "x-build-id": "41ntOj6nalncd8Hab" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/appunitsai~screenshotone/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-appunitsai-screenshotone", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/appunitsai~screenshotone/runs": { "post": { "operationId": "runs-sync-appunitsai-screenshotone", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/appunitsai~screenshotone/run-sync": { "post": { "operationId": "run-sync-appunitsai-screenshotone", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "accessKey", "secretKey", "url" ], "properties": { "accessKey": { "title": "Access Key", "type": "string", "description": "Access key for ScreenshotOne API, You can find it on the access page (https://dash.screenshotone.com/access)." }, "secretKey": { "title": "Secret Key", "type": "string", "description": "Secret key for ScreenshotOne API, You can find it on the access page (https://dash.screenshotone.com/access)." }, "url": { "title": "URL", "pattern": "^https?:\\/\\/.+$", "type": "string", "description": "The URL of the webpage to capture a screenshot of." }, "type": { "title": "Screenshot Type", "enum": [ "NORMAL", "ANIMATED" ], "type": "string", "description": "Type of screenshot to generate.", "default": "NORMAL" }, "format": { "title": "Screenshot Format", "enum": [ "png", "jpg", "webp", "gif", "jp2", "tiff", "avif", "heif", "pdf", "html", "markdown" ], "type": "string", "description": "The format of the screenshot.", "default": "jpg" }, "fullPage": { "title": "Full Page", "type": "boolean", "description": "Capture the full page screenshot.", "default": false }, "blockElements": { "title": "Block Elements", "type": "boolean", "description": "Block ads, trackers, banners and other elements.", "default": true }, "device": { "title": "Device", "enum": [ "", "blackberry_playbook", "blackberry_playbook_landscape", "blackberry_z30", "blackberry_z30_landscape", "galaxy_note_3", "galaxy_note_3_landscape", "galaxy_note_ii", "galaxy_note_ii_landscape", "galaxy_s_iii", "galaxy_s_iii_landscape", "galaxy_s5", "galaxy_s5_landscape", "galaxy_s8", "galaxy_s8_landscape", "galaxy_s9+", "galaxy_s9+_landscape", "galaxy_tab_s4", "galaxy_tab_s4_landscape", "ipad", "ipad_landscape", "ipad_gen_6", "ipad_gen_6_landscape", "ipad_gen_7", "ipad_gen_7_landscape", "ipad_mini", "ipad_mini_landscape", "ipad_pro", "ipad_pro_landscape", "ipad_pro_11", "ipad_pro_11_landscape", "iphone_4", "iphone_4_landscape", "iphone_5", "iphone_5_landscape", "iphone_6", "iphone_6_landscape", "iphone_6_plus", "iphone_6_plus_landscape", "iphone_7", "iphone_7_landscape", "iphone_7_plus", "iphone_7_plus_landscape", "iphone_8", "iphone_8_landscape", "iphone_8_plus", "iphone_8_plus_landscape", "iphone_se", "iphone_se_landscape", "iphone_x", "iphone_x_landscape", "iphone_xr", "iphone_xr_landscape", "iphone_11", "iphone_11_landscape", "iphone_11_pro", "iphone_11_pro_landscape", "iphone_11_pro_max", "iphone_11_pro_max_landscape", "iphone_12", "iphone_12_landscape", "iphone_12_pro", "iphone_12_pro_landscape", "iphone_12_pro_max", "iphone_12_pro_max_landscape", "iphone_12_mini", "iphone_12_mini_landscape", "iphone_13", "iphone_13_landscape", "iphone_13_pro", "iphone_13_pro_landscape", "iphone_13_pro_max", "iphone_13_pro_max_landscape", "iphone_13_mini", "iphone_13_mini_landscape", "iphone_14", "iphone_14_landscape", "iphone_14_plus", "iphone_14_plus_landscape", "iphone_14_pro", "iphone_14_pro_landscape", "iphone_14_pro_max", "iphone_14_pro_max_landscape", "iphone_15", "iphone_15_landscape", "iphone_15_plus", "iphone_15_plus_landscape", "iphone_15_pro", "iphone_15_pro_landscape", "iphone_15_pro_max", "iphone_15_pro_max_landscape", "iphone_16", "iphone_16_landscape", "iphone_16_plus", "iphone_16_plus_landscape", "jiophone_2", "jiophone_2_landscape", "kindle_fire_hdx", "kindle_fire_hdx_landscape", "lg_optimus_l70", "lg_optimus_l70_landscape", "microsoft_lumia_550", "microsoft_lumia_950", "microsoft_lumia_950_landscape", "nexus_10", "nexus_10_landscape", "nexus_4", "nexus_4_landscape", "nexus_5", "nexus_5_landscape", "nexus_5x", "nexus_5x_landscape", "nexus_6", "nexus_6_landscape", "nexus_6p", "nexus_6p_landscape", "nexus_7", "nexus_7_landscape", "nokia_lumia_520", "nokia_lumia_520_landscape", "nokia_n9", "nokia_n9_landscape", "pixel_2", "pixel_2_landscape", "pixel_2_xl", "pixel_2_xl_landscape", "pixel_3", "pixel_3_landscape", "pixel_4", "pixel_4_landscape", "pixel_4a_5g", "pixel_4a_5g_landscape", "pixel_5", "pixel_5_landscape", "moto_g4", "moto_g4_landscape" ], "type": "string", "description": "The device to use for the screenshot.", "default": "" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }