API Reference
The public API is grouped by what an automation developer needs to do. Start with the fluent Appian component APIs. Runtime and lower-level scoping APIs are available when you need framework integration or advanced control.
Page and scoping
| API | Use it for |
|---|---|
AppianPage |
Main Appian page and fluent component entry point |
AppianLocator |
Scope work to a dialog, region, row, or subtree |
AppianScope |
Type alias for APIs that intentionally accept either page or locator |
Prefer AppianPage for normal application tests.
Fluent Appian input components
| API | Use it for |
|---|---|
AppianButton |
Buttons through page.button(...) |
AppianTextbox |
Text entry and searchable text suggestions through page.textbox(...) |
AppianDate |
Date inputs through page.date(...) |
AppianCheckbox |
Native Appian checkboxes through page.checkbox(...) |
AppianRadioSelect |
Labeled radio groups through page.radio(...) |
AppianRow |
Table rows through table.row(...) |
AppianTab |
Linked-card tabs through page.tab(...) |
AppianInputComponent |
Shared input lifecycle; mainly for framework/component authors |
Example:
page.textbox(label="Description").fill("Example")
page.date(label="Start Date").fill("10/15/2026")
page.radio(label="Priority").select("High")
page.button(name="Next").click()
Reusable components
| Component | Use it for |
|---|---|
Runtime and framework integration
- Appian Runtime —
AppianRuntime,AppianContext,AutomationContext, and correlation/runtime helpers - Assertion Helpers — Appian-facing visibility/text assertions
- Errors —
RoboAppianErrorandRoboAppianNavigationError - Pytest Integration — fixtures and plugin integration
Compatibility
Use AppianPage, AppianLocator, AppianScope, and the fluent Appian component APIs for new automation.