WebRun Browser Automation

{'type': 'object', 'required': ['prompt'], 'properties': {'files': {'type': 'array', 'items': {'type': 'string'}, 'description': "Optional file IDs to attach: ids returned by POST /files/upload, or any file already in one of the user's environment catalogs (GET /environments/:id/files). Max 5 files."}, 'model': {'type': 'string', 'description': 'Optional model name or profile key (from global config). Falls back to the configured default.'}, 'proxy': {'type': 'object', 'properties': {'host': {'type': 'string', 'description': 'Custom proxy host'}, 'port': {'type': 'number', 'description': 'Custom proxy port'}, 'type': {'enum': ['http', 'socks'], 'type': 'string', 'description': 'Custom proxy type'}, 'level': {'enum': ['system', 'chrome'], 'type': 'string', 'description': 'Proxy level. "chrome" (default) applies proxy via browser extension (instant, no swap). "system" launches Chrome with --proxy-server flag (requires instance swap).'}, 'source': {'enum': ['WebRun', 'custom'], 'type': 'string', 'description': 'Proxy provider'}, 'country': {'type': 'string', 'description': 'ISO country code for WebRun proxy (e.g. "GB", "US") or "random" for a random country with good connectivity'}, 'password': {'type': 'string', 'description': 'Custom proxy password (optional)'}, 'username': {'type': 'string', 'description': 'Custom proxy username (optional)'}}, 'description': 'Proxy configuration. WebRun-managed: { source: "WebRun", country: "GB" }. Custom: { source: "custom", type: "http"|"socks", host, port, username?, password? }. Omit for no proxy. Social/messaging automation (WhatsApp, Telegram, Instagram, Facebook, X, LinkedIn, TikTok): prefer country = the country the user is in right now — recommend it and confirm the country with them first; a mismatch is the usual cause of refused logins and sessions that log out repeatedly.'}, 'debugC': {'type': 'boolean', 'description': 'Enable debug mode on the instance (default: false)'}, 'prompt': {'type': 'string', 'description': 'Task description in natural language'}, 'secrets': {'type': 'array', 'items': {'type': 'object'}, 'description': 'Domain-matched secrets [{match, fields}] passed to instance (not stored)'}, 'webhook': {'type': 'object', 'properties': {'url': {'type': 'string', 'description': 'HTTPS URL to receive webhook'}, 'auth': {'type': 'string', 'description': 'Authorization header value'}, 'name': {'type': 'string', 'description': 'Webhook identifier'}, 'submittedData': {'enum': ['full_response', 'structured_output', 'just_ping'], 'type': 'string', 'description': 'Payload type'}}, 'description': 'Webhook configuration for task completion notification'}, 'policyId': {'type': 'string', 'description': 'Policy ID to apply automation guardrails (domain restrictions, capability controls, LLM role). Optional.'}, 'timezone': {'type': 'string', 'description': 'IANA timezone name for the session, e.g. "America/New_York", "Europe/London", "Asia/Tokyo". Date/time-sensitive instructions (e.g. "tomorrow morning", "today", "in 2 hours") are interpreted in this timezone. When omitted, follows the WebRun proxy country if one is set (e.g. country "de" → Europe/Berlin); otherwise the browser default.'}, 'outputType': {'enum': ['text', 'structured_json', 'structured_csv'], 'type': 'string', 'description': 'Response format (default: text)'}, 'maxDuration': {'type': 'number', 'description': 'Max duration in minutes (default: 20, max: 60)'}, 'startingUrl': {'type': 'string', 'description': 'Optional starting URL'}, 'outputSchema': {'type': 'object', 'description': 'JSON Schema for structured output (required if outputType is structured_json)'}, 'environmentId': {'type': 'string', 'description': 'Environment ID for persistent profile session. Use list_environments to find available IDs. Without this, a disposable instance is used.'}, 'reach_out_mode': {'enum': ['off', 'guardrail_only', 'full'], 'type': 'string', 'description': 'Controls proactive chat-platform messages (Telegram/WhatsApp/Slack/Discord/Teams) to bot users on the same environment. Default: "off" — no messages are sent unless this is set explicitly. "guardrail_only" forwards guardrail prompts (CAPTCHA/2FA/verification) to chat when the API caller is offline. "full" also forwards the task result on completion. Each bot user additionally filters by their own reachOutMode preference.'}}}

{'type': 'object', 'properties': {'data': {'type': 'object', 'description': 'Task output payload (instance-authored shape)', 'additionalProperties': True}, 'type': {'type': 'string', 'description': "Result type, e.g. 'task_completed', 'task_failed', 'guardrail_trigger'"}, 'error': {'type': 'string'}, 'status': {'type': 'string', 'description': "Present on guardrail results: 'awaiting_input'"}, 'taskId': {'type': ['string', 'null']}, 'message': {'type': 'string'}, 'pending': {'type': 'boolean', 'description': 'True when the task is still running — poll get_task_status'}, 'success': {'type': 'boolean'}, 'sessionId': {'type': 'string'}, 'environment': {'type': 'object', 'properties': {'name': {'type': ['string', 'null']}, 'environmentId': {'type': 'string'}}}, 'liveViewURL': {'type': 'string', 'description': 'Page for watching the run live, present while it is still running or awaiting input. The only URL here that is safe to show a user or open in a browser.'}}, 'description': 'Task outcome envelope: a completion (success/type/data), a pending marker (poll get_task_status), or an awaiting_input guardrail. `data` is the task output; its shape is task-defined (freeform text or the caller-supplied structured schema).', 'additionalProperties': True}

{'type': 'object', 'required': ['schedule'], 'properties': {'name': {'type': 'string', 'maxLength': 100, 'description': 'Agent name. Required standalone; defaults to the workflow title in workflow mode.'}, 'proxy': {'type': 'object', 'properties': {'host': {'type': 'string'}, 'port': {'type': 'number'}, 'type': {'enum': ['http', 'socks'], 'type': 'string'}, 'level': {'enum': ['system', 'chrome'], 'type': 'string'}, 'source': {'enum': ['WebRun', 'custom'], 'type': 'string'}, 'country': {'type': 'string', 'description': '2-letter ISO code or "random" (WebRun).'}, 'password': {'type': 'string'}, 'username': {'type': 'string'}}, 'description': 'STANDALONE MODE (workflow mode inherits the workflow proxy instead): Proxy for runs. {source:"WebRun", country?} or {source:"custom", type:"http"|"socks", host, port, username?, password?}. Custom passwords are encrypted at rest and never returned. Social/messaging workflows (WhatsApp, Telegram, Instagram, Facebook, X, LinkedIn, TikTok): set country to the country the user is in right now — recommend it and confirm the country with them first; a mismatch is the usual cause of refused logins and sessions that log out repeatedly, and a scheduled workflow re-hits it every run, so keep the country stable once set.'}, 'memory': {'type': 'string', 'maxLength': 10000, 'description': "STANDALONE MODE: the agent's private notebook, shown to it every run and updated automatically after each run. Seed ONLY durable facts the next run must know (target descriptions, preferences, known state) — one short line each. Task steps belong in prompt, not here. Usually best left empty."}, 'prompt': {'type': 'string', 'maxLength': 5000, 'description': 'STANDALONE MODE (required there): The task the browser agent runs, written as a BROWSING RUNBOOK. Structure it as: `Goal:` — one sentence naming the outcome. `Ground rules (every stage, every turn):` — bullet invariants when the task needs them, e.g. work one item at a time — never batch; only record a figure you can read on screen this turn — if it is not shown record it as "not stated", never estimate; keep a running tally and restate it every turn ("captured C items · written R rows"). Then `Stage N — <Site name> (<https://url>)` — one section per website or phase, listing the concrete steps to take in the browser (open/navigate, click, read, capture, compare, flag) in the order a person would do them, each stage ending with `Done when: <verifiable completion condition>`. Finish with `Output —` stating exactly what to produce or deliver once the final tally is met, including what to say when there is no data (never fabricate a row). When a stage delivers per-recipient (message/email each customer), state the MATCHING RULE in that stage — the identifier shared by the source record and the destination recipient (e.g. the customer name exactly as written in the source, matched against the contact name) — and the no-match branch: skip it and report it, never deliver to a similarly-named near-match. Write the user\'s CONCRETE values (group names, URLs, numbers) directly into the text; use {{variables}} ONLY when the user explicitly wants a reusable template whose inputs change per run. A short single-site task can be just a Goal plus its steps. PURE TASK ONLY — never write memory bookkeeping into the prompt (no "check memory", "record in memory", "store in memory" steps): tracking is authored in memoryContract and WebRun applies it to every run automatically.'}, 'schedule': {'type': 'object', 'required': ['type'], 'properties': {'at': {'type': 'string', 'description': 'ISO 8601 date-time (type "at").'}, 'cron': {'type': 'string', 'description': '5-field cron expression (type "cron").'}, 'type': {'enum': ['at', 'every', 'cron'], 'type': 'string', 'description': "'at' = once at a specific time; 'every' = fixed interval; 'cron' = cron expression."}, 'interval': {'type': 'number', 'description': 'Repeat interval in ms, min 60000 (type "every").'}, 'timezone': {'type': 'string', 'description': 'IANA timezone for the schedule (drives fire times AND the browser session). Default UTC.'}}, 'description': 'When the agent fires. Required.'}, 'expiresAt': {'type': 'string', 'description': 'ISO 8601 date-time after which the agent auto-pauses (recurring schedules).'}, 'variables': {'type': 'object', 'description': "WORKFLOW MODE, and only when the workflow's prompt actually contains {{variables}}: values for them, BAKED IN at deploy and reused every run (stored variableValues defaults fill gaps). Every template variable must be covered — an unattended agent cannot ask later. Workflows with concrete prompts need nothing here.", 'additionalProperties': {'type': 'string'}}, 'outputType': {'enum': ['text', 'structured', 'structured_csv'], 'type': 'string', 'description': 'STANDALONE MODE: output contract (same rules as create_workflow).'}, 'workflowId': {'type': 'string', 'description': 'WORKFLOW MODE: 24-hex id of the workflow to deploy (from list_workflows). The prompt, starting URL, output contract, model, proxy, policy, and files are all copied from it.'}, 'startingUrl': {'type': 'string', 'description': 'STANDALONE MODE: page Chrome opens at the start of each run.'}, 'outputSchema': {'type': ['object', 'array'], 'description': 'STANDALONE MODE: JSON Schema object (structured) or column-name array (structured_csv).'}, 'environmentId': {'type': 'string', 'description': "STANDALONE MODE, rarely needed — OMIT it: the connection-bound environment (or your only one) is applied automatically; never ask the user to choose. Workflow mode always uses the workflow's deployed environment."}}, 'description': 'Two modes: pass workflowId to deploy a workflow (everything else about the run is copied from it), or omit workflowId and provide name + prompt for a standalone agent. schedule is required in both.'}

{'type': 'object', 'required': ['success', 'agentId', 'name', 'mode'], 'properties': {'mode': {'enum': ['workflow', 'standalone'], 'type': 'string'}, 'name': {'type': 'string'}, 'notes': {'type': 'array', 'items': {'type': 'string'}}, 'agentId': {'type': 'string'}, 'success': {'type': 'boolean'}, 'schedule': {'type': 'string', 'description': 'Humanized schedule'}, 'timezone': {'type': 'string'}, 'workflow': {'type': 'object', 'properties': {'title': {'type': 'string'}, 'workflowId': {'type': 'string'}}, 'description': 'Present in workflow mode: the workflow this agent was deployed from'}, 'nextRunAt': {'type': ['string', 'null'], 'description': 'ISO 8601 timestamp of the first fire'}}}

{'type': 'object', 'required': [], 'properties': {'mode': {'type': 'string', 'description': 'Session mode (default: default)'}, 'task': {'type': 'object', 'properties': {'files': {'type': 'array', 'items': {'type': 'string'}, 'description': "Optional file IDs to attach: ids returned by POST /files/upload, or any file already in one of the user's environment catalogs (GET /environments/:id/files). Max 5 files."}, 'prompt': {'type': 'string', 'description': 'Task description'}, 'secrets': {'type': 'array', 'items': {'type': 'object'}, 'description': 'Domain-matched secrets [{match, fields}] (not stored)'}, 'webhook': {'type': 'object', 'description': 'Webhook configuration'}, 'outputType': {'enum': ['text', 'structured_json', 'structured_csv'], 'type': 'string', 'description': 'Response format'}, 'maxDuration': {'type': 'number', 'description': 'Max duration in minutes'}, 'startingUrl': {'type': 'string', 'description': 'Starting URL'}, 'outputSchema': {'type': 'object', 'description': 'JSON Schema for structured output (required if outputType is structured_json)'}, 'terminateOnCompletion': {'type': 'boolean', 'description': 'Auto-terminate after task'}}, 'description': 'Initial task configuration'}, 'model': {'type': 'string', 'description': 'Optional model name or profile key (from global config). Falls back to the configured default.'}, 'proxy': {'type': 'object', 'properties': {'host': {'type': 'string', 'description': 'Custom proxy host'}, 'port': {'type': 'number', 'description': 'Custom proxy port'}, 'type': {'enum': ['http', 'socks'], 'type': 'string', 'description': 'Custom proxy type'}, 'level': {'enum': ['system', 'chrome'], 'type': 'string', 'description': 'Proxy level. "chrome" (default) applies proxy via browser extension (instant, no swap). "system" launches Chrome with --proxy-server flag (requires instance swap).'}, 'source': {'enum': ['WebRun', 'custom'], 'type': 'string', 'description': 'Proxy provider'}, 'country': {'type': 'string', 'description': 'ISO country code for WebRun proxy (e.g. "GB", "US") or "random" for a random country with good connectivity'}, 'password': {'type': 'string', 'description': 'Custom proxy password (optional)'}, 'username': {'type': 'string', 'description': 'Custom proxy username (optional)'}}, 'description': 'Proxy configuration. WebRun-managed: { source: "WebRun", country: "GB" }. Custom: { source: "custom", type: "http"|"socks", host, port, username?, password? }. Omit for no proxy. Social/messaging automation (WhatsApp, Telegram, Instagram, Facebook, X, LinkedIn, TikTok): prefer country = the country the user is in right now — recommend it and confirm the country with them first; a mismatch is the usual cause of refused logins and sessions that log out repeatedly.'}, 'debugC': {'type': 'boolean', 'description': 'Enable debug mode on the instance (default: false)'}, 'policyId': {'type': 'string', 'description': 'Policy ID to apply automation guardrails (domain restrictions, capability controls, LLM role). Optional.'}, 'timezone': {'type': 'string', 'description': 'IANA timezone name for the session, e.g. "America/New_York", "Europe/London", "Asia/Tokyo". Date/time-sensitive instructions (e.g. "tomorrow morning", "today", "in 2 hours") are interpreted in this timezone. When omitted, follows the WebRun proxy country if one is set (e.g. country "de" → Europe/Berlin); otherwise the browser default.'}, 'environmentId': {'type': 'string', 'description': 'Environment ID for persistent profile session. Use list_environments to find available IDs. Without this, a disposable instance is used.'}, 'reach_out_mode': {'enum': ['off', 'guardrail_only', 'full'], 'type': 'string', 'description': 'Controls proactive chat-platform messages (Telegram/WhatsApp/Slack/Discord/Teams) to bot users on the same environment. Default: "off" — no messages are sent unless this is set explicitly. "guardrail_only" forwards guardrail prompts (CAPTCHA/2FA/verification) to chat when the API caller is offline. "full" also forwards the task result on completion. Each bot user additionally filters by their own reachOutMode preference.'}}}

{'type': 'object', 'required': ['sessionId'], 'properties': {'taskId': {'type': ['string', 'null'], 'description': 'Task ID when an initial task was provided'}, 'message': {'type': 'string'}, 'sessionId': {'type': 'string', 'description': 'Session ID for subsequent commands'}, 'streaming': {'type': 'object', 'properties': {'webRTCURL': {'type': ['string', 'null'], 'description': 'WHEP signaling endpoint for a programmatic WebRTC client. POST-only: a browser GET returns HTTP 405. Never show this to a user.'}, 'dimensions': {'type': 'object', 'properties': {'width': {'type': 'number'}, 'height': {'type': 'number'}}}, 'webViewURL': {'type': ['string', 'null'], 'description': 'Direct MediaMTX player on the streaming host (port 2096), unbranded and often firewall-blocked. Debugging fallback only — prefer liveViewURL.'}, 'liveViewURL': {'type': ['string', 'null'], 'description': 'The live-view page. This is the ONLY URL to show a user or open in a browser. Null when the stream is unavailable — say live view is unavailable rather than offering another field.'}}, 'description': 'Endpoints for watching the running browser. Only liveViewURL is a web page — the other two are machine endpoints on a non-standard port.'}, 'environment': {'type': 'object', 'properties': {'name': {'type': ['string', 'null']}, 'environmentId': {'type': 'string'}}, 'description': 'Environment this session is bound to, when one was requested'}}}

{'type': 'object', 'required': ['title', 'promptTemplate'], 'properties': {'flow': {'type': 'object', 'description': 'Dashboard flow diagram: { trigger: {kind, phrase}, steps: [{ primary: {label, domain}, verb }] }.'}, 'model': {'type': 'string', 'maxLength': 60, 'description': 'Model profile key. Omit for the account default.'}, 'proxy': {'type': 'object', 'properties': {'host': {'type': 'string'}, 'port': {'type': 'number'}, 'type': {'enum': ['http', 'socks'], 'type': 'string'}, 'level': {'enum': ['system', 'chrome'], 'type': 'string'}, 'source': {'enum': ['WebRun', 'custom'], 'type': 'string'}, 'country': {'type': 'string', 'description': '2-letter ISO code or "random" (WebRun).'}, 'password': {'type': 'string'}, 'username': {'type': 'string'}}, 'description': 'Proxy for runs. {source:"WebRun", country?} or {source:"custom", type:"http"|"socks", host, port, username?, password?}. Custom passwords are encrypted at rest and never returned. Social/messaging workflows (WhatsApp, Telegram, Instagram, Facebook, X, LinkedIn, TikTok): set country to the country the user is in right now — recommend it and confirm the country with them first; a mismatch is the usual cause of refused logins and sessions that log out repeatedly, and a scheduled workflow re-hits it every run, so keep the country stable once set.'}, 'title': {'type': 'string', 'maxLength': 120, 'description': 'Workflow title (shown on the dashboard).'}, 'memory': {'type': 'string', 'maxLength': 10000, 'description': "The agent's private notebook: shown to it at the start of every run, updated automatically after each run. Seed it ONLY with durable facts the next run must already know — the exact description of a target item (e.g. the specific picture to match), user preferences, known starting state — one short line per fact. Do NOT put task steps here (promptTemplate) or tracking rules here (memoryContract). Most workflows need no seed at all: the agent builds its own notebook as it runs."}, 'skills': {'type': 'array', 'items': {'type': 'object'}, 'description': 'Workflow-scoped skill entries (dashboard shape).'}, 'trigger': {'type': 'object', 'properties': {'via': {'type': ['string', 'null'], 'maxLength': 50, 'description': "e.g. 'direct', 'n8n'"}, 'type': {'enum': ['cron', 'external', 'manual'], 'type': 'string'}, 'source': {'type': 'string', 'maxLength': 50, 'description': "e.g. 'cron', 'manual', 'gmail', 'webhook', 'hubspot'"}}, 'description': "How the workflow is meant to be invoked (informational — see notes). Defaults to {type:'manual', source:'manual'}."}, 'listType': {'enum': ['static', 'dynamic', 'monitor'], 'type': 'string', 'description': "Advanced — defaults automatically ('monitor' when memoryContract is supplied); leave unset."}, 'schedule': {'type': 'object', 'properties': {'at': {'type': 'string', 'description': 'ISO 8601 date-time (type "at").'}, 'cron': {'type': 'string', 'description': '5-field cron expression (type "cron").'}, 'type': {'enum': ['at', 'every', 'cron', None], 'type': ['string', 'null']}, 'interval': {'type': 'number', 'description': 'Repeat interval in ms, min 60000 (type "every").'}, 'timezone': {'type': 'string', 'description': 'IANA timezone for the schedule. Default UTC.'}}, 'description': 'Saved schedule setting. NOTE: record-only — the workflow does NOT run on a timer until deployed as a scheduled agent (dashboard or Telegram bot).'}, 'timezone': {'type': 'string', 'maxLength': 60, 'description': 'IANA timezone for runs of this workflow (e.g. "America/New_York"). Leave unset to follow the proxy country.'}, 'department': {'type': 'string', 'maxLength': 100, 'description': 'Free-text department label (e.g. "inventory").'}, 'outputType': {'enum': ['text', 'structured', 'structured_csv'], 'type': 'string', 'description': "Output contract: 'text' (default), 'structured' (JSON matching outputSchema), 'structured_csv' (rows for the outputSchema column names)."}, 'destination': {'type': 'object', 'properties': {'sub': {'type': ['string', 'null']}, 'type': {'type': ['string', 'null']}, 'description': {'type': 'string'}}, 'description': "Result destination chip: { type, sub, description }. Types seen: 'custom-api', 'slack', 'sheets', 'email', 'messaging', 'telegram', 'crm'."}, 'startingUrl': {'type': 'string', 'maxLength': 2000, 'description': 'Page Chrome opens at the start of each run. Omit to let the prompt decide.'}, 'useCaseTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 60}, 'description': 'Categorisation tags.'}, 'fileDeferred': {'type': 'boolean', 'description': 'Dashboard flag: file selection deferred to run time.'}, 'outputSchema': {'type': ['object', 'array'], 'description': 'JSON Schema object (outputType "structured") or array of column-name strings (outputType "structured_csv").'}, 'reachOutMode': {'enum': ['off', 'guardrail_only', 'full', None], 'type': ['string', 'null'], 'description': "Proactive-chat policy for runs: 'off', 'guardrail_only', or 'full'. Omit (or pass null) to inherit the account default (MCP-initiated runs treat inherit as 'off')."}, 'wizardPreset': {'type': 'object', 'description': 'Dashboard wizard preset: { technology, useCases[], destination, destinationSub }.'}, 'environmentId': {'type': 'string', 'description': "Rarely needed — OMIT it: the connection's bound environment (or your only environment) is applied automatically. Pass only when the user explicitly names a different environment. Never ask the user to choose."}, 'memoryEnabled': {'type': 'boolean', 'description': 'Persist per-workflow agent memory across runs (default true).'}, 'publicDraftId': {'type': 'string', 'maxLength': 64, 'description': 'Dashboard public-draft correlation id.'}, 'requiredFiles': {'type': 'array', 'items': {'type': 'object', 'required': ['fileId'], 'properties': {'size': {'type': 'number'}, 'fileId': {'type': 'string'}, 'originalName': {'type': 'string'}, 'environmentId': {'type': 'string', 'description': "Optional. If given, must be the workflow's own environment (24-hex)."}}}, 'description': "Files attached to every run (downloaded before the agent starts). Each fileId must already be in the workflow's own environment (GET /environments/:id/files) — a workflow only uses files from its own environment. originalName and size are filled from that catalog."}, 'roiHourlyRate': {'type': ['number', 'null'], 'description': 'Hourly rate for the ROI card.'}, 'triggerPhrase': {'type': 'string', 'maxLength': 200, 'description': 'Natural-language phrase that invokes this workflow in chat.'}, 'memoryContract': {'type': 'object', 'properties': {'groundRules': {'type': 'string', 'maxLength': 1500, 'description': 'Standing rules the agent follows on every turn of every run: what it must never do, what counts as proof a step actually succeeded, what to do when something looks ambiguous, and any pacing or volume limits. Short bullets.'}, 'itemIdentity': {'type': 'string', 'maxLength': 300, 'description': 'What tells one item apart from another, and stays the same the next time the agent sees it. Use only details visible on screen — for example where it came from, who it is from, when it appeared, and its opening words — and say how to write it the same way every time.'}, 'memoryInstruction': {'type': 'string', 'maxLength': 1500, 'description': 'When a single item counts as finished, and what happens to everything else. State plainly what must be true before an item is considered done, what to do when the agent cannot tell whether a past item was done, and what happens to items left over at the end of a run.'}}, 'description': "How this workflow should behave and what it must remember between runs. REQUIRED whenever the task handles each thing once — new messages, forward once, skip anything already done. Write all three fields in plain English, addressed to the agent; the platform wires the tracking itself. Never write any of this into the prompt: the prompt says what to do, this says how to do it consistently. To explicitly disable tracking for a task that looks like it needs it, pass {mode:'none'}."}, 'policyOptedOut': {'type': 'boolean', 'description': "Opt this workflow out of the environment's default policy."}, 'promptTemplate': {'type': 'string', 'maxLength': 5000, 'description': 'The task the browser agent runs, written as a BROWSING RUNBOOK. Structure it as: `Goal:` — one sentence naming the outcome. `Ground rules (every stage, every turn):` — bullet invariants when the task needs them, e.g. work one item at a time — never batch; only record a figure you can read on screen this turn — if it is not shown record it as "not stated", never estimate; keep a running tally and restate it every turn ("captured C items · written R rows"). Then `Stage N — <Site name> (<https://url>)` — one section per website or phase, listing the concrete steps to take in the browser (open/navigate, click, read, capture, compare, flag) in the order a person would do them, each stage ending with `Done when: <verifiable completion condition>`. Finish with `Output —` stating exactly what to produce or deliver once the final tally is met, including what to say when there is no data (never fabricate a row). When a stage delivers per-recipient (message/email each customer), state the MATCHING RULE in that stage — the identifier shared by the source record and the destination recipient (e.g. the customer name exactly as written in the source, matched against the contact name) — and the no-match branch: skip it and report it, never deliver to a similarly-named near-match. Write the user\'s CONCRETE values (group names, URLs, numbers) directly into the text; use {{variables}} ONLY when the user explicitly wants a reusable template whose inputs change per run. A short single-site task can be just a Goal plus its steps. PURE TASK ONLY — never write memory bookkeeping into the prompt (no "check memory", "record in memory", "store in memory" steps): tracking is authored in memoryContract and WebRun applies it to every run automatically.'}, 'refineMessages': {'type': 'array', 'items': {'type': 'object', 'properties': {'role': {'type': 'string'}, 'content': {'type': 'string'}}}, 'description': 'Dashboard builder refinement thread rows: [{ role, content }].'}, 'variableValues': {'type': 'object', 'description': 'ONLY for explicitly dynamic workflows: default values for {{variables}}, keyed by variable name. NOTE: applied only when triggering via MCP trigger_workflow (merged under caller-supplied variables); REST /trigger and bot triggers ignore this field.', 'additionalProperties': {'type': 'string'}}, 'compatibleTools': {'type': 'array', 'items': {'type': 'object', 'properties': {'name': {'type': 'string'}, 'role': {'type': 'string'}, 'domain': {'type': 'string'}, 'loginUrl': {'type': 'string'}}}, 'description': 'Sites/tools the workflow uses: [{ name, loginUrl, domain, role }].'}, 'conciergeNotify': {'type': 'string', 'maxLength': 50, 'description': "Where the concierge announces results (e.g. 'Telegram', 'Slack', 'WhatsApp', 'Microsoft Teams', 'concierge')."}, 'workListEnabled': {'type': 'boolean', 'description': 'Advanced — set automatically when memoryContract is supplied; leave unset.'}, 'deployedPolicyId': {'type': 'string', 'maxLength': 24, 'description': 'Policy id to run under (must be owned by you).'}, 'orchestrateFirst': {'type': 'boolean', 'description': 'Discovery mode: one run gathers the WHOLE work list up front, later runs claim one item each.'}, 'shortDescription': {'type': 'string', 'maxLength': 500, 'description': 'One-line summary shown in workflow lists.'}, 'roiMinutesPerTask': {'type': ['number', 'null'], 'description': 'Minutes saved per run (dashboard ROI card).'}, 'templateVariables': {'type': 'array', 'items': {'type': 'object', 'required': ['name'], 'properties': {'kind': {'type': 'string', 'description': "e.g. 'config'"}, 'name': {'type': 'string', 'description': 'Must match a {{name}} in promptTemplate ([a-zA-Z0-9_]).'}, 'type': {'type': 'string', 'description': "e.g. 'text', 'keywords'"}, 'label': {'type': 'string'}, 'prompt': {'type': 'string', 'description': 'Question to ask the user for this value.'}, 'required': {'type': 'boolean'}, 'sampleValue': {'type': 'string'}}}, 'description': 'ONLY for explicitly dynamic workflows (the user asked for a reusable template): metadata for the {{variables}} used in promptTemplate (drives the dashboard fill-in UI). Omit entirely when the prompt carries concrete values.'}}}

{'type': 'object', 'required': ['success', 'workflowId', 'slug', 'title'], 'properties': {'slug': {'type': 'string'}, 'notes': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Caveats the caller should relay (e.g. the schedule is record-only)'}, 'title': {'type': 'string'}, 'success': {'type': 'boolean'}, 'nextStep': {'type': 'string', 'description': 'How to run or test this workflow (always trigger_workflow)'}, 'workflowId': {'type': 'string'}, 'environment': {'type': 'object', 'properties': {'name': {'type': ['string', 'null']}, 'environmentId': {'type': 'string'}}}, 'memoryContract': {'type': 'object', 'properties': {'groundRules': {'type': ['string', 'null']}, 'itemIdentity': {'type': ['string', 'null']}, 'memoryInstruction': {'type': ['string', 'null']}}, 'description': 'Echo of the stored tracking contract (the three authored fields) — absent when the workflow has none'}}}

{'type': 'object', 'required': ['sessionId', 'taskId'], 'properties': {'taskId': {'type': 'string', 'description': 'Task ID to check'}, 'sessionId': {'type': 'string', 'description': 'Session ID'}}}

{'type': 'object', 'required': ['status'], 'properties': {'data': {'type': 'object', 'description': 'Task output payload when completed (instance-authored shape)', 'additionalProperties': True}, 'type': {'type': 'string', 'description': 'Raw result type when the task finished'}, 'status': {'type': 'string', 'description': "Task/session state: 'completed', 'failed', 'awaiting_input', 'pending', 'active', 'paused', 'orphaned', or 'not_found'"}, 'taskId': {'type': 'string'}, 'message': {'type': 'string'}, 'sessionId': {'type': 'string'}, 'liveViewURL': {'type': 'string', 'description': 'Page for watching the run live, present while it is still running or awaiting input. The only URL here that is safe to show a user or open in a browser.'}}, 'additionalProperties': True}

{'type': 'object', 'required': [], 'properties': {'title': {'type': 'string', 'description': 'Exact workflow title (case-insensitive) — alternative to workflowId'}, 'workflowId': {'type': 'string', 'description': '24-hex workflow id (from list_workflows or create_workflow)'}}}

{'type': 'object', 'required': ['workflowId', 'slug', 'title', 'promptTemplate'], 'properties': {'slug': {'type': 'string'}, 'notes': {'type': 'array', 'items': {'type': 'string'}}, 'title': {'type': 'string'}, 'trigger': {'type': ['object', 'null']}, 'schedule': {'type': ['object', 'null']}, 'variables': {'type': 'array', 'items': {'type': 'string'}}, 'outputType': {'type': 'string'}, 'workflowId': {'type': 'string'}, 'environmentId': {'type': ['string', 'null']}, 'totalTriggers': {'type': 'number'}, 'promptTemplate': {'type': 'string'}, 'scheduleDescription': {'type': ['string', 'null']}}, 'additionalProperties': True}

{'type': 'object', 'required': ['sessionId'], 'properties': {'files': {'type': 'array', 'items': {'type': 'string'}, 'description': "Optional file IDs to attach: ids returned by POST /files/upload, or any file already in one of the user's environment catalogs (GET /environments/:id/files). Max 5 files."}, 'newState': {'enum': ['resume', 'deny'], 'type': 'string', 'description': "How to continue: 'resume' (default) provides the requested input and continues the task; 'deny' declines the request (response text optional)."}, 'response': {'type': 'string', 'description': "Your response/instructions to the agent. Required when newState is 'resume'."}, 'sessionId': {'type': 'string', 'description': 'Session ID'}}}

{'type': 'object', 'required': ['success'], 'properties': {'taskId': {'type': ['string', 'null']}, 'message': {'type': 'string', 'description': 'What happened and what to do next (poll get_task_status)'}, 'success': {'type': 'boolean'}, 'sessionId': {'type': 'string'}}, 'additionalProperties': True}

{'type': 'object', 'required': [], 'properties': {'scope': {'enum': ['environment', 'all'], 'type': 'string', 'description': "'environment' (default when bound) lists agents in the bound environment; 'all' lists every agent on the account."}}}

{'type': 'object', 'required': ['agents', 'count', 'scope'], 'properties': {'count': {'type': 'number'}, 'scope': {'enum': ['environment', 'all'], 'type': 'string'}, 'agents': {'type': 'array', 'items': {'type': 'object', 'required': ['agentId', 'name', 'status', 'standalone'], 'properties': {'name': {'type': 'string'}, 'status': {'type': 'string', 'description': "'active' | 'paused' | 'completed' | 'failed'"}, 'agentId': {'type': 'string'}, 'schedule': {'type': ['string', 'null'], 'description': 'Humanized schedule'}, 'timezone': {'type': 'string'}, 'workflow': {'type': 'object', 'properties': {'title': {'type': ['string', 'null']}, 'workflowId': {'type': 'string'}}, 'description': 'Present when deployed from a workflow'}, 'expiresAt': {'type': ['string', 'null']}, 'lastRunAt': {'type': ['string', 'null']}, 'nextRunAt': {'type': ['string', 'null']}, 'totalRuns': {'type': 'number'}, 'standalone': {'type': 'boolean', 'description': 'True when the agent carries its own prompt (not deployed from a workflow)'}, 'deliveryMode': {'type': 'string'}, 'pausedReason': {'type': 'string', 'description': "Why a paused agent stopped: 'manual', 'login_wall', 'expired', 'list_complete'"}, 'environmentId': {'type': ['string', 'null']}, 'promptPreview': {'type': ['string', 'null']}}}}}}

{'type': 'object', 'required': [], 'properties': {}}

{'type': 'object', 'required': ['environments', 'count'], 'properties': {'hint': {'type': 'string'}, 'count': {'type': 'number'}, 'environments': {'type': 'array', 'items': {'type': 'object', 'required': ['environmentId'], 'properties': {'name': {'type': ['string', 'null']}, 'bound': {'type': 'boolean', 'description': 'True for the environment this MCP connection is bound to'}, 'createdAt': {'type': 'string', 'description': 'ISO 8601 timestamp'}, 'hasMemory': {'type': 'boolean'}, 'description': {'type': ['string', 'null']}, 'environmentId': {'type': 'string'}}}}, 'boundEnvironment': {'type': 'object', 'properties': {'name': {'type': ['string', 'null']}, 'environmentId': {'type': 'string'}}}}}

{'type': 'object', 'required': [], 'properties': {}}

{'type': 'object', 'required': ['sessions', 'count'], 'properties': {'count': {'type': 'number'}, 'sessions': {'type': 'array', 'items': {'type': 'object', 'required': ['sessionId', 'status'], 'properties': {'task': {'type': ['string', 'null'], 'description': 'Prompt of the most recent task, if any'}, 'status': {'type': 'string'}, 'createdAt': {'type': 'string', 'description': 'ISO 8601 timestamp'}, 'sessionId': {'type': 'string'}}}}}}

{'type': 'object', 'required': [], 'properties': {'scope': {'enum': ['environment', 'all'], 'type': 'string', 'description': "'environment' (default when this connection is bound to one) lists workflows deployed to the bound environment; 'all' lists every workflow on the account."}}}

{'type': 'object', 'required': ['workflows', 'count', 'scope'], 'properties': {'count': {'type': 'number'}, 'scope': {'enum': ['environment', 'all'], 'type': 'string'}, 'workflows': {'type': 'array', 'items': {'type': 'object', 'required': ['workflowId', 'title', 'slug'], 'properties': {'slug': {'type': 'string'}, 'title': {'type': 'string'}, 'schedule': {'type': ['string', 'null'], 'description': 'Humanized saved schedule (record-only — runs on a timer only when deployed as a scheduled agent)'}, 'variables': {'type': 'array', 'items': {'type': 'string'}, 'description': '{{variable}} names the promptTemplate expects'}, 'workflowId': {'type': 'string'}, 'triggerType': {'type': 'string', 'description': "'cron' | 'external' | 'manual'"}, 'environmentId': {'type': ['string', 'null']}, 'totalTriggers': {'type': 'number'}, 'lastTriggeredAt': {'type': ['string', 'null'], 'description': 'ISO 8601 timestamp'}, 'shortDescription': {'type': 'string'}}}}}}

{'type': 'object', 'required': ['agentId'], 'properties': {'agentId': {'type': 'string', 'description': '24-hex agent id (from list_agents or create_agent)'}}}

{'type': 'object', 'required': ['success', 'agentId', 'status'], 'properties': {'name': {'type': 'string'}, 'status': {'type': 'string'}, 'agentId': {'type': 'string'}, 'message': {'type': 'string'}, 'success': {'type': 'boolean'}}}

{'type': 'object', 'required': ['sessionId'], 'properties': {'sessionId': {'type': 'string', 'description': 'Session ID'}}}

{'type': 'object', 'required': ['success', 'sessionId', 'action', 'message'], 'properties': {'action': {'type': 'string', 'description': 'The control action that was applied'}, 'message': {'type': 'string'}, 'success': {'type': 'boolean'}, 'sessionId': {'type': 'string'}}}

{'type': 'object', 'required': ['agentId'], 'properties': {'agentId': {'type': 'string', 'description': '24-hex agent id (from list_agents)'}}}

{'type': 'object', 'required': ['success', 'agentId', 'status'], 'properties': {'name': {'type': 'string'}, 'status': {'type': 'string'}, 'agentId': {'type': 'string'}, 'message': {'type': 'string'}, 'success': {'type': 'boolean'}, 'nextRunAt': {'type': ['string', 'null']}}}

{'type': 'object', 'required': ['sessionId'], 'properties': {'sessionId': {'type': 'string', 'description': 'Session ID'}}}

{'type': 'object', 'required': ['success', 'sessionId', 'action', 'message'], 'properties': {'action': {'type': 'string', 'description': 'The control action that was applied'}, 'message': {'type': 'string'}, 'success': {'type': 'boolean'}, 'sessionId': {'type': 'string'}}}

{'type': 'object', 'required': ['sessionId'], 'properties': {'sessionId': {'type': 'string', 'description': 'Session ID'}}}

{'type': 'object', 'properties': {'error': {'type': 'string'}, 'message': {'type': 'string'}, 'success': {'type': 'boolean'}, 'sessionId': {'type': 'string'}}, 'description': 'Capture confirmation — the screenshot itself is returned as inline image content alongside this.', 'additionalProperties': True}

{'type': 'object', 'required': ['sessionId', 'prompt'], 'properties': {'files': {'type': 'array', 'items': {'type': 'string'}, 'description': "Optional file IDs to attach: ids returned by POST /files/upload, or any file already in one of the user's environment catalogs (GET /environments/:id/files). Max 5 files."}, 'prompt': {'type': 'string', 'description': 'Task description'}, 'secrets': {'type': 'array', 'items': {'type': 'object'}, 'description': 'Domain-matched secrets [{match, fields}] (not stored)'}, 'webhook': {'type': 'object', 'description': 'Webhook configuration'}, 'sessionId': {'type': 'string', 'description': 'Session ID from create_session'}, 'outputType': {'enum': ['text', 'structured_json', 'structured_csv'], 'type': 'string', 'description': 'Response format'}, 'maxDuration': {'type': 'number', 'description': 'Max duration for this task in minutes (3-60). Defaults to the value the session was created with.'}, 'startingUrl': {'type': 'string', 'description': 'URL to navigate to before starting this task (optional)'}, 'outputSchema': {'type': 'object', 'description': 'JSON Schema for structured output (required if outputType is structured_json)'}, 'maxInputTokens': {'type': 'number', 'description': 'Max input tokens for this task (100-3000000). Defaults to the value the session was created with.'}, 'maxOutputTokens': {'type': 'number', 'description': 'Max output tokens for this task (100-1000000). Defaults to the value the session was created with.'}, 'terminateOnCompletion': {'type': 'boolean', 'description': 'Auto-terminate after task (default: false)'}}}

{'type': 'object', 'properties': {'data': {'type': 'object', 'description': 'Task output payload (instance-authored shape)', 'additionalProperties': True}, 'type': {'type': 'string', 'description': "Result type, e.g. 'task_completed', 'task_failed', 'guardrail_trigger'"}, 'error': {'type': 'string'}, 'status': {'type': 'string', 'description': "Present on guardrail results: 'awaiting_input'"}, 'taskId': {'type': ['string', 'null']}, 'message': {'type': 'string'}, 'pending': {'type': 'boolean', 'description': 'True when the task is still running — poll get_task_status'}, 'success': {'type': 'boolean'}, 'sessionId': {'type': 'string'}, 'environment': {'type': 'object', 'properties': {'name': {'type': ['string', 'null']}, 'environmentId': {'type': 'string'}}}, 'liveViewURL': {'type': 'string', 'description': 'Page for watching the run live, present while it is still running or awaiting input. The only URL here that is safe to show a user or open in a browser.'}}, 'description': 'Task outcome envelope: a completion (success/type/data), a pending marker (poll get_task_status), or an awaiting_input guardrail. `data` is the task output; its shape is task-defined (freeform text or the caller-supplied structured schema).', 'additionalProperties': True}

{'type': 'object', 'required': ['sessionId'], 'properties': {'sessionId': {'type': 'string', 'description': 'Session ID'}}}

{'type': 'object', 'required': ['success', 'sessionId', 'action', 'message'], 'properties': {'action': {'type': 'string', 'description': 'The control action that was applied'}, 'message': {'type': 'string'}, 'success': {'type': 'boolean'}, 'sessionId': {'type': 'string'}}}

{'type': 'object', 'required': ['sessionId'], 'properties': {'sessionId': {'type': 'string', 'description': 'Session ID'}}}

{'type': 'object', 'required': ['success', 'sessionId', 'action', 'message'], 'properties': {'action': {'type': 'string', 'description': 'The control action that was applied'}, 'message': {'type': 'string'}, 'success': {'type': 'boolean'}, 'sessionId': {'type': 'string'}}}

{'type': 'object', 'required': [], 'properties': {'force': {'type': 'boolean', 'description': 'Work-list workflows only: when the list reports complete, re-open it for a fresh full pass.'}, 'title': {'type': 'string', 'description': 'Exact workflow title (case-insensitive) — alternative to workflowId'}, 'variables': {'type': 'object', 'description': "Values for the workflow's {{variables}}, keyed by exact variable name. Merged over the workflow's stored variableValues defaults.", 'additionalProperties': {'type': 'string'}}, 'workflowId': {'type': 'string', 'description': '24-hex workflow id'}}}

{'type': 'object', 'required': ['success', 'workflowId'], 'properties': {'taskId': {'type': ['string', 'null']}, 'message': {'type': 'string'}, 'success': {'type': 'boolean'}, 'sessionId': {'type': 'string', 'description': 'Poll get_task_status with this id'}, 'workflowId': {'type': 'string'}, 'liveViewURL': {'type': 'string', 'description': 'Page for watching the run live, present when a run started. The only URL here that is safe to show a user or open in a browser.'}, 'listComplete': {'type': 'boolean', 'description': 'Work-list workflows: every item has been visited (no run started)'}}}

{'type': 'object', 'required': ['workflowId'], 'properties': {'flow': {'type': 'object', 'description': 'Dashboard flow diagram: { trigger: {kind, phrase}, steps: [{ primary: {label, domain}, verb }] }.'}, 'model': {'type': 'string', 'maxLength': 60, 'description': 'Model profile key. Omit for the account default.'}, 'proxy': {'type': 'object', 'properties': {'host': {'type': 'string'}, 'port': {'type': 'number'}, 'type': {'enum': ['http', 'socks'], 'type': 'string'}, 'level': {'enum': ['system', 'chrome'], 'type': 'string'}, 'source': {'enum': ['WebRun', 'custom'], 'type': 'string'}, 'country': {'type': 'string', 'description': '2-letter ISO code or "random" (WebRun).'}, 'password': {'type': 'string'}, 'username': {'type': 'string'}}, 'description': 'Proxy for runs. {source:"WebRun", country?} or {source:"custom", type:"http"|"socks", host, port, username?, password?}. Custom passwords are encrypted at rest and never returned. Social/messaging workflows (WhatsApp, Telegram, Instagram, Facebook, X, LinkedIn, TikTok): set country to the country the user is in right now — recommend it and confirm the country with them first; a mismatch is the usual cause of refused logins and sessions that log out repeatedly, and a scheduled workflow re-hits it every run, so keep the country stable once set.'}, 'title': {'type': 'string', 'maxLength': 120, 'description': 'Workflow title (shown on the dashboard).'}, 'memory': {'type': 'string', 'maxLength': 10000, 'description': "The agent's private notebook: shown to it at the start of every run, updated automatically after each run. Seed it ONLY with durable facts the next run must already know — the exact description of a target item (e.g. the specific picture to match), user preferences, known starting state — one short line per fact. Do NOT put task steps here (promptTemplate) or tracking rules here (memoryContract). Most workflows need no seed at all: the agent builds its own notebook as it runs."}, 'skills': {'type': 'array', 'items': {'type': 'object'}, 'description': 'Workflow-scoped skill entries (dashboard shape).'}, 'trigger': {'type': 'object', 'properties': {'via': {'type': ['string', 'null'], 'maxLength': 50, 'description': "e.g. 'direct', 'n8n'"}, 'type': {'enum': ['cron', 'external', 'manual'], 'type': 'string'}, 'source': {'type': 'string', 'maxLength': 50, 'description': "e.g. 'cron', 'manual', 'gmail', 'webhook', 'hubspot'"}}, 'description': "How the workflow is meant to be invoked (informational — see notes). Defaults to {type:'manual', source:'manual'}."}, 'listType': {'enum': ['static', 'dynamic', 'monitor'], 'type': 'string', 'description': "Advanced — defaults automatically ('monitor' when memoryContract is supplied); leave unset."}, 'schedule': {'type': 'object', 'properties': {'at': {'type': 'string', 'description': 'ISO 8601 date-time (type "at").'}, 'cron': {'type': 'string', 'description': '5-field cron expression (type "cron").'}, 'type': {'enum': ['at', 'every', 'cron', None], 'type': ['string', 'null']}, 'interval': {'type': 'number', 'description': 'Repeat interval in ms, min 60000 (type "every").'}, 'timezone': {'type': 'string', 'description': 'IANA timezone for the schedule. Default UTC.'}}, 'description': 'Saved schedule setting. NOTE: record-only — the workflow does NOT run on a timer until deployed as a scheduled agent (dashboard or Telegram bot).'}, 'timezone': {'type': 'string', 'maxLength': 60, 'description': 'IANA timezone for runs of this workflow (e.g. "America/New_York"). Leave unset to follow the proxy country.'}, 'department': {'type': 'string', 'maxLength': 100, 'description': 'Free-text department label (e.g. "inventory").'}, 'outputType': {'enum': ['text', 'structured', 'structured_csv'], 'type': 'string', 'description': "Output contract: 'text' (default), 'structured' (JSON matching outputSchema), 'structured_csv' (rows for the outputSchema column names)."}, 'workflowId': {'type': 'string', 'description': '24-hex id of the workflow to update (from list_workflows or create_workflow). Required — the title property here is the NEW title for renames, never an identifier.'}, 'destination': {'type': 'object', 'properties': {'sub': {'type': ['string', 'null']}, 'type': {'type': ['string', 'null']}, 'description': {'type': 'string'}}, 'description': "Result destination chip: { type, sub, description }. Types seen: 'custom-api', 'slack', 'sheets', 'email', 'messaging', 'telegram', 'crm'."}, 'startingUrl': {'type': 'string', 'maxLength': 2000, 'description': 'Page Chrome opens at the start of each run. Omit to let the prompt decide.'}, 'useCaseTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 60}, 'description': 'Categorisation tags.'}, 'fileDeferred': {'type': 'boolean', 'description': 'Dashboard flag: file selection deferred to run time.'}, 'outputSchema': {'type': ['object', 'array'], 'description': 'JSON Schema object (outputType "structured") or array of column-name strings (outputType "structured_csv").'}, 'reachOutMode': {'enum': ['off', 'guardrail_only', 'full', None], 'type': ['string', 'null'], 'description': "Proactive-chat policy for runs: 'off', 'guardrail_only', or 'full'. Omit (or pass null) to inherit the account default (MCP-initiated runs treat inherit as 'off')."}, 'wizardPreset': {'type': 'object', 'description': 'Dashboard wizard preset: { technology, useCases[], destination, destinationSub }.'}, 'environmentId': {'type': 'string', 'description': 'Move the workflow to a different environment you own. Refused while that would leave attached files or scheduled agents behind: pass requiredFiles (files in the new environment, or []) in the same update, and remove its scheduled agents first.'}, 'memoryEnabled': {'type': 'boolean', 'description': 'Persist per-workflow agent memory across runs (default true).'}, 'publicDraftId': {'type': 'string', 'maxLength': 64, 'description': 'Dashboard public-draft correlation id.'}, 'requiredFiles': {'type': 'array', 'items': {'type': 'object', 'required': ['fileId'], 'properties': {'size': {'type': 'number'}, 'fileId': {'type': 'string'}, 'originalName': {'type': 'string'}, 'environmentId': {'type': 'string', 'description': "Optional. If given, must be the workflow's own environment (24-hex)."}}}, 'description': "Files attached to every run (downloaded before the agent starts). Each fileId must already be in the workflow's own environment (GET /environments/:id/files) — a workflow only uses files from its own environment. originalName and size are filled from that catalog."}, 'roiHourlyRate': {'type': ['number', 'null'], 'description': 'Hourly rate for the ROI card.'}, 'triggerPhrase': {'type': 'string', 'maxLength': 200, 'description': 'Natural-language phrase that invokes this workflow in chat.'}, 'memoryContract': {'type': 'object', 'properties': {'groundRules': {'type': 'string', 'maxLength': 1500, 'description': 'Standing rules the agent follows on every turn of every run: what it must never do, what counts as proof a step actually succeeded, what to do when something looks ambiguous, and any pacing or volume limits. Short bullets.'}, 'itemIdentity': {'type': 'string', 'maxLength': 300, 'description': 'What tells one item apart from another, and stays the same the next time the agent sees it. Use only details visible on screen — for example where it came from, who it is from, when it appeared, and its opening words — and say how to write it the same way every time.'}, 'memoryInstruction': {'type': 'string', 'maxLength': 1500, 'description': 'When a single item counts as finished, and what happens to everything else. State plainly what must be true before an item is considered done, what to do when the agent cannot tell whether a past item was done, and what happens to items left over at the end of a run.'}}, 'description': "How this workflow should behave and what it must remember between runs. REQUIRED whenever the task handles each thing once — new messages, forward once, skip anything already done. Write all three fields in plain English, addressed to the agent; the platform wires the tracking itself. Never write any of this into the prompt: the prompt says what to do, this says how to do it consistently. To explicitly disable tracking for a task that looks like it needs it, pass {mode:'none'}."}, 'policyOptedOut': {'type': 'boolean', 'description': "Opt this workflow out of the environment's default policy."}, 'promptTemplate': {'type': 'string', 'maxLength': 5000, 'description': 'The task the browser agent runs, written as a BROWSING RUNBOOK. Structure it as: `Goal:` — one sentence naming the outcome. `Ground rules (every stage, every turn):` — bullet invariants when the task needs them, e.g. work one item at a time — never batch; only record a figure you can read on screen this turn — if it is not shown record it as "not stated", never estimate; keep a running tally and restate it every turn ("captured C items · written R rows"). Then `Stage N — <Site name> (<https://url>)` — one section per website or phase, listing the concrete steps to take in the browser (open/navigate, click, read, capture, compare, flag) in the order a person would do them, each stage ending with `Done when: <verifiable completion condition>`. Finish with `Output —` stating exactly what to produce or deliver once the final tally is met, including what to say when there is no data (never fabricate a row). When a stage delivers per-recipient (message/email each customer), state the MATCHING RULE in that stage — the identifier shared by the source record and the destination recipient (e.g. the customer name exactly as written in the source, matched against the contact name) — and the no-match branch: skip it and report it, never deliver to a similarly-named near-match. Write the user\'s CONCRETE values (group names, URLs, numbers) directly into the text; use {{variables}} ONLY when the user explicitly wants a reusable template whose inputs change per run. A short single-site task can be just a Goal plus its steps. PURE TASK ONLY — never write memory bookkeeping into the prompt (no "check memory", "record in memory", "store in memory" steps): tracking is authored in memoryContract and WebRun applies it to every run automatically.'}, 'refineMessages': {'type': 'array', 'items': {'type': 'object', 'properties': {'role': {'type': 'string'}, 'content': {'type': 'string'}}}, 'description': 'Dashboard builder refinement thread rows: [{ role, content }].'}, 'variableValues': {'type': 'object', 'description': 'ONLY for explicitly dynamic workflows: default values for {{variables}}, keyed by variable name. NOTE: applied only when triggering via MCP trigger_workflow (merged under caller-supplied variables); REST /trigger and bot triggers ignore this field.', 'additionalProperties': {'type': 'string'}}, 'compatibleTools': {'type': 'array', 'items': {'type': 'object', 'properties': {'name': {'type': 'string'}, 'role': {'type': 'string'}, 'domain': {'type': 'string'}, 'loginUrl': {'type': 'string'}}}, 'description': 'Sites/tools the workflow uses: [{ name, loginUrl, domain, role }].'}, 'conciergeNotify': {'type': 'string', 'maxLength': 50, 'description': "Where the concierge announces results (e.g. 'Telegram', 'Slack', 'WhatsApp', 'Microsoft Teams', 'concierge')."}, 'workListEnabled': {'type': 'boolean', 'description': 'Advanced — set automatically when memoryContract is supplied; leave unset.'}, 'deployedPolicyId': {'type': 'string', 'maxLength': 24, 'description': 'Policy id to run under (must be owned by you).'}, 'orchestrateFirst': {'type': 'boolean', 'description': 'Discovery mode: one run gathers the WHOLE work list up front, later runs claim one item each.'}, 'shortDescription': {'type': 'string', 'maxLength': 500, 'description': 'One-line summary shown in workflow lists.'}, 'roiMinutesPerTask': {'type': ['number', 'null'], 'description': 'Minutes saved per run (dashboard ROI card).'}, 'templateVariables': {'type': 'array', 'items': {'type': 'object', 'required': ['name'], 'properties': {'kind': {'type': 'string', 'description': "e.g. 'config'"}, 'name': {'type': 'string', 'description': 'Must match a {{name}} in promptTemplate ([a-zA-Z0-9_]).'}, 'type': {'type': 'string', 'description': "e.g. 'text', 'keywords'"}, 'label': {'type': 'string'}, 'prompt': {'type': 'string', 'description': 'Question to ask the user for this value.'}, 'required': {'type': 'boolean'}, 'sampleValue': {'type': 'string'}}}, 'description': 'ONLY for explicitly dynamic workflows (the user asked for a reusable template): metadata for the {{variables}} used in promptTemplate (drives the dashboard fill-in UI). Omit entirely when the prompt carries concrete values.'}}, 'description': 'Supply only the fields to change. Object/array fields are replaced whole. Pass null to clear an optional field. Renaming via title does not change the slug.'}

{'type': 'object', 'required': ['success', 'workflowId', 'changes'], 'properties': {'slug': {'type': 'string'}, 'notes': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Caveats to relay (record-only schedule, linked scheduled agents, prompt-structure advice)'}, 'title': {'type': 'string'}, 'changes': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Human-readable field: old → new summaries of what was applied (empty when everything supplied matched the current values)'}, 'success': {'type': 'boolean'}, 'workflowId': {'type': 'string'}}}