{ "openapi": "3.0.1", "info": { "title": "OpenAI Web Automation", "description": "Controls a real browser with an OpenAI model to interact with web pages and extract structured data — no CSS selectors or page-specific scraping code required.", "version": "0.0", "x-build-id": "kl3pq10z3ctb2jLmD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dtrungtin~openai-web-automation/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dtrungtin-openai-web-automation", "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/dtrungtin~openai-web-automation/runs": { "post": { "operationId": "runs-sync-dtrungtin-openai-web-automation", "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/dtrungtin~openai-web-automation/run-sync": { "post": { "operationId": "run-sync-dtrungtin-openai-web-automation", "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": [ "startUrls", "prompt", "expectedOutput" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "One or more web pages the browser will open before the AI agent begins interacting. Add multiple URLs to run the same task on several pages in sequence.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "prompt": { "title": "Interaction Prompt", "type": "string", "description": "Instructions for what the AI agent should do on the page — e.g. search for a product, fill a form, or click through a checkout flow. The browser is already open; do not include navigation steps like 'go to URL'.", "default": "Search by keyword 'xiaomi' and click on the first item in search results. Close any popup if it appears." }, "expectedOutput": { "title": "Data to Extract", "type": "string", "description": "Describe the data you want extracted from the final page state. The AI will read the screenshot and page HTML, then return this data as JSON. Example: 'Extract the product title, price, and stock status.'", "default": "Extract the title, price and condition of the eBay item." }, "outputSchema": { "title": "Output Schema (Zod)", "type": "string", "description": "Optional. A JavaScript function that receives the Zod library (`z`) and returns a Zod schema. When provided, the extracted JSON will be validated and shaped to match the schema. Leave as `(z) => null` to use free-form JSON output. See https://zod.dev/ for schema syntax." }, "maxSteps": { "title": "Max Interaction Steps", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of browser actions (clicks, typing, scrolling, etc.) the AI agent may perform before stopping. Increase for complex multi-step tasks; decrease to limit cost.", "default": 10 }, "countryCode": { "title": "Proxy Country", "enum": [ "US", "DE", "VN", "FR", "GB" ], "type": "string", "description": "Country for the residential proxy exit node. Use this when the target site serves different content by region.", "default": "US" }, "loginCookies": { "title": "Cookies", "type": "array", "description": "If you want to sign in to the web page so that you will have access to more data than with an anonymous profile, but do not wish to save your credentials in input, then you can use your cookies." } } }, "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 } } } } } } } } } }