Index

A B C D E F G H I J P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

account() - Method in class ai.webscraping.Client

AccountInfo - Class in ai.webscraping.result

Account quota information returned by GET /account.

AccountInfo(String, long, Long, Integer) - Constructor for class ai.webscraping.result.AccountInfo

addField(String, String) - Method in class ai.webscraping.option.FieldsOptions.Builder

addHeader(String, String) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

addSelector(String) - Method in class ai.webscraping.option.SelectedMultipleOptions.Builder

ai.webscraping - package ai.webscraping

ai.webscraping.exception - package ai.webscraping.exception

ai.webscraping.internal - package ai.webscraping.internal

ai.webscraping.option - package ai.webscraping.option

ai.webscraping.result - package ai.webscraping.result

API_KEY_ENV - Static variable in class ai.webscraping.Config

Environment variable consulted when Config.Builder.apiKey(String) is not set.

ApiConnectionException - Exception Class in ai.webscraping.exception

Transport-level failure (DNS, TCP, TLS, etc.) — no HTTP response was received and the cause is not a timeout.

ApiConnectionException(String, Throwable) - Constructor for exception class ai.webscraping.exception.ApiConnectionException

ApiException - Exception Class in ai.webscraping.exception

Thrown when the API returns a non-2xx HTTP response.

ApiException(int, String, Integer, String, String, String) - Constructor for exception class ai.webscraping.exception.ApiException

apiKey(String) - Method in class ai.webscraping.Config.Builder

ApiTimeoutException - Exception Class in ai.webscraping.exception

The request did not receive a complete response within the configured timeout (no HTTP status was observed).

ApiTimeoutException(String, Throwable) - Constructor for exception class ai.webscraping.exception.ApiTimeoutException

AuthenticationException - Exception Class in ai.webscraping.exception

HTTP 403 — missing or invalid API key.

AuthenticationException(String, Integer, String, String, String) - Constructor for exception class ai.webscraping.exception.AuthenticationException

B

BadRequestException - Exception Class in ai.webscraping.exception

HTTP 400 — malformed request.

BadRequestException(String, Integer, String, String, String) - Constructor for exception class ai.webscraping.exception.BadRequestException

BaseBuilder() - Constructor for class ai.webscraping.option.CommonOptions.BaseBuilder

baseUrl(String) - Method in class ai.webscraping.Config.Builder

build() - Method in class ai.webscraping.Config.Builder

build() - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

build() - Method in class ai.webscraping.option.FieldsOptions.Builder

build() - Method in class ai.webscraping.option.HtmlOptions.Builder

build() - Method in class ai.webscraping.option.QuestionOptions.Builder

build() - Method in class ai.webscraping.option.SelectedMultipleOptions.Builder

build() - Method in class ai.webscraping.option.SelectedOptions.Builder

build() - Method in class ai.webscraping.option.TextOptions.Builder

builder() - Static method in class ai.webscraping.Config

builder() - Static method in class ai.webscraping.option.FieldsOptions

builder() - Static method in class ai.webscraping.option.HtmlOptions

builder() - Static method in class ai.webscraping.option.QuestionOptions

builder() - Static method in class ai.webscraping.option.SelectedMultipleOptions

builder() - Static method in class ai.webscraping.option.SelectedOptions

builder() - Static method in class ai.webscraping.option.TextOptions

Builder() - Constructor for class ai.webscraping.Config.Builder

Builder() - Constructor for class ai.webscraping.option.FieldsOptions.Builder

Builder() - Constructor for class ai.webscraping.option.HtmlOptions.Builder

Builder() - Constructor for class ai.webscraping.option.QuestionOptions.Builder

Builder() - Constructor for class ai.webscraping.option.SelectedMultipleOptions.Builder

Builder() - Constructor for class ai.webscraping.option.SelectedOptions.Builder

Builder() - Constructor for class ai.webscraping.option.TextOptions.Builder

C

Client - Class in ai.webscraping

Official Java client for the WebScraping.AI API.

Client() - Constructor for class ai.webscraping.Client

Convenience constructor reading the API key from WEBSCRAPING_AI_API_KEY.

Client(Config) - Constructor for class ai.webscraping.Client

CommonOptions - Class in ai.webscraping.option

Shared options applicable to every API endpoint.

CommonOptions(CommonOptions.BaseBuilder<?, ?>) - Constructor for class ai.webscraping.option.CommonOptions

CommonOptions.BaseBuilder<O,B> - Class in ai.webscraping.option

Curiously-recurring base builder.

Config - Class in ai.webscraping

Immutable configuration for a Client.

Config.Builder - Class in ai.webscraping

country(String) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

customProxy(String) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

D

DEFAULT_BASE_URL - Static variable in class ai.webscraping.Config

Production API base URL.

DEFAULT_REQUEST_TIMEOUT - Static variable in class ai.webscraping.Config

Default fallback per-request timeout (60 seconds).

device(String) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

E

encode() - Method in class ai.webscraping.internal.QueryEncoder

Returns the encoded query string with no leading "?".

errorOn404(boolean) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

errorOnRedirect(boolean) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

execute(Transport.Request) - Method in class ai.webscraping.JdkHttpTransport

execute(Transport.Request) - Method in interface ai.webscraping.Transport

F

fields(FieldsOptions) - Method in class ai.webscraping.Client

fields(Map<String, String>) - Method in class ai.webscraping.option.FieldsOptions.Builder

FieldsOptions - Class in ai.webscraping.option

Options for Client.fields(FieldsOptions).

FieldsOptions.Builder - Class in ai.webscraping.option

FieldsResult - Class in ai.webscraping.result

The /ai/fields response wraps the extracted fields under a result key — confirmed against the live API 2026-05-12.

FieldsResult(Map<String, String>) - Constructor for class ai.webscraping.result.FieldsResult

format(String) - Method in class ai.webscraping.option.HtmlOptions.Builder

format(String) - Method in class ai.webscraping.option.QuestionOptions.Builder

format(String) - Method in class ai.webscraping.option.SelectedOptions.Builder

forStatus(int, String, Integer, String, String, String) - Static method in exception class ai.webscraping.exception.ApiException

Maps an HTTP status to the matching per-status subclass; falls back to ApiException.

fromEnvironment() - Static method in class ai.webscraping.Config

Convenience constructor — reads the API key from the env var only.

G

GatewayTimeoutException - Exception Class in ai.webscraping.exception

HTTP 504 — target page took too long to respond.

GatewayTimeoutException(String, Integer, String, String, String) - Constructor for exception class ai.webscraping.exception.GatewayTimeoutException

getApiKey() - Method in class ai.webscraping.Config

getBaseUrl() - Method in class ai.webscraping.Config

getBody() - Method in exception class ai.webscraping.exception.ApiException

body field from the error envelope (target-page error body), or null.

getBody() - Method in class ai.webscraping.Transport.Response

getConfig() - Method in class ai.webscraping.Client

getCountry() - Method in class ai.webscraping.option.CommonOptions

getCustomProxy() - Method in class ai.webscraping.option.CommonOptions

getDevice() - Method in class ai.webscraping.option.CommonOptions

getEmail() - Method in class ai.webscraping.result.AccountInfo

The account's email address.

getErrorOn404() - Method in class ai.webscraping.option.CommonOptions

getErrorOnRedirect() - Method in class ai.webscraping.option.CommonOptions

getFields() - Method in class ai.webscraping.option.FieldsOptions

getFormat() - Method in class ai.webscraping.option.HtmlOptions

getFormat() - Method in class ai.webscraping.option.QuestionOptions

getFormat() - Method in class ai.webscraping.option.SelectedOptions

getHeaders() - Method in class ai.webscraping.option.CommonOptions

getHeaders() - Method in class ai.webscraping.Transport.Request

getHttpStatus() - Method in exception class ai.webscraping.exception.ApiException

getJs() - Method in class ai.webscraping.option.CommonOptions

getJsScript() - Method in class ai.webscraping.option.CommonOptions

getJsTimeout() - Method in class ai.webscraping.option.CommonOptions

getProxy() - Method in class ai.webscraping.option.CommonOptions

getQuestion() - Method in class ai.webscraping.option.QuestionOptions

getRemainingApiCalls() - Method in class ai.webscraping.result.AccountInfo

Number of API calls remaining in the current billing period.

getRemainingConcurrency() - Method in class ai.webscraping.result.AccountInfo

Number of concurrent requests still available, or null.

getRequestTimeout() - Method in class ai.webscraping.Config

getResetsAt() - Method in class ai.webscraping.result.AccountInfo

Unix-time (seconds) when the API-call allowance resets, or null.

getResponseBody() - Method in exception class ai.webscraping.exception.ApiException

Raw HTTP response body.

getResult() - Method in class ai.webscraping.result.FieldsResult

getResults() - Method in class ai.webscraping.result.SelectedMultipleResult

getReturnLinks() - Method in class ai.webscraping.option.TextOptions

getReturnScriptResult() - Method in class ai.webscraping.option.HtmlOptions

getSelector() - Method in class ai.webscraping.option.SelectedOptions

getSelectors() - Method in class ai.webscraping.option.SelectedMultipleOptions

getStatus() - Method in class ai.webscraping.Transport.Response

getStatusCode() - Method in exception class ai.webscraping.exception.ApiException

Application-level status code from the API error envelope, or null.

getStatusMessage() - Method in exception class ai.webscraping.exception.ApiException

Application-level status message from the API error envelope, or null.

getTextFormat() - Method in class ai.webscraping.option.TextOptions

getTimeout() - Method in class ai.webscraping.option.CommonOptions

getTimeout() - Method in class ai.webscraping.Transport.Request

Per-request timeout.

getTransport() - Method in class ai.webscraping.Config

getUrl() - Method in class ai.webscraping.option.FieldsOptions

getUrl() - Method in class ai.webscraping.option.HtmlOptions

getUrl() - Method in class ai.webscraping.option.QuestionOptions

getUrl() - Method in class ai.webscraping.option.SelectedMultipleOptions

getUrl() - Method in class ai.webscraping.option.SelectedOptions

getUrl() - Method in class ai.webscraping.option.TextOptions

getUrl() - Method in class ai.webscraping.Transport.Request

getUserAgent() - Method in class ai.webscraping.Config

getWaitFor() - Method in class ai.webscraping.option.CommonOptions

H

headers(Map<String, String>) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

html(HtmlOptions) - Method in class ai.webscraping.Client

HtmlOptions - Class in ai.webscraping.option

Options for Client.html(HtmlOptions).

HtmlOptions.Builder - Class in ai.webscraping.option

I

isEmpty() - Method in class ai.webscraping.internal.QueryEncoder

J

JdkHttpTransport - Class in ai.webscraping

Default Transport implementation backed by HttpClient from java.net.http.

JdkHttpTransport() - Constructor for class ai.webscraping.JdkHttpTransport

JdkHttpTransport(HttpClient) - Constructor for class ai.webscraping.JdkHttpTransport

js(boolean) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

Json - Class in ai.webscraping.internal

Centralised Jackson helpers.

jsScript(String) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

jsTimeout(int) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

P

pairs() - Method in class ai.webscraping.internal.QueryEncoder

Returns the flattened wire pairs (in declaration order).

PaymentRequiredException - Exception Class in ai.webscraping.exception

HTTP 402 — account out of credits.

PaymentRequiredException(String, Integer, String, String, String) - Constructor for exception class ai.webscraping.exception.PaymentRequiredException

proxy(String) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

Q

QueryEncoder - Class in ai.webscraping.internal

QueryEncoder() - Constructor for class ai.webscraping.internal.QueryEncoder

question(QuestionOptions) - Method in class ai.webscraping.Client

question(String) - Method in class ai.webscraping.option.QuestionOptions.Builder

QuestionOptions - Class in ai.webscraping.option

Options for Client.question(QuestionOptions).

QuestionOptions.Builder - Class in ai.webscraping.option

R

RateLimitException - Exception Class in ai.webscraping.exception

HTTP 429 — too many concurrent requests.

RateLimitException(String, Integer, String, String, String) - Constructor for exception class ai.webscraping.exception.RateLimitException

read(String, TypeReference<T>) - Static method in class ai.webscraping.internal.Json

read(String, Class<T>) - Static method in class ai.webscraping.internal.Json

Request(String, Map<String, String>, Duration) - Constructor for class ai.webscraping.Transport.Request

requestTimeout(Duration) - Method in class ai.webscraping.Config.Builder

Response(int, String) - Constructor for class ai.webscraping.Transport.Response

returnLinks(boolean) - Method in class ai.webscraping.option.TextOptions.Builder

returnScriptResult(boolean) - Method in class ai.webscraping.option.HtmlOptions.Builder

S

selected(SelectedOptions) - Method in class ai.webscraping.Client

selectedMultiple(SelectedMultipleOptions) - Method in class ai.webscraping.Client

SelectedMultipleOptions - Class in ai.webscraping.option

Options for Client.selectedMultiple(SelectedMultipleOptions).

SelectedMultipleOptions.Builder - Class in ai.webscraping.option

SelectedMultipleResult - Class in ai.webscraping.result

The /selected-multiple endpoint returns Array<Array<String>>, not a flat Array<String> — confirmed against the live API.

SelectedMultipleResult(List<List<String>>) - Constructor for class ai.webscraping.result.SelectedMultipleResult

SelectedOptions - Class in ai.webscraping.option

Options for Client.selected(SelectedOptions).

SelectedOptions.Builder - Class in ai.webscraping.option

selector(String) - Method in class ai.webscraping.option.SelectedOptions.Builder

selectors(String...) - Method in class ai.webscraping.option.SelectedMultipleOptions.Builder

selectors(List<String>) - Method in class ai.webscraping.option.SelectedMultipleOptions.Builder

self() - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

ServerException - Exception Class in ai.webscraping.exception

HTTP 500 — server-side error (often a target-page failure surfaced via body).

ServerException(String, Integer, String, String, String) - Constructor for exception class ai.webscraping.exception.ServerException

set(String, Object) - Method in class ai.webscraping.internal.QueryEncoder

T

text(TextOptions) - Method in class ai.webscraping.Client

textFormat(String) - Method in class ai.webscraping.option.TextOptions.Builder

TextOptions - Class in ai.webscraping.option

Options for Client.text(TextOptions).

TextOptions.Builder - Class in ai.webscraping.option

timeout(int) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

toString() - Method in class ai.webscraping.result.AccountInfo

toString() - Method in class ai.webscraping.result.FieldsResult

toString() - Method in class ai.webscraping.result.SelectedMultipleResult

transport(Transport) - Method in class ai.webscraping.Config.Builder

Transport - Interface in ai.webscraping

HTTP transport abstraction.

Transport.Request - Class in ai.webscraping

Transport.Response - Class in ai.webscraping

tryRead(String, Class<T>) - Static method in class ai.webscraping.internal.Json

Returns the parsed value, or null if the body is not valid JSON for the requested shape.

U

url(String) - Method in class ai.webscraping.option.FieldsOptions.Builder

url(String) - Method in class ai.webscraping.option.HtmlOptions.Builder

url(String) - Method in class ai.webscraping.option.QuestionOptions.Builder

url(String) - Method in class ai.webscraping.option.SelectedMultipleOptions.Builder

url(String) - Method in class ai.webscraping.option.SelectedOptions.Builder

url(String) - Method in class ai.webscraping.option.TextOptions.Builder

userAgent(String) - Method in class ai.webscraping.Config.Builder

V

Version - Class in ai.webscraping

Library version.

VERSION - Static variable in class ai.webscraping.Version

W

waitFor(String) - Method in class ai.webscraping.option.CommonOptions.BaseBuilder

WebScrapingAIException - Exception Class in ai.webscraping.exception

Base unchecked exception for everything thrown by the WebScraping.AI SDK.

WebScrapingAIException(String) - Constructor for exception class ai.webscraping.exception.WebScrapingAIException

WebScrapingAIException(String, Throwable) - Constructor for exception class ai.webscraping.exception.WebScrapingAIException

A B C D E F G H I J P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form