AIairtop
windows

Summarize

Changed on

This endpoint is deprecated. Please use the pageQuery endpoint and ask for a summary in the prompt instead.

post/v1/sessions/{sessionId}/windows/{windowId}/summarize-content

Request

Path parameters

sessionIdstring required

The session id for the window.

windowIdstring required

The Airtop window id of the browser window to summarize.

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

An optional prompt providing the Airtop AI model with additional direction or constraints about the summary (such as desired length).

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

Changes

  • f508c8a4c5e6Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security default was added to the API

  • 68dc554626c5Revision changes
    • info

      api operation id summarize-content removed and replaced with windows_summarize-content