{ "openapi": "3.0.1", "info": { "title": "HTTP Request API — Bulk GET/POST Calls Without a Browser", "description": "Send GET, POST, PUT, PATCH, DELETE or HEAD requests in bulk and get one record per request: status, headers, body, parsed JSON, jsonPath/CSS extract, redirects and timing. Retries, concurrency, optional proxy and a Standby HTTP API for agents and n8n. From US$3.50 per 1,000 requests.", "version": "0.1", "x-build-id": "nT4pNDflxkrx3w1pW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fabrikit~http-request-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fabrikit-http-request-api", "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/fabrikit~http-request-api/runs": { "post": { "operationId": "runs-sync-fabrikit-http-request-api", "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/fabrikit~http-request-api/run-sync": { "post": { "operationId": "run-sync-fabrikit-http-request-api", "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": [ "requests" ], "properties": { "requests": { "title": "Requests", "type": "array", "description": "Requests to send, in order. Each entry is a URL string (sent with the default method) or an object: { \"url\", \"method\", \"headers\", \"body\" or \"json\", \"form\", \"label\", \"jsonPath\", \"selector\", \"timeoutSecs\" }. Per-request headers are merged over the global ones. https:// is assumed when the scheme is missing. Public hosts only." }, "method": { "title": "Default method", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS" ], "type": "string", "description": "Method for entries that do not set their own.", "default": "GET" }, "headers": { "title": "Global headers", "type": "object", "description": "Headers added to every request, e.g. { \"authorization\": \"Bearer ...\", \"accept\": \"application/json\" }. Per-request headers override them." }, "jsonPath": { "title": "JSON path (global)", "type": "string", "description": "Dotted path applied to every JSON response to fill the extracted field, e.g. data.items[*].id or results[0].name. Per-request jsonPath overrides it." }, "selector": { "title": "CSS selector (global)", "type": "string", "description": "CSS selector applied to every HTML response to fill the extracted field with the matched texts, e.g. h1 or a@href for an attribute. Per-request selector overrides it. Ignored when a jsonPath applies." }, "timeoutSecs": { "title": "Timeout per request (seconds)", "minimum": 1, "maximum": 120, "type": "integer", "description": "Give up on a request after this many seconds per attempt.", "default": 30 }, "maxRetries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Extra attempts after a network error or an HTTP 408, 425, 429 or 5xx answer, with exponential backoff (Retry-After is honoured up to 30 s).", "default": 2 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Requests in flight at the same time.", "default": 5 }, "minDelayMs": { "title": "Minimum delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Minimum gap between two request starts, for rate-limited APIs (0 = none).", "default": 0 }, "followRedirects": { "title": "Follow redirects", "type": "boolean", "description": "Follow up to 10 redirects and report the chain. Turn off to get the 3xx answer itself.", "default": true }, "maxBodyChars": { "title": "Max body characters", "minimum": 0, "maximum": 2000000, "type": "integer", "description": "Cut the body field at this many characters (binary bodies are base64). truncated is set to true when the cut happens. 0 drops the body but keeps json and extracted.", "default": 200000 }, "includeBody": { "title": "Include body", "type": "boolean", "description": "Store the response body. Turn off when you only need status, headers, json or the extracted fragment.", "default": true }, "includeResponseHeaders": { "title": "Include response headers", "type": "boolean", "description": "Store the response headers in responseHeaders.", "default": true }, "parseJson": { "title": "Parse JSON responses", "type": "boolean", "description": "Fill the json field with the parsed object when the response is JSON.", "default": true }, "browserLikeHeaders": { "title": "Browser-like headers", "type": "boolean", "description": "Send a realistic browser User-Agent, Accept and TLS fingerprint (good for websites). Turn off to send a plain User-Agent (good for APIs). Your own headers always win.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "No proxy by default: requests go out from the Actor's own IP. Pick Apify datacenter proxy to rotate IPs, or residential proxy (extra cost) only if the target blocks datacenter IPs. The Actor never switches to residential on its own.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }