{ "openapi": "3.0.1", "info": { "title": "Actor Pipeline Runner (Chain Actors in One Run)", "description": "Runs a chain of Apify Actors in one call, handing each step the dataset the previous step produced. Returns every step's run ID, status, dataset and row count, plus the final dataset. Dry run validates the chain first. Charged per pipeline and per started step. Agent-ready.", "version": "0.1", "x-build-id": "KJmaEZ0BwfiFMN2OG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nerolabs~actor-pipeline-runner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nerolabs-actor-pipeline-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/nerolabs~actor-pipeline-runner/runs": { "post": { "operationId": "runs-sync-nerolabs-actor-pipeline-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/nerolabs~actor-pipeline-runner/run-sync": { "post": { "operationId": "run-sync-nerolabs-actor-pipeline-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": [ "steps" ], "properties": { "steps": { "title": "Steps", "type": "array", "description": "One entry per step, in order. Each entry is {\"actor\": \"username/actor-name\", \"input\": { ... }}. Optional per step: \"datasetField\" (which input field receives the previous dataset, if it is not the usual one), \"skipDatasetInjection\" (run this step purely on its own input), \"label\", \"waitSecs\", \"memoryMbytes\" and \"build\". Up to 25 steps." }, "initialDatasetId": { "title": "Starting dataset (optional)", "type": "string", "description": "A dataset to hand to the FIRST step, as if it were the output of a step before it. Use this to run a pipeline over a scraper's existing results. Leave empty when the first step carries its own input, as in the example above." }, "stopOnFailure": { "title": "Stop on failure", "type": "boolean", "description": "On: if a step does not succeed, the run stops there and the remaining steps are reported as skipped, so a broken step never feeds bad data forward. Off: every step is attempted, and a step whose predecessor produced nothing runs on its own input.", "default": true }, "defaultWaitSecs": { "title": "Maximum wait per step (seconds)", "minimum": 10, "maximum": 21600, "type": "integer", "description": "How long to wait for each step before giving up on it and moving on. A step can override this with its own 'waitSecs'. Make sure this Actor's own run timeout is longer than all the steps added together.", "default": 3600 }, "dryRun": { "title": "Dry run (validate the chain, start nothing)", "type": "boolean", "description": "On: nothing is started and no step is charged. The output shows each step in order with the exact input it would be started with, including which field receives the previous step's dataset. Turn off to run the pipeline.", "default": false } } }, "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 } } } } } } } } } }