SYNOPSIS

DESCRIPTION

PARAMETERS

EXAMPLES

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4

AskUI-OpenAgent

Starter Kit

Welcome to the AskUI documentation. This guide will help you understand what AskUI does, its key features, benefits, and how they can empower you to build AI agents for various use cases. 

Overview

Learn about AskUI's architecture and how it automates your UI interactions

How AskUI Works

Example Automations

What you need before getting started with AskUI.

Prerequisites

Build your first automation with AskUI in minutes.

Quickstart Tutorial

Learn how to interact with UI elements using AskUI's powerful tools and actions

Interactions and Tools

Welcome to the home of your new documentation

Agentic Mode

Learn how to monitor and debug your AskUI automation workflows

Reporting and Logging

Provide guidelines on designing robust automation scripts, including error handling, retries, and validation steps

Best Practices for UIDT-1 Locator Reliable Automation

Learn how to use and configure different AI models

AI Model Usage

This page explains how to reteach and/or retrain your models for specific needs.

Re-Teaching Models

AskUI Agent OS provides a comprehensive set of commands to manage your AskUI projects, controllers, and settings. This page provides an overview of the available commands and their parameters.

Agent OS

Proxy & TLS Configuration

This page explains how to set up **AskUI with GitHub Actions**, including dependency setup, environment variables, test execution, and optional report generation.

Github Actions

This page explains how to set up and run **AskUI workflows in a CI/CD pipeline**, including dependencies, environment variables, and optional report generation, with a full example on **GitLab**.

Gitlab CI/CD

This page explains how to set up and run **AskUI workflows in Azure DevOps**, including pipeline configuration, environment variables, Docker setup, and report generation, with a full example on **GitHub**.

Azure DevOps

SSO with AskUI

This page provides a glossary of key AskUI terms and definitions to help you understand the core concepts and components of the platform.

Glossary

Frequently Asked Questions (FAQ)

Agent

Locators

Reporting

Retry

Tools

Types

Workspace Management

Learn how to manage members and their permissions in your AskUI workspace.

Members Management

Learn how to track your AskUI usage and manage billing information in the dashboard.

Usage & Billing Dashboard

Access Tokens

Change your subscription and manage invoices

Billing and Invoices

Common Issues

Reporting Bugs & Providing Feedback

TypeScript Docs

Status Page

Trust Center

Community

Roadmap

API Reference & Extensibility

Account & Settings

Login

Support

Sign up

Learn how to find and select UI elements with AskUI's powerful selection capabilities

Element Selection General

This example shows how you can find multiple elements on the screen using a reference image and click on a specific one based on its position from the top to the bottom. 

Selecting the Nth Element on Screen Top to Bottom

This example shows how you can find multiple elements on the screen using a reference image and click on a specific one based on its position from the left to the right. 

Selecting the Nth Element on Screen Left to Right

Check, assert, or validate unknown states

Yes/No Questions

Extract specific text information from your application

Text Questions

Extract specific numeric information from your application

Number Questions

Extract sidebar structure from your application

Extracting Sidebars

Extract tab bar structure and active state from your application

Extracting Tabs

Extract table data as structured objects from your application

Extracting Tables

Extract card data as structured objects from your application

Extracting Cards

Create Access Token

Delete Access Token

List Access Tokens

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 or retrieve usage for the token.

Lookup Global Access Token ID

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., when trying to delete the token or retrieve usage for the token.

Lookup Workspace Access Token ID

Create Agent Execution

List all agent executions matching the query parameters sorted anti-chronologically by when they were last updated (`updated_at`).

List Agent Executions

Update Agent Execution

Create Agent

List all agents matching the query parameters sorted anti-chronologically by when they were last updated (`updated_at`).

List Agents

Update Agent

Create Customer Portal Session

Retrieves the subscription details for the workspace, including Stripe product information.

Get workspace subscription details

Delete a file at the specified path.

- Deletes only one file with the given file path. Not bulk deletion.
- If there is no file at the specified path, the operation will be a no-op, i.e., it will still return a 204 status code.

Delete File

List files.

- To list files within a workspace, the `prefix` (query parameter) must start with `workspaces/{workspace_id}/`
- Cannot list files across multiple workspaces, i.e., if the `prefix` does not start with `workspaces/{workspace_id}/`, it will return an empty list.

List Files

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.

Set Signed Cookies

Upload a file (max. 5 GB) to the specified path.

- Specify the `Content-Type` header for accurate file type handling.
- If `Content-Type` is omitted, the system will attempt to infer it.
- For workspace-specific uploads, use path: `workspaces/{workspace_id}/...`
- If a file with the same file path already exists, it will be overwritten.
- If there are unsupported characters in the file path, they will be removed or replaced.
- If the file path is longer than `1024` characters, the file path will be shortened starting from the end.
- Set `strict=true` to fail the request if the file path would be modified during sanitization (e.g., if the file path contains unsupported characters or is too long).

Python Vision Agent

AskUI Suite

Workspace Services API

AskUI-OpenAgent

SYNOPSIS

DESCRIPTION

PARAMETERS

EXAMPLES

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4

Python Vision Agent

AskUI Suite

Workspace Services API

​SYNOPSIS

​DESCRIPTION

​PARAMETERS

​EXAMPLES

​EXAMPLE 1

​EXAMPLE 2

​EXAMPLE 3

​EXAMPLE 4

SYNOPSIS

DESCRIPTION

PARAMETERS

EXAMPLES

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4