Browser CapabilitiesExtraction

locator.screenshot

View as Markdown

locator.screenshot is a browser runtime capability in the locator namespace.

Availability

  • Runtime: browser
  • Kind: raw
  • Category: extraction
  • Supported drivers: Playwright, Puppeteer

SDK Surface

  • SDK path: runtime.page.locator(...).screenshot
  • Async: Yes

HTTP Surface

  • Transport: workspace.execute(...)
  • Call: locator.screenshot
  • Long-running: No

Reference Semantics

  • Requires refs: locator
  • Returns refs: artifact

Arguments

ArgumentTypeRequiredDescription
optionsobjectNoScreenshot options.

Result

  • Type: artifact
  • Description: Screenshot artifact metadata.

SDK Example

1await runtime.page.locator('button[type=submit]').screenshot();

HTTP Example

1{
2  "runtime": "crm",
3  "steps": [
4    {
5      "call": "locator.screenshot"
6    }
7  ]
8}