Screenshot Visual Diff
Pricing
from $4.00 / 1,000 completed comparisons
Capture public pages or compare existing PNG/JPEG images with deterministic changed-pixel metrics and red-highlighted visual diff images.
You can access the Screenshot Visual Diff programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "0.0", "x-build-id": "K38mGgNfBQQHoaCEk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/poyraz_demir~screenshot-visual-diff/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-poyraz_demir-screenshot-visual-diff", "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/poyraz_demir~screenshot-visual-diff/runs": { "post": { "operationId": "runs-sync-poyraz_demir-screenshot-visual-diff", "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/poyraz_demir~screenshot-visual-diff/run-sync": { "post": { "operationId": "run-sync-poyraz_demir-screenshot-visual-diff", "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": [ "comparisons" ], "properties": { "comparisons": { "title": "Image comparisons", "minItems": 1, "maxItems": 10, "type": "array", "description": "One to ten baseline/current pairs. Each image contains base64 data and a filename, or a public HTTP/HTTPS URL.", "items": { "type": "object", "properties": { "baseline": { "title": "Baseline image", "description": "Reference PNG/JPEG image or public page to capture.", "type": "object", "properties": { "base64": { "title": "Base64 PNG/JPEG", "description": "Base64-encoded baseline image bytes; use this instead of url.", "type": "string", "minLength": 1, "maxLength": 26666668 }, "url": { "title": "Public page URL", "description": "Public HTTP/HTTPS page to capture as baseline; use this instead of base64.", "type": "string", "minLength": 1 }, "filename": { "title": "Filename", "description": "Baseline filename used as an output label for base64.", "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false }, "current": { "title": "Current image", "description": "New PNG/JPEG image or public page to capture.", "type": "object", "properties": { "base64": { "title": "Base64 PNG/JPEG", "description": "Base64-encoded current image bytes; use this instead of url.", "type": "string", "minLength": 1, "maxLength": 26666668 }, "url": { "title": "Public page URL", "description": "Public HTTP/HTTPS page to capture as current; use this instead of base64.", "type": "string", "minLength": 1 }, "filename": { "title": "Filename", "description": "Current filename used as an output label for base64.", "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false } }, "required": [ "baseline", "current" ], "additionalProperties": false } }, "maxBytes": { "title": "Maximum image size after decoding (bytes)", "minimum": 1, "maximum": 20000000, "type": "integer", "description": "Limit applied to each base64 image and browser screenshot.", "default": 20000000 }, "maxPixels": { "title": "Maximum pixels per image", "minimum": 1, "maximum": 4000000, "type": "integer", "description": "Reject an image whose width times height exceeds this limit before pixel loading.", "default": 4000000 }, "timeoutSecs": { "title": "Total capture timeout per page (seconds)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Shared budget for navigation, optional wait and viewport screenshot.", "default": 30 }, "viewportWidth": { "title": "Viewport width", "minimum": 320, "maximum": 4096, "type": "integer", "description": "Browser viewport width in pixels; width times height must not exceed 4 million.", "default": 1280 }, "viewportHeight": { "title": "Viewport height", "minimum": 240, "maximum": 4096, "type": "integer", "description": "Browser viewport height in pixels; width times height must not exceed 4 million.", "default": 720 }, "waitMs": { "title": "Additional wait after page load (milliseconds)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Optional delay before taking the screenshot, within the total capture deadline.", "default": 0 }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Check robots rules for each document navigation, including redirects.", "default": true }, "pixelThreshold": { "title": "Per-channel pixel threshold", "minimum": 0, "maximum": 255, "type": "integer", "description": "A pixel changes when the largest RGB channel difference is strictly greater than this value.", "default": 16 }, "maxDiffRatio": { "title": "Maximum allowed changed-pixel ratio", "minimum": 0, "maximum": 1, "type": "number", "description": "FAIL when changedPixels / totalPixels is strictly greater than this value.", "default": 0.001 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Screenshot Visual Diff from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: