{ "openapi": "3.0.1", "info": { "title": "WhatsApp Message Export - Backup Chats & Media", "description": "WhatsApp backup API: Export all messages and media to JSON. Download images, videos, documents from chats and groups. Easy QR code authentication. Filter by date range or chat type. Full metadata preserved even when media expires.", "version": "0.0", "x-build-id": "IyXEwGbVFPFeXmrYM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clearpath~whatsapp-message-export-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clearpath-whatsapp-message-export-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/clearpath~whatsapp-message-export-api/runs": { "post": { "operationId": "runs-sync-clearpath-whatsapp-message-export-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/clearpath~whatsapp-message-export-api/run-sync": { "post": { "operationId": "run-sync-clearpath-whatsapp-message-export-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", "properties": { "messageLimit": { "title": "Global Message Limit", "type": "integer", "description": "Maximum total messages to export across all chats (most recent N). Leave empty for unlimited." }, "messagesPerChat": { "title": "Messages Per Chat", "type": "integer", "description": "Maximum messages to export per chat (most recent N per chat). Leave empty for unlimited." }, "includeStatus": { "title": "Include Status Messages", "type": "boolean", "description": "Include viewed WhatsApp Status updates (stories) in export.", "default": true }, "downloadMedia": { "title": "Download Media Attachments", "uniqueItems": true, "type": "array", "description": "Select media types to download. All messages are always exported with full metadata (filename, size, type). Only the actual file downloads may fail for older messages (~30+ days) due to WhatsApp server retention.", "items": { "type": "string", "enum": [ "images", "videos", "documents", "audio", "stickers" ] }, "default": [] }, "downloadConcurrency": { "title": "Download Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of parallel media downloads (1-10). Higher values are faster but may hit rate limits.", "default": 5 }, "maxMediaAgeDays": { "title": "Max Media Age (Days)", "minimum": 0, "maximum": 365, "type": "integer", "description": "Only attempt downloads for media from messages newer than X days. Older media is kept in output but marked as skipped_by_age. Set to 0 to attempt all downloads (old media will likely fail with 'expired' status).", "default": 30 }, "maxFileSizeMB": { "title": "Max File Size (MB)", "minimum": 0, "maximum": 500, "type": "integer", "description": "Skip media files larger than this size to prevent memory issues. Large files are kept in output but marked as skipped_too_large. Set to 0 to disable limit (may cause memory errors on very large files).", "default": 100 }, "chatFilter": { "title": "Chat Filter", "enum": [ "all", "groups", "private" ], "type": "string", "description": "Filter chats by type", "default": "all" }, "dateRange": { "title": "Date Range", "enum": [ "all", "7d", "30d", "3m", "6m", "12m" ], "type": "string", "description": "Only export messages from this time period", "default": "all" } } }, "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 } } } } } } } } } }