Prerequisites
- An active Cyberdesk subscription (if you’re not on a paid plan, book a demo)
- A Cyberdesk account (sign up here)
- Node.js 14+ or Python 3.10+ for SDK usage
- Windows machine for desktop automation
Step 1: Create a workflow in the dashboard
Workflows define the tasks you want to automate. Let’s create your first one.Navigate to Workflows
Go to the Cyberdesk Dashboard and click on Workflows in the sidebar.
Define your workflow
Fill in the workflow details:
- Name (optional): Give your workflow a descriptive name like “Extract Patient Data”
- Main Prompt: This is the instruction that tells AI what to do. For example:
You can also add images to the prompt from the dashboard editor (click Add Image). Images help the agent understand tricky icons and UI elements in legacy apps.
- Input Schema (optional): Define expected run inputs with JSON Schema. This validates the merged run payload (
input_values+sensitive_input_values+ machine/session values) before execution. Ininput_schema, sensitive root keys use a$prefix (for example,"$api_key"). - Output Schema (optional): Define the structure of data you want back using JSON Schema
AI Assist Feature: Instead of writing prompts manually, you can use our AI assist feature:
- Type a natural language description of what you want to automate
- Click Apply
- AI will create a detailed prompt for you
- You can send follow-up instructions to refine the prompt - AI uses the current field contents as context
Step 2: Install Cyberdriver
Cyberdriver connects your desktop to Cyberdesk, enabling remote automation.Cyberdriver will automatically request administrator privileges when it runs.
Make sure you have the necessary permissions or administrator password
available, as this is required for automating certain desktop applications.
Connect to Cyberdesk
YOUR_API_KEY with your actual API key from the Cyberdesk Dashboard.Step 3: Create a run via SDK
Now let’s execute your workflow programmatically using the SDK.If your workflow defines an Input Schema and provided inputs do not match, the API returns a
422 validation error with path-level details so you can fix the payload before retrying.Step 4: View results in the dashboard
After your run completes, you can view detailed information in the dashboard.Navigate to Runs
Go to the Runs page in your dashboard.
View run details
Click on your run to see:
- Status: Current state of the run
- Output Data: The extracted/processed data based on your output schema
- Message History: Complete conversation between AI and your desktop
Generate and approve workflow trajectories
From the run details panel:
- Click Generate Trajectory (when available) to promote that run’s captured path into your workflow trajectory library
- Review step-by-step actions with screenshots
- Approve trajectories to enable fast cached execution on future runs
Trajectories are Cyberdesk’s intelligent caching system. Capture happens in the background during runs, generation makes a trajectory visible/reviewable, and approval enables replay. Learn more in Trajectories 101.
What’s next?
SDK Guides
Deep dive into SDK features and advanced usage patterns
Workflow Prompting
Master workflow prompting with specialized tools and best practices
Trajectories 101
Learn how trajectories speed up workflows by caching successful executions
API Reference
Explore all available API endpoints
Learn More
Extract Prompt
Vision-based extraction with async processing modes
Focused Action
Dynamic observations and decisions in workflows
Looping Tools
Repeat workflow steps over arrays or counts efficiently
Generating Output Data
How observations transform into structured output
Async Extraction Patterns
Optimize workflow performance with batch and run-scoped async