{ "openapi": "3.0.1", "info": { "title": "OpenClawBot", "description": "Your own personal AI assistant running in the cloud. No server setup, no maintenance — just deploy and go. Runs a full OpenClaw instance as a dedicated container. It provides the complete OpenClaw experience — AI agent, multi-channel messaging, browser control, skills, persistent memory", "version": "0.0", "x-build-id": "CtPRCc44orwGvt7iZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/happitap~openclawbot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-happitap-openclawbot", "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/happitap~openclawbot/runs": { "post": { "operationId": "runs-sync-happitap-openclawbot", "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/happitap~openclawbot/run-sync": { "post": { "operationId": "run-sync-happitap-openclawbot", "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": [ "mode", "profileStoreKey" ], "properties": { "mode": { "title": "Mode", "enum": [ "standby", "batch" ], "type": "string", "description": "Actor operation mode: 'standby' for HTTP API server, 'batch' for single operation", "default": "standby" }, "profileStoreKey": { "title": "Profile Store Key", "type": "string", "description": "Key-Value Store key name to store OpenClaw profile archive (e.g., tar.gz of ~/.openclaw)", "default": "OPENCLAW_PROFILE_TAR_GZ" }, "anthropicApiKey": { "title": "Anthropic API Key", "type": "string", "description": "Anthropic API key for Claude models. Can also be set via ANTHROPIC_API_KEY secret." }, "openaiApiKey": { "title": "OpenAI API Key", "type": "string", "description": "OpenAI API key for GPT models. Can also be set via OPENAI_API_KEY secret." }, "modelProvider": { "title": "Model Provider", "type": "string", "description": "AI model provider to use (e.g., anthropic, openai, openrouter)" }, "modelName": { "title": "Model Name", "type": "string", "description": "Specific model name (e.g., claude-sonnet-4-20250514, gpt-4o)" }, "gatewayPort": { "title": "Gateway Port", "minimum": 1024, "maximum": 65535, "type": "integer", "description": "OpenClaw gateway port (default: 18789)", "default": 18789 }, "gatewayHost": { "title": "Gateway Host", "type": "string", "description": "OpenClaw gateway host binding (default: 127.0.0.1)", "default": "127.0.0.1" }, "gatewayVerbose": { "title": "Gateway Verbose Logging", "type": "boolean", "description": "Enable verbose gateway logging (WARNING: may log sensitive data)", "default": false }, "persistProfile": { "title": "Persist Profile", "type": "boolean", "description": "Save OpenClaw profile to Key-Value Store after operations", "default": true }, "profileSaveIntervalSec": { "title": "Profile Save Interval (seconds)", "minimum": 10, "maximum": 3600, "type": "integer", "description": "How often to save profile in Standby mode (seconds)", "default": 60 }, "enableLocks": { "title": "Enable Channel Locks", "type": "boolean", "description": "Enable per-channel mutex to prevent concurrent operations", "default": true }, "allowlistChannels": { "title": "Allowed Channels", "type": "array", "description": "List of allowed messaging channels (whatsapp, telegram, discord, slack, signal, imessage, bluebubbles, msteams, matrix, googlechat, zalo, webchat)", "default": [ "whatsapp", "telegram", "discord", "slack", "signal" ], "items": { "type": "string" } }, "maxMessageLength": { "title": "Max Message Length", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum message length in characters", "default": 4000 }, "enableDashboardProxy": { "title": "Enable Dashboard Proxy", "type": "boolean", "description": "Expose OpenClaw Control UI and WebChat via /dashboard and /webchat endpoints", "default": true }, "idleTimeoutSec": { "title": "Idle Timeout (seconds)", "minimum": 0, "maximum": 86400, "type": "integer", "description": "Shut down actor after this many seconds of inactivity (0 = never)", "default": 180 } } }, "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 } } } } } } } } } }