# Cyberdesk Docs

## Docs

- [Usage-Based Billing](https://docs.cyberdesk.io/additional-details/usage-based-billing.md): Understand how Cyberdesk meters and bills your usage
- [Click mouse button](https://docs.cyberdesk.io/api-reference/computer/click-mouse-button.md): Click the mouse button at specified coordinates. If coordinates are not provided, clicks at current position.
- [Copy to clipboard via Ctrl+C](https://docs.cyberdesk.io/api-reference/computer/copy-to-clipboard-via-ctrl+c.md): Execute Ctrl+C and return clipboard contents with the specified key name.
- [Drag mouse (native)](https://docs.cyberdesk.io/api-reference/computer/drag-mouse-native.md): Perform a drag operation using absolute coordinates with required start and optional duration.
- [Execute PowerShell command](https://docs.cyberdesk.io/api-reference/computer/execute-powershell-command.md): Execute PowerShell command on the machine.
- [Get display dimensions](https://docs.cyberdesk.io/api-reference/computer/get-display-dimensions.md): Get the display dimensions of the machine.
- [Get mouse position](https://docs.cyberdesk.io/api-reference/computer/get-mouse-position.md): Get the current mouse cursor position.
- [List directory contents](https://docs.cyberdesk.io/api-reference/computer/list-directory-contents.md): List directory contents on the machine.
- [Manage PowerShell session](https://docs.cyberdesk.io/api-reference/computer/manage-powershell-session.md): Create or destroy PowerShell sessions on the machine.
- [Move mouse cursor](https://docs.cyberdesk.io/api-reference/computer/move-mouse-cursor.md): Move the mouse cursor to specified coordinates.
- [Read file contents](https://docs.cyberdesk.io/api-reference/computer/read-file-contents.md): Read file contents from the machine (base64 encoded).
- [Scroll mouse wheel](https://docs.cyberdesk.io/api-reference/computer/scroll-mouse-wheel.md): Scroll the mouse wheel in the specified direction by a number of steps. Optionally moves to (x, y) before scrolling.
- [Send key combination](https://docs.cyberdesk.io/api-reference/computer/send-key-combination.md): Send a key combination (e.g., 'ctrl+a', 'alt+tab').
- [Shutdown Cyberdriver via tunnel](https://docs.cyberdesk.io/api-reference/computer/shutdown-cyberdriver-via-tunnel.md): Request CyberDriver process shutdown through the existing tunnel proxy path.
- [Take a screenshot](https://docs.cyberdesk.io/api-reference/computer/take-a-screenshot.md): Take a screenshot of the machine's display.
- [Type text](https://docs.cyberdesk.io/api-reference/computer/type-text.md): Type text on the machine's keyboard.
- [Write file contents](https://docs.cyberdesk.io/api-reference/computer/write-file-contents.md): Write file contents to the machine.
- [Create Connection](https://docs.cyberdesk.io/api-reference/connections/create-connection.md): Create a new connection (typically done by the WebSocket handler).
- [Delete Connection](https://docs.cyberdesk.io/api-reference/connections/delete-connection.md): Delete a connection (not typically used - connections are managed automatically).
- [Get Connection](https://docs.cyberdesk.io/api-reference/connections/get-connection.md): Get a specific connection by ID.
- [List Connections](https://docs.cyberdesk.io/api-reference/connections/list-connections.md): List all connections for the authenticated organization's machines.
- [Update Connection](https://docs.cyberdesk.io/api-reference/connections/update-connection.md): Update a connection's status or timestamps.
- [Health](https://docs.cyberdesk.io/api-reference/health.md): Backward compatible health check - redirects to readiness check.
- [Health Db](https://docs.cyberdesk.io/api-reference/health-db.md): Legacy endpoint - checks database only.
- [Health Live](https://docs.cyberdesk.io/api-reference/health-live.md): Liveness probe - Is the process alive? Always returns 200 if the server can respond. Use this for: Kubernetes liveness probes, basic "is it up" checks.
- [Health Ready](https://docs.cyberdesk.io/api-reference/health-ready.md): Readiness probe - Can the service handle requests? Checks all critical dependencies with timeouts. Use this for: Load balancer health checks, Better Stack monitoring. Returns 503 if any critical dependency is down.
- [Database Health Check](https://docs.cyberdesk.io/api-reference/health/database-health-check.md): Database health check endpoint.
- [Health Check](https://docs.cyberdesk.io/api-reference/health/health-check.md): Basic health check endpoint.
- [Health Machines](https://docs.cyberdesk.io/api-reference/health/health-machines.md): Probe the dimensions endpoint for all connected machines in scope.
- [API Reference](https://docs.cyberdesk.io/api-reference/introduction.md): Complete reference for all Cyberdesk API endpoints
- [Create Machine](https://docs.cyberdesk.io/api-reference/machines/create-machine.md): Create a new machine.
- [Delete Machine](https://docs.cyberdesk.io/api-reference/machines/delete-machine.md): Delete a machine.
- [Get Machine](https://docs.cyberdesk.io/api-reference/machines/get-machine.md): Get a specific machine by ID.
- [Get Machine Pools](https://docs.cyberdesk.io/api-reference/machines/get-machine-pools.md): Get all pools that a machine belongs to.
- [List Machines](https://docs.cyberdesk.io/api-reference/machines/list-machines.md): List all machines for the authenticated organization.
- [Update Machine](https://docs.cyberdesk.io/api-reference/machines/update-machine.md): Update a machine's information.
- [Update Machine Pools](https://docs.cyberdesk.io/api-reference/machines/update-machine-pools.md): Update a machine's pool assignments. This replaces all existing pool assignments with the new ones.
- [Create Model Configuration](https://docs.cyberdesk.io/api-reference/model-configurations/create-model-configuration.md)
- [Delete Model Configuration](https://docs.cyberdesk.io/api-reference/model-configurations/delete-model-configuration.md)
- [Get Model Configuration](https://docs.cyberdesk.io/api-reference/model-configurations/get-model-configuration.md)
- [List Model Configurations](https://docs.cyberdesk.io/api-reference/model-configurations/list-model-configurations.md)
- [Update Model Configuration](https://docs.cyberdesk.io/api-reference/model-configurations/update-model-configuration.md)
- [Add Machines To Pool](https://docs.cyberdesk.io/api-reference/pools/add-machines-to-pool.md): Add machines to a pool.
- [Create Pool](https://docs.cyberdesk.io/api-reference/pools/create-pool.md): Create a new pool for organizing machines.
- [Delete Pool](https://docs.cyberdesk.io/api-reference/pools/delete-pool.md): Delete a pool. This will not delete the machines in the pool.
- [Get Pool](https://docs.cyberdesk.io/api-reference/pools/get-pool.md): Get a specific pool by ID.
- [List Pools](https://docs.cyberdesk.io/api-reference/pools/list-pools.md): List all pools for the organization.
- [Remove Machines From Pool](https://docs.cyberdesk.io/api-reference/pools/remove-machines-from-pool.md): Remove machines from a pool.
- [Update Pool](https://docs.cyberdesk.io/api-reference/pools/update-pool.md): Update a pool's details.
- [Create Request Log](https://docs.cyberdesk.io/api-reference/request-logs/create-request-log.md): Create a new request log.
- [Delete Request Log](https://docs.cyberdesk.io/api-reference/request-logs/delete-request-log.md): Delete a request log (not typically used - logs are kept for analytics).
- [Get Request Log](https://docs.cyberdesk.io/api-reference/request-logs/get-request-log.md): Get a specific request log by ID.
- [List Request Logs](https://docs.cyberdesk.io/api-reference/request-logs/list-request-logs.md): List all request logs for the authenticated organization's machines.
- [Update Request Log](https://docs.cyberdesk.io/api-reference/request-logs/update-request-log.md): Update a request log with response data.
- [Root](https://docs.cyberdesk.io/api-reference/root.md): Root endpoint with service information
- [Create Run Attachment](https://docs.cyberdesk.io/api-reference/run-attachments/create-run-attachment.md): Create a new run attachment.
- [Delete Run Attachment](https://docs.cyberdesk.io/api-reference/run-attachments/delete-run-attachment.md): Delete a run attachment.
- [Download Run Attachment](https://docs.cyberdesk.io/api-reference/run-attachments/download-run-attachment.md): Download a run attachment file.
- [Get Run Attachment](https://docs.cyberdesk.io/api-reference/run-attachments/get-run-attachment.md): Get a specific run attachment by ID.
- [Get Run Attachment Download Url](https://docs.cyberdesk.io/api-reference/run-attachments/get-run-attachment-download-url.md): Get a signed download URL for a run attachment file.
- [List Run Attachments](https://docs.cyberdesk.io/api-reference/run-attachments/list-run-attachments.md): List all run attachments for the authenticated organization.
- [Update Run Attachment](https://docs.cyberdesk.io/api-reference/run-attachments/update-run-attachment.md): Update a run attachment.
- [Run complete webhook](https://docs.cyberdesk.io/api-reference/run-complete-webhook.md): Webhook schema for run completion events. Documentation-only.
- [Bulk Create Runs](https://docs.cyberdesk.io/api-reference/runs/bulk-create-runs.md): Create multiple runs with the same configuration.
- [Create Run](https://docs.cyberdesk.io/api-reference/runs/create-run.md): Create a new run.
- [Create Run Chain](https://docs.cyberdesk.io/api-reference/runs/create-run-chain.md): Create a multi-step chain that runs on a single reserved session/machine.
- [Delete Run](https://docs.cyberdesk.io/api-reference/runs/delete-run.md): Delete a run.
- [Generate Run Trajectory](https://docs.cyberdesk.io/api-reference/runs/generate-run-trajectory.md): Mark the latest trajectory for a run as generated.
- [Get Run](https://docs.cyberdesk.io/api-reference/runs/get-run.md): Get a specific run by ID.
- [Get Run Trajectory](https://docs.cyberdesk.io/api-reference/runs/get-run-trajectory.md): Get the latest trajectory associated with a run.
- [List Runs](https://docs.cyberdesk.io/api-reference/runs/list-runs.md): List all runs for the authenticated organization.
- [Retry Run](https://docs.cyberdesk.io/api-reference/runs/retry-run.md): Retry an existing run in-place (same run_id).
- [Update Run](https://docs.cyberdesk.io/api-reference/runs/update-run.md): Update a run's data.
- [Create Trajectory](https://docs.cyberdesk.io/api-reference/trajectories/create-trajectory.md): Create a new trajectory for a workflow.
- [Delete Trajectory](https://docs.cyberdesk.io/api-reference/trajectories/delete-trajectory.md): Delete a trajectory.
- [Duplicate Trajectory](https://docs.cyberdesk.io/api-reference/trajectories/duplicate-trajectory.md): Duplicate a trajectory with fresh copies of all images.
- [Get Latest Trajectory For Workflow](https://docs.cyberdesk.io/api-reference/trajectories/get-latest-trajectory-for-workflow.md): Get the latest trajectory for a specific workflow.
- [Get Trajectory](https://docs.cyberdesk.io/api-reference/trajectories/get-trajectory.md): Get a specific trajectory by ID.
- [List Trajectories](https://docs.cyberdesk.io/api-reference/trajectories/list-trajectories.md): List all trajectories for the authenticated organization.
- [Update Trajectory](https://docs.cyberdesk.io/api-reference/trajectories/update-trajectory.md): Update a trajectory's data.
- [Get Usage Aggregate](https://docs.cyberdesk.io/api-reference/usage/get-usage-aggregate.md): Aggregate usage (agentic and cached steps) for a given date range.
- [Create Tag Group](https://docs.cyberdesk.io/api-reference/workflow-tag-groups/create-tag-group.md): Create a new workflow tag group.
- [Delete Tag Group](https://docs.cyberdesk.io/api-reference/workflow-tag-groups/delete-tag-group.md): Delete a workflow tag group.
- [Get Tag Group](https://docs.cyberdesk.io/api-reference/workflow-tag-groups/get-tag-group.md): Get a specific workflow tag group by ID.
- [List Tag Groups](https://docs.cyberdesk.io/api-reference/workflow-tag-groups/list-tag-groups.md): List all workflow tag groups for the organization.
- [Reorder Tag Groups](https://docs.cyberdesk.io/api-reference/workflow-tag-groups/reorder-tag-groups.md): Reorder workflow tag groups.
- [Update Tag Group](https://docs.cyberdesk.io/api-reference/workflow-tag-groups/update-tag-group.md): Update a workflow tag group.
- [Archive Tag](https://docs.cyberdesk.io/api-reference/workflow-tags/archive-tag.md): Archive a workflow tag.
- [Create Tag](https://docs.cyberdesk.io/api-reference/workflow-tags/create-tag.md): Create a new workflow tag.
- [Delete Tag](https://docs.cyberdesk.io/api-reference/workflow-tags/delete-tag.md): Delete a workflow tag.
- [Get Tag](https://docs.cyberdesk.io/api-reference/workflow-tags/get-tag.md): Get a specific workflow tag by ID.
- [List Tags](https://docs.cyberdesk.io/api-reference/workflow-tags/list-tags.md): List all workflow tags for the organization.
- [Reorder Tags](https://docs.cyberdesk.io/api-reference/workflow-tags/reorder-tags.md): Reorder workflow tags.
- [Unarchive Tag](https://docs.cyberdesk.io/api-reference/workflow-tags/unarchive-tag.md): Unarchive a workflow tag.
- [Update Tag](https://docs.cyberdesk.io/api-reference/workflow-tags/update-tag.md): Update a workflow tag.
- [Add tags to a workflow](https://docs.cyberdesk.io/api-reference/workflows/add-tags-to-a-workflow.md): Add one or more tags to a workflow.
- [Bulk add tags to multiple workflows](https://docs.cyberdesk.io/api-reference/workflows/bulk-add-tags-to-multiple-workflows.md): Add tags to multiple workflows at once.
- [Create Workflow](https://docs.cyberdesk.io/api-reference/workflows/create-workflow.md): Create a new workflow.
- [Delete a workflow prompt image](https://docs.cyberdesk.io/api-reference/workflows/delete-a-workflow-prompt-image.md): Delete a workflow prompt image from storage.
- [Delete Workflow](https://docs.cyberdesk.io/api-reference/workflows/delete-workflow.md): Delete a workflow.
- [Duplicate Workflow](https://docs.cyberdesk.io/api-reference/workflows/duplicate-workflow.md): Duplicate a workflow, including prompt images and optional generated trajectories.
- [Get signed URL for a prompt image](https://docs.cyberdesk.io/api-reference/workflows/get-signed-url-for-a-prompt-image.md): Get a fresh signed URL for an existing workflow prompt image.
- [Get tags for a workflow](https://docs.cyberdesk.io/api-reference/workflows/get-tags-for-a-workflow.md): Get all tags assigned to a workflow.
- [Get Workflow](https://docs.cyberdesk.io/api-reference/workflows/get-workflow.md): Get a specific workflow by ID.
- [Get Workflow Versions](https://docs.cyberdesk.io/api-reference/workflows/get-workflow-versions.md): Get the version history of a workflow.
- [List workflow prompt images](https://docs.cyberdesk.io/api-reference/workflows/list-workflow-prompt-images.md): List all prompt images uploaded for the organization.
- [List Workflows](https://docs.cyberdesk.io/api-reference/workflows/list-workflows.md): List all workflows for the authenticated organization.
- [Merge Workflow](https://docs.cyberdesk.io/api-reference/workflows/merge-workflow.md): Merge the current workflow into another workflow.
- [Remove a tag from a workflow](https://docs.cyberdesk.io/api-reference/workflows/remove-a-tag-from-a-workflow.md): Remove a tag from a workflow.
- [Update Workflow](https://docs.cyberdesk.io/api-reference/workflows/update-workflow.md): Update a workflow's prompts.
- [Upload a workflow prompt image](https://docs.cyberdesk.io/api-reference/workflows/upload-a-workflow-prompt-image.md): Upload an image to use in workflow prompts.
- [Async Extraction Patterns](https://docs.cyberdesk.io/concepts/async-extraction-patterns.md): Understanding synchronous, batch-scoped, and run-scoped async extraction modes
- [Clear Values](https://docs.cyberdesk.io/concepts/clear-values.md): Use the __CLEAR__ sentinel value to intentionally clear an existing field before continuing
- [Complex Drag Actions](https://docs.cyberdesk.io/concepts/complex-drag-actions.md): Perform drag operations with hold durations using left_mouse_down and left_mouse_up
- [Custom Cache Detection Prompt](https://docs.cyberdesk.io/concepts/custom-cache-detection.md): Override cache detection logic with your own validation rules
- [Desktop Parameters](https://docs.cyberdesk.io/concepts/desktop-parameters.md): Machine-specific input values that automatically populate runs on specific desktops
- [Empty Values](https://docs.cyberdesk.io/concepts/empty-values.md): Handle optional form fields in workflows with the __EMPTY__ sentinel value
- [Generating Output Data](https://docs.cyberdesk.io/concepts/generating-output-data.md): How observations, runtime values, and extractions transform into structured workflow output
- [Holding a Key](https://docs.cyberdesk.io/concepts/holding-a-key.md): Press and hold a key while performing other actions by using the key action's down parameter.
- [Input Validation](https://docs.cyberdesk.io/concepts/input-validation.md): Validate workflow run inputs with JSON Schema before execution
- [Model Configuration](https://docs.cyberdesk.io/concepts/model-configuration.md): Configure which AI models power your workflow agents and actions
- [Post-run Checks](https://docs.cyberdesk.io/concepts/post-run-checks.md): Verify exported files, screenshots, and structured output after workflow execution finishes
- [Sessions and Chains](https://docs.cyberdesk.io/concepts/sessions-and-chains.md): Reserve machines for multi-step workflows with exclusive access
- [Structured Inputs](https://docs.cyberdesk.io/concepts/structured-inputs.md): Pass complex, nested data structures as workflow inputs instead of flattening into dozens of variables
- [Trajectories](https://docs.cyberdesk.io/concepts/trajectories.md): Understanding how Cyberdesk records, validates, and replays workflow executions
- [Windows VM 101](https://docs.cyberdesk.io/concepts/windows-vm-101.md): Set up a reliable Windows environment for desktop automation
- [Workflow Duplication & Merge](https://docs.cyberdesk.io/concepts/workflow-duplication-and-merge.md): Duplicate a workflow to branch, iterate, or merge changes back
- [Workflow Tags & Groups](https://docs.cyberdesk.io/concepts/workflow-tags.md): Organize your workflows with tags and tag groups for better filtering, categorization, and team collaboration
- [Run Cyberdriver on Logon](https://docs.cyberdesk.io/cyberdriver/autostart.md): Configure Windows Task Scheduler to automatically run cyberdriver join on user logon
- [Black Screen Recovery](https://docs.cyberdesk.io/cyberdriver/black-screen-recovery.md): Automatically recover from RDP display issues on Windows
- [Console Protection](https://docs.cyberdesk.io/cyberdriver/console-protection.md): Prevent accidental termination when running in foreground mode
- [Coordinate Capture](https://docs.cyberdesk.io/cyberdriver/coordinate-capture.md): Find screen coordinates for keepalive and automation configuration
- [Custom Host (Proxy Setup)](https://docs.cyberdesk.io/cyberdriver/custom-host.md): Route Cyberdriver traffic through your own domain for whitelisting or privacy
- [Keepalive Mode](https://docs.cyberdesk.io/cyberdriver/keepalive.md): Prevent idle timeouts and session locks with simulated user activity
- [Logs](https://docs.cyberdesk.io/cyberdriver/logs.md): View and tail Cyberdriver logs in realtime
- [Cyberdriver Installation](https://docs.cyberdesk.io/cyberdriver/quickstart.md): Install and configure Cyberdriver to enable desktop automation
- [Remote Updates](https://docs.cyberdesk.io/cyberdriver/remote-updates.md): Update Cyberdriver remotely from the dashboard without manual intervention
- [Stealth Mode](https://docs.cyberdesk.io/cyberdriver/stealth-mode.md): Cyberdriver runs invisibly in the background, immune to accidental termination
- [Persistent Virtual Display](https://docs.cyberdesk.io/cyberdriver/virtual-display.md): Keep a virtual display active even when RDP is disconnected
- [Introduction](https://docs.cyberdesk.io/index.md): Welcome to Cyberdesk Docs
- [Quick Start](https://docs.cyberdesk.io/quickstart.md): Create your first Cyberdesk workflow and run it in under 5 minutes
- [Python SDK](https://docs.cyberdesk.io/sdk-guides/python.md): Complete guide for integrating Cyberdesk into your Python applications
- [TypeScript SDK](https://docs.cyberdesk.io/sdk-guides/typescript.md): Complete guide for integrating Cyberdesk into your TypeScript/JavaScript applications
- [Detailed Webhook Guide](https://docs.cyberdesk.io/webhooks/detailed-guide.md): End-to-end guidance for implementing Cyberdesk webhooks
- [Webhooks Quickstart](https://docs.cyberdesk.io/webhooks/quickstart.md): Receive run_complete events from Cyberdesk without polling
- [Slack Integration](https://docs.cyberdesk.io/webhooks/slack-integration.md): Get notified in Slack when your runs complete
- [Webhook Transformations](https://docs.cyberdesk.io/webhooks/transformations.md): Transform webhook payloads before delivery to your endpoint
- [Zapier Integration](https://docs.cyberdesk.io/webhooks/zapier-integration.md): Connect Cyberdesk to 6,000+ apps with Zapier
- [Copy to Clipboard](https://docs.cyberdesk.io/workflow-prompting/copy-to-clipboard.md): Deterministic data extraction via clipboard as an alternative to vision-based extraction
- [Declare Task Failed](https://docs.cyberdesk.io/workflow-prompting/declare-task-failed.md): Define failure conditions to terminate workflows when errors occur
- [Declare Task Succeeded](https://docs.cyberdesk.io/workflow-prompting/declare-task-succeeded.md): Allow focused actions to signal workflow completion when success conditions are met
- [Execute Batch Tools](https://docs.cyberdesk.io/workflow-prompting/execute-batch-tools.md): Bundle multiple computer actions into a single, faster trajectory step
- [Execute Terminal Command](https://docs.cyberdesk.io/workflow-prompting/execute-terminal.md): Run PowerShell commands on Windows machines during workflows
- [Extract Prompt](https://docs.cyberdesk.io/workflow-prompting/extract-prompt.md): Vision-based data extraction with flexible async processing modes
- [Focused Action](https://docs.cyberdesk.io/workflow-prompting/focused-action.md): Capture dynamic content and make context-aware decisions in cached workflows
- [Get Main Instructions](https://docs.cyberdesk.io/workflow-prompting/get-main-instructions.md): Let focused action agents reread the main workflow instructions when you explicitly allow it
- [Grab Reference Image](https://docs.cyberdesk.io/workflow-prompting/grab-reference-image.md): Use prompt images at runtime by filename
- [Looping Tools](https://docs.cyberdesk.io/workflow-prompting/looping-tools.md): Repeat workflow steps deterministically over arrays or counts
- [Mark File for Export](https://docs.cyberdesk.io/workflow-prompting/mark-file-for-export.md): Export files from the remote machine and attach them to workflow runs
- [Model Parameter](https://docs.cyberdesk.io/workflow-prompting/model-parameter.md): Override the AI model for specific actions in your workflow prompts
- [Prompting Overview](https://docs.cyberdesk.io/workflow-prompting/prompting-overview.md): Learn how to write effective prompts and leverage specialized tools for workflow outputs
- [Save Screenshot as Run Attachment](https://docs.cyberdesk.io/workflow-prompting/save-screenshot.md): Capture and save important visual moments from your workflows
- [Upsert Runtime Values](https://docs.cyberdesk.io/workflow-prompting/upsert-runtime-values.md): Store, merge, and accumulate runtime variables during workflow execution

## OpenAPI Specs

- [openapi](https://docs.cyberdesk.io/openapi.json)

## Optional

- [Community](https://discord.gg/ws5ddx5yZ8)