# AskUI ## Docs - [Agent](https://askui-docs-streamline-documentation.mintlify.app/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/agent.md) - [Android Vision Agent](https://askui-docs-streamline-documentation.mintlify.app/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/android-vision-agent.md) - [Locators](https://askui-docs-streamline-documentation.mintlify.app/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/locators.md) - [Reporting](https://askui-docs-streamline-documentation.mintlify.app/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/reporting.md) - [Retry](https://askui-docs-streamline-documentation.mintlify.app/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/retry.md) - [Tools](https://askui-docs-streamline-documentation.mintlify.app/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/tools.md) - [Types](https://askui-docs-streamline-documentation.mintlify.app/04-reference/01-agent-frameworks/02-python/02-vision-agent-api/types.md) - [AskUI-AddProjectSettingsIfNotExist](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Debug/AskUI-AddProjectSettingsIfNotExist.md) - [AskUI-BuildErrorReport](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Debug/AskUI-BuildErrorReport.md) - [AskUI-CompressErrorReport](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Debug/AskUI-CompressErrorReport.md) - [AskUI-NewErrorReport](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Debug/AskUI-NewErrorReport.md) - [AskUI-ShowProcess](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Debug/AskUI-ShowProcess.md) - [AskUI-StopProcess](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Debug/AskUI-StopProcess.md) - [AskUI-SubmitErrorReport](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Debug/AskUI-SubmitErrorReport.md) - [AskUI-AddPlugin](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-AddPlugin.md) - [AskUI-ImportDebugCommands](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-ImportDebugCommands.md) - [AskUI-ImportExperimentalCommands](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-ImportExperimentalCommands.md) - [AskUI-NewProject](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-NewProject.md) - [AskUI-RemovePlugin](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-RemovePlugin.md) - [AskUI-RemoveSettings](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-RemoveSettings.md) - [AskUI-RunProject](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-RunProject.md) - [AskUI-SetSettings](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-SetSettings.md) - [AskUI-ShowAvailableCommands](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-ShowAvailableCommands.md) - [AskUI-ShowPlugins](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-ShowPlugins.md) - [AskUI-ShowSettings](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-ShowSettings.md) - [AskUI-ShowVersions](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-ShowVersions.md) - [AskUI-TestConnection](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/ADE/Public/AskUI-TestConnection.md) - [AskUI-AddAskUIControllerAutoRecoverService](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-AddAskUIControllerAutoRecoverService.md) - [AskUI-AddRunnerUser](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-AddRunnerUser.md) - [AskUI-DisableScreensaver](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-DisableScreensaver.md) - [AskUI-RemoveAskUIControllerAutoRecoverService](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-RemoveAskUIControllerAutoRecoverService.md) - [AskUI-SetAsGlobalInstallation](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-SetAsGlobalInstallation.md) - [AskUI-SetFirstAskUIRunner](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AsKUIWindowsRunnerTools/Experimental/AskUI-SetFirstAskUIRunner.md) - [AskUI-StartOCRTeaching](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIOCRTeaching/Public/AskUI-StartOCRTeaching.md) - [AskUI-StartRemoteDeviceSetupTool](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRemoteDeviceSetupTool/Experimental/AskUI-StartRemoteDeviceSetupTool.md) - [AskUI-NewAIElement](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRemoteDeviceSnippingTool/Public/AskUI-NewAIElement.md) - [AskUI-NewAnnotationsForTraining](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRemoteDeviceSnippingTool/Public/AskUI-NewAnnotationsForTraining.md) - [AskUI-OpenAIElement](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRemoteDeviceSnippingTool/Public/AskUI-OpenAIElement.md) - [AskUI-RemoveAIElement](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRemoteDeviceSnippingTool/Public/AskUI-RemoveAIElement.md) - [AskUI-ShowAIElement](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRemoteDeviceSnippingTool/Public/AskUI-ShowAIElement.md) - [AskUI-GetRunnerVersion](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRunnerManager/Public/AskUI-GetRunnerVersion.md) - [AskUI-InstallRunner](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRunnerManager/Public/AskUI-InstallRunner.md) - [AskUI-OpenAgent](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRunnerManager/Public/AskUI-OpenAgent.md) - [AskUI-ShowAgents](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRunnerManager/Public/AskUI-ShowAgents.md) - [AskUI-StartRunner](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRunnerManager/Public/AskUI-StartRunner.md) - [AskUI-SyncAgents](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIRunnerManager/Public/AskUI-SyncAgents.md) - [AskUI-EnableLongPath](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIWindowsTools/Public/AskUI-EnableLongPath.md) - [AskUI-TestLongPathSupport](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/AskUIWindowsTools/Public/AskUI-TestLongPathSupport.md) - [AskUI-RemoveLocalProxySettings](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/PxProxy/Public/AskUI-RemoveLocalProxySettings.md) - [AskUI-SetLocalProxySettings](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/PxProxy/Public/AskUI-SetLocalProxySettings.md) - [AskUI-StartLocalProxy](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/PxProxy/Public/AskUI-StartLocalProxy.md) - [AskUI-StopLocalProxy](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/PxProxy/Public/AskUI-StopLocalProxy.md) - [AskUI-EnablePythonEnvironment](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/Python/Public/AskUI-EnablePythonEnvironment.md) - [AskUI-NewPythonEnvironment](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/Python/Public/AskUI-NewPythonEnvironment.md) - [AskUI-RemovePythonEnvironment](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/Python/Public/AskUI-RemovePythonEnvironment.md) - [AskUI-ShowInstalledPythonPackageVersion](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/Python/Public/AskUI-ShowInstalledPythonPackageVersion.md) - [AskUI-ShowPythonEnvironments](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/Python/Public/AskUI-ShowPythonEnvironments.md) - [AskUI-ShowControllers](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/UIController/Public/AskUI-ShowControllers.md) - [AskUI-StartController](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/UIController/Public/AskUI-StartController.md) - [AskUI-StopControllers](https://askui-docs-streamline-documentation.mintlify.app/04-reference/02-askui-suite/02-askui-suite/UIController/Public/AskUI-StopControllers.md) - [Create Access Token](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/access-tokens/create-access-token.md) - [Delete Access Token](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/access-tokens/delete-access-token.md) - [List Access Tokens](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/access-tokens/list-access-tokens.md) - [Lookup Global Access Token ID](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/access-tokens/lookup-global-access-token-id.md): Converts a sensitive global-level access token into its stable identifier (access_token_id). The access token can be base64 encoded (similar to Authorization header) or passed raw. This enables clients to reference tokens without transmitting sensitive values, e.g., when trying to delete the token o… - [Lookup Workspace Access Token ID](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/access-tokens/lookup-workspace-access-token-id.md): Converts a sensitive workspace-level access token into its stable identifier (access_token_id) within the specified workspace. The access token can be base64 encoded (similar to Authorization header) or passed raw. This enables clients to reference tokens without transmitting sensitive values, e.g.,… - [Create Agent Execution](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/agent-executions/create-agent-execution.md) - [List Agent Executions](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/agent-executions/list-agent-executions.md): List all agent executions matching the query parameters sorted anti-chronologically by when they were last updated (`updated_at`). - [Update Agent Execution](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/agent-executions/update-agent-execution.md) - [Create Agent](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/agents/create-agent.md) - [List Agents](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/agents/list-agents.md): List all agents matching the query parameters sorted anti-chronologically by when they were last updated (`updated_at`). - [Update Agent](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/agents/update-agent.md) - [Create Customer Portal Session](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/billing/create-customer-portal-session.md) - [Get workspace subscription details](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/billing/get-workspace-subscription.md): Retrieves the subscription details for the workspace, including Stripe product information. - [Delete File](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/files/delete-file.md): Delete a file at the specified path. - [List Files](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/files/list-files.md): List files. - [Set Signed Cookies](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/files/set-signed-cookies.md): Set http-only, secure (signed) cookies for accessing (only READ access) files via AWS CloudFront across all accessible workspaces. If no workspace id is provided, no cookies will be set. - [Upload File](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/files/upload-file.md): Upload a file (max. 5 GB) to the specified path. - [Complete](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/runner-jobs/complete.md) - [Lease](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/runner-jobs/lease.md) - [Ping](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/runner-jobs/ping.md) - [List Runs](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/runs/list-runs.md) - [Create Schedule](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/schedules/create-schedule.md) - [Suspend Schedule](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/schedules/suspend-schedule.md) - [List usage events](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/usage/list-usage-events.md) - [Create Workspace Membership](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/workspace-memberships/create-workspace-membership.md) - [Delete Workspace Membership](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/workspace-memberships/delete-workspace-membership.md) - [List Workspace Memberships](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/workspace-memberships/list-workspace-memberships.md) - [Create Workspace](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/workspaces/create-workspace.md) - [Delete Workspace](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/workspaces/delete-workspace.md) - [Update Workspace Name](https://askui-docs-streamline-documentation.mintlify.app/04-reference/07-workspace-service/workspaces/update-workspace-name.md) - [AI Models](https://askui-docs-streamline-documentation.mintlify.app/04-reference/ai-models.md): Reference guide for available AI models and their specifications - [Environment Variables](https://askui-docs-streamline-documentation.mintlify.app/04-reference/environment-variables.md): These are the environment variables for AskUI - [Network Requirements](https://askui-docs-streamline-documentation.mintlify.app/04-reference/network-requirements.md): Network configuration and connectivity requirements for AskUI - [System Requirements](https://askui-docs-streamline-documentation.mintlify.app/04-reference/system-requirements.md): Hardware and software requirements for running AskUI - [Agentic Instructions Example](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/agentic-instructions-example.md): Example of using the agentic approach for Android UI testing - [AskUI Suite 25.10.1](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-10-1-release-notes-link.md) - [AskUI Suite 25.11.1](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-11-1-release-notes-link.md) - [AskUI Suite 25.2.1](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-2-1-release-notes-link.md) - [AskUI Suite 25.3.1](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-3-1-release-notes-link.md) - [AskUI Suite 25.4.1](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-4-1-release-notes-link.md) - [AskUI Suite 25.6.1](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-1-release-notes-link.md) - [AskUI Suite 25.6.2](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-2-release-notes-link.md) - [AskUI Suite 25.6.3](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-6-3-release-notes-link.md) - [AskUI Suite 25.7.1](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-7-1-release-notes-link.md) - [AskUI Suite 25.7.2](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-7-2-release-notes-link.md) - [AskUI Suite 25.8.1](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-8-1-release-notes-link.md) - [AskUI Suite 25.8.2](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-8-2-release-notes-link.md) - [AskUI Suite 25.9.2](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-25-9-2-release-notes-link.md) - [Old Release Notes (AskUI Suite < 24.9.1)](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/01-askui-suite/askui-suite-old-release-notes.md) - [AskUI Vision Agent (Python)](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/02-agent-frameworks/python-vision-agent-release-notes.md) - [Typescript ADK](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/release-notes/02-agent-frameworks/typescirpt-adk-release-notes.md) - [Status Page](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/status-page.md) - [Trust Center](https://askui-docs-streamline-documentation.mintlify.app/05-additional-resources/trust-center.md) - [Capabilities](https://askui-docs-streamline-documentation.mintlify.app/agent-os/capabilities.md): Background mode, multi-display, window targeting. - [Agent OS](https://askui-docs-streamline-documentation.mintlify.app/agent-os/index.md): Device driver for screen capture and input control. - [CSV Format](https://askui-docs-streamline-documentation.mintlify.app/define-tasks/csv-format.md): Structured test cases for automation. - [Examples](https://askui-docs-streamline-documentation.mintlify.app/define-tasks/examples.md): Copy-paste task definitions. - [Define Tasks](https://askui-docs-streamline-documentation.mintlify.app/define-tasks/index.md): Natural language or CSV. Describe what you want, agent handles how. - [Natural Language](https://askui-docs-streamline-documentation.mintlify.app/define-tasks/natural-language.md): Plain text task instructions. - [Agentic Development](https://askui-docs-streamline-documentation.mintlify.app/extend-your-agent/agentic-development.md): Give Claude Code, Cursor, and other AI tools UI control. - [Model Configuration](https://askui-docs-streamline-documentation.mintlify.app/extend-your-agent/bring-your-model.md): Use AskUI default or bring your own LLM. - [Caching](https://askui-docs-streamline-documentation.mintlify.app/extend-your-agent/caching.md): Record actions, replay without AI inference. - [Custom Tools](https://askui-docs-streamline-documentation.mintlify.app/extend-your-agent/custom-tools.md): Extend agent capabilities with file ops, API calls, custom logic. - [Platform Agents](https://askui-docs-streamline-documentation.mintlify.app/extend-your-agent/platform-agents.md): Desktop, Android, and Web agents. - [How It Works](https://askui-docs-streamline-documentation.mintlify.app/get-started/how-it-works.md): VisionAgent + Agent OS architecture. - [Quickstart](https://askui-docs-streamline-documentation.mintlify.app/get-started/quickstart.md): Get AskUI running in 5 minutes. - [AskUI SDK](https://askui-docs-streamline-documentation.mintlify.app/index.md): AskUI lets AI agents see screens and control devices. Desktop, mobile, web. One API. ## OpenAPI Specs - [openapi](https://inference.askui.com/openapi.json) ## Optional - [TypeScript Docs](https://docs-ts.askui.com) - [Status Page](https://status.askui.com) - [Trust Center](https://trust.askui.com)