{ "openapi": "3.0.1", "info": { "title": "HTTP Request — Bulk & Proxied API Calls", "description": "Send HTTP requests (GET, POST, PUT, PATCH, DELETE) to any API with custom headers, params and body. Send a whole batch in one run instead of one run per call, route through Apify proxies by country, and forward each response to a callback URL. Built for Clay, n8n and no-code stacks.", "version": "0.0", "x-build-id": "2QAVhJ74NfUlpfjR3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~http-request/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-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/memo23~http-request/runs": { "post": { "operationId": "runs-sync-memo23-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/memo23~http-request/run-sync": { "post": { "operationId": "run-sync-memo23-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": { "url": { "title": "URL", "type": "string", "description": "The endpoint to call. For a single request this is all you need. Leave it empty and use Requests below to send many in one run." }, "method": { "title": "HTTP method", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS" ], "type": "string", "description": "Method for the request above, and the default for any request in the batch that doesn't set its own.", "default": "GET" }, "headers": { "title": "Headers", "type": "object", "description": "Request headers as key/value pairs — e.g. Authorization or X-API-Key. Applied to every request in the run; a request can override any individual key." }, "params": { "title": "Query parameters", "type": "object", "description": "Query-string parameters, added to whatever the URL already carries." }, "data": { "title": "Request body", "type": "object", "description": "Body for POST/PUT/PATCH. An object is sent as JSON with the matching content-type (unless you set your own)." }, "lookupKey": { "title": "Lookup key", "type": "string", "description": "Any identifier you want echoed back on the result row — use it to join responses to the source row they came from." }, "requests": { "title": "Requests", "type": "array", "description": "Array of request objects: { url, method, headers, params, data, lookupKey }. Only url is required — and even that falls back to the URL above." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many requests run at once in batch mode. Lower this if the target API rate-limits you.", "default": 10 }, "responseTimeout": { "title": "Response timeout", "minimum": 1, "maximum": 300, "type": "integer", "description": "How long to wait for each attempt before giving up.", "default": 30 }, "retryOnFailure": { "title": "Retry on failure", "type": "boolean", "description": "Retry timeouts, connection errors, 408, 429 and 5xx responses. A 4xx is your request being wrong, so it is never retried.", "default": true }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries after the first attempt. Ignored when Retry on failure is off.", "default": 2 }, "parseJson": { "title": "Parse JSON responses", "type": "boolean", "description": "On: a JSON body is parsed into a `json` field you can address directly. Off: the raw text is returned in `body`.", "default": true }, "maxResponseBytes": { "title": "Max response size", "minimum": 1024, "type": "integer", "description": "Response bodies longer than this are truncated and flagged with `truncated: true`.", "default": 512000 }, "failOnErrorStatus": { "title": "Treat non-2xx as an error", "type": "boolean", "description": "On: a non-2xx response also fills the row's `error` field. The row is returned and billed either way.", "default": false }, "callbackUrl": { "title": "Callback URL", "type": "string", "description": "Each result row is POSTed here as JSON as soon as it completes — the pattern Clay and n8n use to receive results." }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Route requests through Apify Proxy. Pick a country for geo-specific responses, or residential groups for APIs that block datacenter IPs." } } }, "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 } } } } } } } } } }