{ "openapi": "3.0.1", "info": { "title": "Playwright Browser Automation Runner | No-Code JSON Workflows", "description": "Run deterministic Playwright browser workflows from JSON: navigate, click, fill, extract, assert, wait, and screenshot without deploying a Playwright script.", "version": "0.1", "x-build-id": "SWCV5wnZUth7eIXlt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/produkdigitalali~playwright-browser-automation-runner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-produkdigitalali-playwright-browser-automation-runner", "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/produkdigitalali~playwright-browser-automation-runner/runs": { "post": { "operationId": "runs-sync-produkdigitalali-playwright-browser-automation-runner", "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/produkdigitalali~playwright-browser-automation-runner/run-sync": { "post": { "operationId": "run-sync-produkdigitalali-playwright-browser-automation-runner", "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": [ "startUrl", "actions" ], "properties": { "startUrl": { "title": "Start URL", "maxLength": 2048, "type": "string", "description": "Public HTTP(S) URL opened before the first action. Private, loopback, link-local, metadata, reserved, and credential-bearing URLs are rejected." }, "actions": { "title": "Workflow actions", "minItems": 1, "maxItems": 100, "type": "array", "description": "Ordered JSON actions. Supported types: goto, waitForSelector, click, fill, press, selectOption, extractText, extractAttribute, textContains, urlContains, screenshot, wait. Action-specific validation is enforced by the Actor before the browser starts.", "items": { "type": "object", "required": [ "type" ], "additionalProperties": false, "properties": { "type": { "title": "Action type", "description": "Browser operation to perform.", "type": "string", "enum": [ "goto", "waitForSelector", "click", "fill", "press", "selectOption", "extractText", "extractAttribute", "textContains", "urlContains", "screenshot", "wait" ] }, "url": { "title": "URL", "description": "Destination URL for goto.", "type": "string", "maxLength": 2048 }, "locator": { "title": "Locator", "description": "Target locator. by supports css, text, role, label, placeholder, and testId. role may additionally use name.", "type": "object", "editor": "json", "additionalProperties": false, "properties": { "by": { "title": "Locator strategy", "description": "How Playwright should locate the element.", "type": "string", "enum": [ "css", "text", "role", "label", "placeholder", "testId" ] }, "value": { "title": "Locator value", "description": "CSS selector, text, ARIA role, label, placeholder, or test id.", "type": "string", "maxLength": 4096 }, "name": { "title": "Accessible name", "description": "Optional accessible name when using role locator.", "type": "string", "maxLength": 1024 }, "exact": { "title": "Exact match", "description": "Use an exact text/name match where supported.", "type": "boolean" }, "index": { "title": "Match index", "description": "Optional zero-based match index when multiple elements intentionally match.", "type": "integer", "minimum": 0, "maximum": 999 } }, "required": [ "by", "value" ] }, "value": { "title": "Value", "description": "Text to fill, or a single select option value.", "type": "string", "maxLength": 200000 }, "values": { "title": "Values", "description": "Multiple select option values.", "type": "array", "editor": "stringList", "maxItems": 100, "items": { "type": "string", "maxLength": 4096 } }, "key": { "title": "Key", "description": "Keyboard key/chord for press, for example Enter or Control+A.", "type": "string", "maxLength": 128 }, "attribute": { "title": "Attribute", "description": "HTML attribute name for extractAttribute.", "type": "string", "maxLength": 256 }, "expected": { "title": "Expected text", "description": "Expected substring for textContains or urlContains.", "type": "string", "maxLength": 200000 }, "state": { "title": "Wait state", "description": "Element state for waitForSelector.", "type": "string", "enum": [ "attached", "detached", "visible", "hidden" ] }, "waitUntil": { "title": "Navigation wait condition", "description": "Navigation completion condition for goto.", "type": "string", "enum": [ "load", "domcontentloaded", "networkidle", "commit" ] }, "timeoutMs": { "title": "Action timeout", "description": "Optional timeout override for this action in milliseconds.", "type": "integer", "minimum": 100, "maximum": 60000 }, "durationMs": { "title": "Wait duration", "description": "Milliseconds for wait action.", "type": "integer", "minimum": 0, "maximum": 30000 }, "fullPage": { "title": "Full-page screenshot", "description": "Capture the entire scrollable page.", "type": "boolean" }, "name": { "title": "Artifact name", "description": "Optional safe screenshot artifact name.", "type": "string", "maxLength": 80 } } } }, "stopOnError": { "title": "Stop on error", "type": "boolean", "description": "Stop the workflow after the first failed action. Disable to continue and record later step results.", "default": true }, "actionTimeoutMs": { "title": "Default action timeout", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "Default per-action timeout in milliseconds.", "default": 15000 }, "navigationTimeoutMs": { "title": "Navigation timeout", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "Default timeout for startUrl and goto navigation in milliseconds.", "default": 30000 }, "maxRunSeconds": { "title": "Maximum workflow runtime", "minimum": 10, "maximum": 180, "type": "integer", "description": "Hard workflow budget in seconds, excluding a small amount of Actor startup/shutdown overhead.", "default": 120 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy or custom HTTP(S) proxy. The Actor keeps its own public-destination checks in front of the upstream proxy." } } }, "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 } } } } } } } } } }