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}.
Limits: request bodies are capped at 512 KB. An oversized body
returns a 400 with error code request_too_large.
Parameters
async_ (Union[Unset, bool])body (ScreenshotRequest)
Call styles
sync_detailed(client=client, body=body, async_=async_) -> Response[Union[Error, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]]
sync(client=client, body=body, async_=async_) -> Optional[Union[Error, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]]
await asyncio_detailed(client=client, body=body, async_=async_) -> Response[Union[Error, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]]
await asyncio(client=client, body=body, async_=async_) -> Optional[Union[Error, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]]Get Screenshot
Get screenshot status
Parameters
id (str)
Call styles
sync_detailed(id=id, client=client) -> Response[Union[Error, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]]
sync(id=id, client=client) -> Optional[Union[Error, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]]
await asyncio_detailed(id=id, client=client) -> Response[Union[Error, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]]
await asyncio(id=id, client=client) -> Optional[Union[Error, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]]