{ "openapi": "3.0.1", "info": { "title": "Bulk HTTP Request: send many API calls from a list", "description": "Send many HTTP requests from a list (GET, POST, PUT, PATCH, DELETE, HEAD with your headers and body) and get status, headers, JSON or text body, timing and errors for each in a dataset. Internal addresses are blocked. Empty input = free demo. $1 per 1,000 requests.", "version": "0.1", "x-build-id": "dRMfDYcdyrYnZvxCH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ucchiii~bulk-http-request/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ucchiii-bulk-http-request", "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/ucchiii~bulk-http-request/runs": { "post": { "operationId": "runs-sync-ucchiii-bulk-http-request", "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/ucchiii~bulk-http-request/run-sync": { "post": { "operationId": "run-sync-ucchiii-bulk-http-request", "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", "properties": { "requests": { "title": "Requests", "type": "array", "description": "List of requests to send. Each item is an object with url (required), method (GET, POST, PUT, PATCH, DELETE or HEAD), headers (object) and body (string, or any JSON value that is sent as JSON). Missing method, headers and body fall back to the shared settings below. Leave this and the URL list empty for a free demo." }, "urls": { "title": "URLs (simple list)", "type": "array", "description": "Optional shortcut: plain URLs that are all sent with the shared method, headers and body below. Added after the requests above.", "items": { "type": "string" } }, "method": { "title": "Shared method", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD" ], "type": "string", "description": "HTTP method for the simple URL list, and for request items that do not set their own.", "default": "GET" }, "headers": { "title": "Shared headers", "type": "object", "description": "Optional headers sent with every request, for example {\"Authorization\": \"Bearer ...\"}. Values such as Authorization and Cookie are never written to logs and are shown as [REDACTED] in the output. Use your own credentials only; they are part of the run input, so keep the run private." }, "body": { "title": "Shared body", "type": "string", "description": "Optional request body for the simple URL list and for items without their own body. Sent as text; if it is valid JSON and you set no Content-Type, it is sent as application/json." }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many requests are in flight at the same time (1 to 20). At most 5 connections per host are used at a time.", "default": 5 }, "timeoutSecs": { "title": "Timeout (seconds)", "minimum": 1, "maximum": 120, "type": "integer", "description": "Timeout for each request attempt.", "default": 30 }, "retries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times a failed request is retried (connection errors and timeouts; HTTP 429/502/503/504 for GET, HEAD, PUT and DELETE). POST and PATCH are retried only when no connection could be made, so nothing is sent twice. Retries are not charged.", "default": 2 }, "followRedirects": { "title": "Follow redirects", "type": "boolean", "description": "Follow redirects (up to 10). Every hop is checked against the internal-address block. Authorization and Cookie headers are dropped when a redirect goes to another host.", "default": true }, "maxBodyBytes": { "title": "Max response body to store (bytes)", "minimum": 0, "maximum": 5000000, "type": "integer", "description": "Response bodies longer than this are cut off and bodyTruncated is set to true. 100000 is about 100 KB; 0 stores no body.", "default": 100000 }, "parseJson": { "title": "Parse JSON responses", "type": "boolean", "description": "If on, a complete response body that is valid JSON is returned as the json field (and body is left empty). Otherwise the body is returned as text.", "default": false }, "responseHeaders": { "title": "Response headers", "enum": [ "selected", "all", "none" ], "type": "string", "description": "Which response headers to include in the output. Set-Cookie and similar secret headers are always shown as [REDACTED].", "default": "selected" } } }, "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 } } } } } } } } } }