For AI agents: a documentation index is available at /llms.txt
Skip to main content

Input types

CleanInput

FieldType
attributesNotRequired[list[str]]
modeNotRequired[AttributeMode]
regexesNotRequired[list[str]]
removeAttributesNotRequired[bool]
removeNonTextNodesNotRequired[bool]
removeRegexNotRequired[bool]
selectorsNotRequired[list[str]]

CookieInput

FieldType
domainNotRequired[str]
expiresNotRequired[float]
httpOnlyNotRequired[bool]
nameRequired[str]
partitionKeyNotRequired[CookiePartitionKeyInput]
pathNotRequired[str]
priorityNotRequired[CookiePriority]
sameSiteNotRequired[CookieSameSite]
secureNotRequired[bool]
sourceSchemeNotRequired[CookieSourceScheme]
urlNotRequired[str]
valueRequired[str]

CookiePartitionKeyInput

FieldType
hasCrossSiteAncestorNotRequired[bool]
sourceOriginRequired[str]

HTMLResourcePathInput

FieldType
pathRequired[str]
urlRequired[str]

HTMLRewriteInput

FieldType
baseURLRequired[str]
resourcesRequired[list[HTMLResourcePathInput]]

HeaderInput

FieldType
nameRequired[str]
valueRequired[str]

RequestInput

FieldType
methodNotRequired[Method]
urlNotRequired[str]

ResponseInput

FieldType
codesNotRequired[list[int]]
statusesNotRequired[list[int]]
urlNotRequired[str]

ScreenshotClip

FieldType
heightNotRequired[float]
scaleNotRequired[float]
widthNotRequired[float]
xNotRequired[float]
yNotRequired[float]