{ "openapi": "3.0.1", "info": { "title": "Retool Apify Integration - Run Actors & Return Data", "description": "Run Apify Actors and saved tasks from Retool, pass dynamic JSON input, wait synchronously or start asynchronously, and return normalized run status and dataset results for tables, forms, dashboards, and workflows.", "version": "0.1", "x-build-id": "sQug7efHFZk8bhLDf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/produkdigitalali~retool-apify-workflow-bridge/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-produkdigitalali-retool-apify-workflow-bridge", "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~retool-apify-workflow-bridge/runs": { "post": { "operationId": "runs-sync-produkdigitalali-retool-apify-workflow-bridge", "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~retool-apify-workflow-bridge/run-sync": { "post": { "operationId": "run-sync-produkdigitalali-retool-apify-workflow-bridge", "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": [ "targetType", "targetId" ], "properties": { "targetType": { "title": "Target type", "enum": [ "actor", "task" ], "type": "string", "description": "Run an Actor directly or a saved Actor task.", "default": "actor" }, "targetId": { "title": "Actor or task ID", "minLength": 1, "type": "string", "description": "Actor ID/name such as apify~hello-world, or an Actor task ID/name when targetType=task." }, "targetInput": { "title": "Target JSON input", "type": "object", "description": "JSON input forwarded to the downstream Actor or task.", "default": {} }, "mode": { "title": "Execution mode", "enum": [ "sync", "async" ], "type": "string", "description": "sync waits for completion and can return dataset items; async returns immediately with the new run ID.", "default": "sync" }, "waitTimeoutSeconds": { "title": "Wait timeout (seconds)", "minimum": 1, "maximum": 300, "type": "integer", "description": "Maximum wait in synchronous mode. The bridge polls safely beyond the API's 60-second per-request wait limit.", "default": 60 }, "includeDatasetItems": { "title": "Return dataset items", "type": "boolean", "description": "When a synchronous target succeeds, include items from its default dataset in the normalized result.", "default": true }, "datasetLimit": { "title": "Dataset item limit", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum number of downstream dataset items to return. Set 0 to skip dataset retrieval.", "default": 100 }, "datasetFields": { "title": "Dataset fields", "maxItems": 100, "type": "array", "description": "Optional field whitelist. Leave empty to return all fields.", "items": { "type": "string" }, "default": [] }, "cleanDataset": { "title": "Clean dataset output", "type": "boolean", "description": "Skip hidden and empty fields/items when retrieving downstream dataset results.", "default": true }, "correlationId": { "title": "Correlation ID", "type": "string", "description": "Optional Retool row/workflow identifier copied to the output for async correlation.", "default": "" }, "apifyToken": { "title": "Optional Apify API token", "type": "string", "description": "Usually leave blank: on Apify, the bridge uses the current scoped run token and can call limited-permission Actors. Provide a token only when your private task/target requires it. The value is encrypted and never logged." } } }, "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 } } } } } } } } } }