SDK ReferencePython SDK
Screenshots
API functions for the Screenshots resource.
Screenshots
Functions for interacting with the screenshots API resource. Each operation ships in four forms — sync / sync_detailed and their async counterparts.
Create Screenshot
Capture a screenshot
Sync by default (holds up to 28s). Pass ?async=true to return 202 immediately.
Poll via GET /v1/screenshots/{id}.
Parameters
async_ (bool | Unset): Default: False.body (ScreenshotRequest)
Call styles
sync_detailed(client=client, body=body, async_=async_) -> Response[Error | ScreenshotResponse]
sync(client=client, body=body, async_=async_) -> Error | ScreenshotResponse | None
await asyncio_detailed(client=client, body=body, async_=async_) -> Response[Error | ScreenshotResponse]
await asyncio(client=client, body=body, async_=async_) -> Error | ScreenshotResponse | NoneGet Screenshot
Get screenshot status
Parameters
id (str)
Call styles
sync_detailed(id=id, client=client) -> Response[Error | ScreenshotResponse]
sync(id=id, client=client) -> Error | ScreenshotResponse | None
await asyncio_detailed(id=id, client=client) -> Response[Error | ScreenshotResponse]
await asyncio(id=id, client=client) -> Error | ScreenshotResponse | None