{ "openapi": "3.0.1", "info": { "title": "Send a Fax (Fax for Agents)", "description": "Send a PDF or text document as a fax from any Apify run, schedule or integration. Prepare, preview, quote, then send with an approval step. Delivery status lands in the run dataset. Powered by Fax for Agents, the fax API for AI agents.", "version": "0.0", "x-build-id": "wvEcfkR1NSK9L9qWg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/faxforagents~apify-actor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-faxforagents-apify-actor", "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/faxforagents~apify-actor/runs": { "post": { "operationId": "runs-sync-faxforagents-apify-actor", "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/faxforagents~apify-actor/run-sync": { "post": { "operationId": "run-sync-faxforagents-apify-actor", "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": [ "to" ], "properties": { "apiKey": { "title": "Fax for Agents API key", "type": "string", "description": "ffa_test_... reaches the sandbox only. ffa_live_... reaches the carrier and spends the prepaid wallet. Keys are created at app.faxforagents.com. Leave it empty and the run only checks that the API is reachable, sends nothing and writes one check record." }, "to": { "title": "To", "pattern": "^\\+[1-9][0-9]{6,14}$", "type": "string", "description": "The destination fax number in E.164, for example +12025550123." }, "text": { "title": "Text", "type": "string", "description": "Plain text rendered to a letter PDF. Pass this, markdown or fileUrl, not two." }, "markdown": { "title": "Markdown", "type": "string", "description": "Markdown (headings, lists, emphasis, code) rendered to PDF." }, "fileUrl": { "title": "File URL", "type": "string", "description": "A URL of a PDF, PNG, JPG or TIFF the Actor downloads and sends. Up to 25 MB." }, "coverSubject": { "title": "Cover sheet subject", "type": "string", "description": "Any cover field adds a billable cover page in front of the document." }, "coverMessage": { "title": "Cover sheet message", "type": "string", "description": "A short message on the cover sheet." }, "coverToName": { "title": "Cover sheet, to name", "type": "string", "description": "The recipient name on the cover sheet." }, "coverFromName": { "title": "Cover sheet, from name", "type": "string", "description": "The sender name on the cover sheet." }, "approvalId": { "title": "Approval id", "type": "string", "description": "An approved request bound to this send (apr_...), when the account needs a human approval for live sends." }, "clientReference": { "title": "Client reference", "type": "string", "description": "Your own reference stored on the fax, up to 200 characters. Defaults to the Apify run id." }, "waitForDelivery": { "title": "Wait for delivery", "type": "boolean", "description": "Poll until the fax is delivered, partial, failed or unknown. Off returns once the fax is queued.", "default": true }, "timeoutSeconds": { "title": "Timeout (seconds)", "minimum": 10, "maximum": 3600, "type": "integer", "description": "How long to wait for a terminal state before the run fails.", "default": 600 }, "failOn": { "title": "Fail the run on", "type": "string", "description": "Comma-separated terminal states that fail the run. Empty never fails the run.", "default": "failed,unknown" }, "baseUrl": { "title": "API base URL", "type": "string", "description": "Only change it to point the Actor at a test double.", "default": "https://api.faxforagents.com" } } }, "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 } } } } } } } } } }