AskUIDocs
Reference

Glossary

Definitions for key terms used across AskUI documentation.

TermDefinition
Access tokenA credential that authenticates the CLI or an external integration with the AskUI Hub. Every token belongs to exactly one workspace and has an expiry date. See Workspaces.
AgentOSThe runtime layer that gives the AI agent direct OS-level control: keyboard, mouse, screen capture, and system functions. Runs on Windows, macOS, and Linux.
AnnotationA marked region around a UI element with metadata including its name, text content, and bounding box coordinates.
Bounding boxA rectangle defined by coordinates that describes the location and size of a UI element on screen.
Companion ModeAn AgentOS control mode where AgentOS runs on an external device (e.g. Raspberry Pi) and controls the target through hardware interfaces. No software installation on the target is required.
CredentialsThe combination of a workspace ID and an access token for the same workspace.
ElementA graphical user interface component: a button, text field, menu item, image, etc.
Host ModeAn AgentOS control mode where AgentOS runs directly on the target machine and controls it via OS-level APIs.
InferenceThe process of sending a screenshot to the AI model to identify and locate UI elements.
ProjectA folder structure created by AskUI Desktop containing tests, prompts, procedures, and plans. The unit of work for authoring and running tests.
ProcedureA reusable multi-step sequence (e.g. "log in") stored in procedures/ and invoked from test steps by name.
Run reportThe output of a test run: a Markdown file with a status and screenshot per step. Statuses are PASSED, FAILED, WARN, SKIPPED, or BROKEN.
WorkspaceThe account-level container in the AskUI Hub that owns access tokens, usage events, and billing. Every AskUI account belongs to one or more workspaces.
Workspace IDThe unique identifier for a workspace. Used together with an access token to authenticate with the AskUI Hub.