Skip to main content

​
System Requirements

Check the System Requirements Reference for detailed compatibility information.

​
Network Requirements

Review the Network Requirements Reference for connectivity information.

​
Installation Steps

1

Create an AskUI Account

Sign up at AskUI Hub to:
  • Activate your free trial (no credit card required)
  • Get your workspace ID and access token
  • Access documentation and support
2

Install AskUI Agent OS

Download and install the AskUI Agent OS for your operating system:
Download the appropriate installer:Run the installer and follow the on-screen instructions.
3

Install Python Package

Install the AskUI Python package:
pip install askui[android,web]
4

Set Up Authentication

Configure your environment variables with your credentials (Create Access Token):
# For AskUI authentication
export ASKUI_WORKSPACE_ID=<your-workspace-id>
export ASKUI_TOKEN=<your-access-token>

# For Anthropic models (optional)
export ANTHROPIC_API_KEY=<your-anthropic-api-key>
Get your Workspace Id and token from AskUI Hub
5

Verify Installation

Test your setup with a simple script:
from askui import VisionAgent

with VisionAgent() as agent:
    print("AskUI is installed and configured correctly!")
If you see the success message, you’re ready to build your first agent!

​
Troubleshooting

  • Temporarily disable antivirus software
  • Check Windows version compatibility
  • Make sure you’re using XOrg, not Wayland
  • Check display permissions: xhost +local:
  • Verify X11 forwarding if using SSH
  • Verify environment variables are set correctly
  • Check workspace ID and token from hub.askui.com
  • Ensure no extra spaces in credentials

​
Next Steps

Now that you have AskUI installed, proceed to Your First Agent to create your first automation!