{ "openapi": "3.0.1", "info": { "title": "HTTP Request Runner: bulk API calls and webhooks", "description": "Sends many HTTP requests in one run (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS) with your own headers, JSON or form bodies and secret tokens, and returns each response's status, headers, body, parsed JSON and timing.", "version": "0.1", "x-build-id": "SxhjLwSstiglugAJf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/examsens.ai~http-request-runner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-examsens.ai-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/examsens.ai~http-request-runner/runs": { "post": { "operationId": "runs-sync-examsens.ai-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/examsens.ai~http-request-runner/run-sync": { "post": { "operationId": "run-sync-examsens.ai-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": "One object per request. Keys: url (required), method, headers (object), json (any JSON value, sent as application/json), body (raw text), form (object, sent as a URL encoded form), label (your own name for the row) and timeoutSecs. Write {{secrets.NAME}} anywhere in url, headers, body, json or form to insert a value from Secrets." }, "urls": { "title": "URLs", "type": "array", "description": "Optional. Plain URLs, one per line, sent with the default method and default headers. Added after the requests above.", "items": { "type": "string" } }, "defaultMethod": { "title": "Default method", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS" ], "type": "string", "description": "Used for URLs and for any request object without a method.", "default": "GET" }, "defaultHeaders": { "title": "Default headers", "type": "object", "description": "Headers sent with every request, as a JSON object. A request's own headers replace these where the names match." }, "secrets": { "title": "Secrets", "type": "string", "description": "Tokens and keys, one per line as NAME=value. Insert them with {{secrets.NAME}}. Stored encrypted, never written to the log, and replaced by (secret) wherever a value shows up in the results." }, "secretHeaders": { "title": "Secret headers", "type": "string", "description": "Headers sent with every request, one per line as Name: value, for example Authorization: Bearer abc123. Stored encrypted and never written to the log. Their values show as (secret) in the results." }, "secretHosts": { "title": "Send secret headers only to these hosts", "type": "array", "description": "Optional. Host names such as api.example.com. When set, secret headers go only to requests for these hosts. Secret headers, Authorization and Cookie are always dropped when a redirect leads to another host.", "items": { "type": "string" } }, "followRedirects": { "title": "Follow redirects", "type": "boolean", "description": "Follow 3xx answers up to the maximum below. A 301, 302 or 303 after a POST is followed with GET and no body, as browsers do; 307 and 308 repeat the same method and body.", "default": true }, "maxRedirects": { "title": "Maximum redirects", "minimum": 1, "maximum": 30, "type": "integer", "description": "Stop following after this many hops and report an error.", "default": 10 }, "maxBodyChars": { "title": "Maximum body characters", "minimum": 0, "maximum": 2000000, "type": "integer", "description": "Response bodies longer than this are cut and marked bodyTruncated. JSON is parsed only when the whole body fits.", "default": 100000 }, "includeResponseHeaders": { "title": "Include response headers", "type": "boolean", "description": "Add every response header to each row.", "default": true }, "timeoutSecs": { "title": "Timeout per request (seconds)", "minimum": 1, "maximum": 300, "type": "integer", "description": "How long to wait for each request. A request object can set its own timeoutSecs.", "default": 30 }, "retries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times to repeat a request that answers 429, or 502, 503 or 504 for GET, HEAD, OPTIONS, PUT and DELETE, or that times out before connecting. The wait follows the server's Retry-After header, up to 60 seconds.", "default": 2 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many requests run at the same time across all hosts.", "default": 10 }, "maxPerHost": { "title": "Parallel requests per host", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many requests one host gets at the same time. Lower it for APIs with tight rate limits.", "default": 4 }, "delayMs": { "title": "Delay between requests to one host (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Minimum gap between the start of two requests to the same host. 1000 gives at most one request per second per host.", "default": 0 } } }, "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 } } } } } } } } } }