v1

latestOpenAPI 3.1.02026-07-133988103.2 KB

windows

Query a page with pagination

Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.

post/v1/sessions/{sessionId}/windows/{windowId}/paginated-extraction

Path parameters

sessionIdstring required

The session id for the window.

windowIdstring required

The Airtop window id of the browser window.

Headers

Authorizationstring required

Bearer authentication

Request body

clientRequestIdstring

costThresholdCreditsinteger

A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is not a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).

promptstring required

A prompt providing the Airtop AI model with additional direction or constraints about the page and the details you want to extract from the page.

timeThresholdSecondsinteger

A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is not a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).

This setting does not extend the maximum session duration provided at the time of session creation.

Response

Created