[Feature]: Official APIs to resolve/map ephemeral aria-refs to stable locators for LLM automation
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- playwright, python
- Domain
- ai, devtools, testing-qa
Research direction
The issue requests new APIs to map ephemeral aria-refs to stable locators for LLM automation. Start by examining the existing aria_snapshot(mode="ai") implementation and the private codegen utilities. Look for internal methods like generateLocator or exposeConsoleApi. The goal is to design a public API that returns a Locator object or a structured selector bundle from a given aria-ref.
Written by the indexing model from the issue text.
Description
🚀 Feature Request
With the rapid evolution of LLM-driven browser automation (especially leveraging Playwright's excellent aria_snapshot(mode="ai")), there is a growing need to bridge the gap between ephemeral AI session references (aria-ref=e5) and persistent, deterministic locators.
Currently, LLM agents perceive the page through temporary aria-ref identifiers. However, to "compile" these exploratory runs into reusable production scripts, developers must map these temporary refs to stable, best-practice locators (e.g., get_by_role, get_by_text).
While Playwright's internal codegen engine is powerful for this, it is currently locked behind private APIs. More importantly, simply generating a code string is often not enough; developers need a native, structured way to resolve an aria-ref into a stable Locator object or a "locator bundle" (role, name, css, xpath) to maintain this mapping throughout the automation pipeline.
Example
I would love to see official APIs that allow developers to programmatically resolve and map aria-refs to stable locators. This could take several forms, depending on what fits Playwright's design philosophy best:
- Structured Locator Resolution: Provide a method to resolve an aria-ref directly into a stable Locator object or a structured dictionary of candidate selectors.
- Expose Codegen/Console APIs: Alternatively, officially expose exposeConsoleApi or a dedicated codegen utility so developers can safely access window.playwright.generateLocator without relying on private internals.
Motivation
Right now, the only way to achieve this workflow is by reaching into Playwright's private internals:
# Python example of the current hacky workaround
await context._impl_obj._channel.send("exposeConsoleApi", None, {})
This is undocumented, fragile, and could break in any future release. Furthermore, it forces developers to manually parse and manage the relationship between the temporary ref and the resulting stable locator, without any native support for maintaining this mapping across complex agent workflows.
If this API were officially exposed, it would create a seamless, closed-loop workflow for AI agents:
- AI Perception: Get the page state using snapshot = await page.aria_snapshot(mode="ai")
- LLM Decision: The LLM decides to interact with an element, returning a reference like ref=e5
- Resolution & Mapping...
- Action & Persistence....
Playwright has already taken a huge step forward by introducing aria_snapshot(mode="ai"). Providing a native way to resolve these ephemeral AI refs into stable locators would be the perfect companion feature. It would bridge the gap between ephemeral AI sessions and persistent, deterministic automation, making Playwright the undisputed best framework for building reliable AI web agents.
Thank you for considering this request!
- Dominant language
- Python
- Stars
- 15k
- Forks
- 1.2k
- Avg merge
- 5d 12h
- Merged PRs (30d)
- 10
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/playwright-python
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
microsoft/playwright-python#3208 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
microsoft/playwright-python#3186 ·
-
Difficulty 5/5 Over a week Newbie friendliness 1/100
microsoft/playwright-python#3195 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 72/100
microsoft/playwright-python#3188 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 1/100
microsoft/playwright-python#3172 ·
All issues in microsoft/playwright-python
Similar issues
-
agent-ready documentation needs-triage
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
instance instance add
Difficulty 1/5 Under an hour Newbie friendliness 72/100
searxng/searx-instances#939 · 1 comment ·
-
area-deployment area-integrations triage:bot-seen
Difficulty 2/5 Half a day Newbie friendliness 86/100