{ "openapi": "3.0.1", "info": { "title": "HTTP Request Runner: Bulk API Calls with Retries", "description": "Send many HTTP requests in one run: GET, POST, PUT, PATCH or DELETE, with headers, query parameters and JSON or text bodies. Retries on 429 and 5xx, parses JSON, echoes your lookup key. For Clay, n8n, Make and API pipelines.", "version": "1.0", "x-build-id": "BpUylCajg1GFTpN2l" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/prometheus-maker~http-request-runner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-prometheus-maker-http-request-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/prometheus-maker~http-request-runner/runs": { "post": { "operationId": "runs-sync-prometheus-maker-http-request-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/prometheus-maker~http-request-runner/run-sync": { "post": { "operationId": "run-sync-prometheus-maker-http-request-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", "properties": { "requests": { "title": "Requests", "type": "array", "description": "A list of requests. Each is a URL string, or an object: {\"url\": ..., \"method\": \"POST\", \"headers\": {...}, \"params\": {...}, \"json\": {...} or \"body\": \"text\", \"lookupKey\": \"your-id\"}." }, "url": { "title": "Single URL", "type": "string", "description": "Shortcut for one request (combined with Method, Headers and Body below). Added before the list above." }, "method": { "title": "Method (single URL)", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS" ], "type": "string", "description": "HTTP method for the single URL.", "default": "GET" }, "json": { "title": "JSON body (single URL)", "type": "object", "description": "Sent as application/json with the single URL." }, "defaultHeaders": { "title": "Headers for every request", "type": "object", "description": "Added to every request, e.g. {\"Authorization\": \"Bearer ...\"}. A request's own headers win." }, "defaultMethod": { "title": "Default method", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS" ], "type": "string", "description": "Method for list items that don't set one.", "default": "GET" }, "parseJson": { "title": "Parse JSON responses", "type": "boolean", "description": "Put JSON responses in 'json' as data instead of text in 'body'.", "default": true }, "maxRetries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries after 408, 429, 5xx and connection errors (waits as the server asks with Retry-After). 4xx errors are not retried.", "default": 2 }, "timeoutSecs": { "title": "Timeout per request (seconds)", "minimum": 1, "maximum": 300, "type": "integer", "description": "Give up on a request after this long.", "default": 30 }, "maxBodyBytes": { "title": "Max response size (bytes)", "minimum": 1000, "maximum": 8000000, "type": "integer", "description": "Longer responses are cut and marked truncated.", "default": 2000000 }, "followRedirects": { "title": "Follow redirects", "type": "boolean", "description": "Follow 3xx redirects to the final response.", "default": true }, "callbackUrl": { "title": "Callback URL", "type": "string", "description": "Optional: each result row is also POSTed as JSON to this URL as soon as it is ready (for Clay, n8n, Make webhooks)." }, "maxConcurrency": { "title": "Requests in parallel", "minimum": 1, "maximum": 100, "type": "integer", "description": "Requests in flight at the same time.", "default": 20 }, "maxRequestsPerHost": { "title": "Max parallel requests per host", "minimum": 1, "maximum": 50, "type": "integer", "description": "Keeps each API you call from being flooded.", "default": 5 } } }, "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 } } } } } } } } } }