Skip to content

Configuration

Client Configuration

perplexity_webui_scraper.config.client.ClientConfig

Bases: BaseModel

Immutable HTTP client and resilience settings.

ATTRIBUTE DESCRIPTION
timeout

Request timeout in seconds. Defaults to 3600 (1 hour) for long queries.

TYPE: int

impersonate

Browser fingerprint profile (e.g., "chrome", "firefox").

TYPE: BrowserTypeLiteral

max_retries

Max retry attempts on transient errors.

TYPE: int

retry_base_delay

Initial backoff delay in seconds.

TYPE: float

retry_max_delay

Maximum backoff delay cap in seconds.

TYPE: float

retry_jitter

Jitter factor (0-1) to randomize retry delays.

TYPE: float

rotate_fingerprint

Rotates browser fingerprint on each retry if True.

TYPE: bool

requests_per_second

Max request rate. Set to 0 to disable.

TYPE: float

max_init_query_length

Truncates init query length to avoid HTTP 414.

TYPE: int

logging_level

Log verbosity. Defaults to "disabled".

TYPE: LogLevel

log_file

Path to write logs. None writes to stderr.

TYPE: str | PathLike[str] | None


Conversation Configuration

perplexity_webui_scraper.config.conversation.ConversationConfig

Bases: BaseModel

Settings for a single conversation thread.

All fields are optional and fall back to sensible defaults. Construct a ConversationConfig and pass it to client.create_conversation().

ATTRIBUTE DESCRIPTION
model

Model ID string (e.g., "perplexity/best"). Defaults to "perplexity/best" (Perplexity auto-selection).

TYPE: str | None

search_focus

Search mode constraint. "web" enables live search; "writing" disables external sources for pure generation.

TYPE: SearchFocus

source_focus

Filter categories for search (e.g., "academic", "finance", "social"). Accepts a string or list of strings.

TYPE: SourceFocus | list[SourceFocus]

time_range

Recency constraint for web results (e.g., "week"). "all" removes time restrictions.

TYPE: TimeRange

citation_mode

Determines how inline citations are returned. "clean" removes them, "markdown" converts to links.

TYPE: CitationMode

language

BCP-47 language tag for the response (e.g., "pt-BR").

TYPE: str

timezone

IANA timezone string for localization (e.g., "America/Sao_Paulo").

TYPE: str | None

coordinates

Geographic location constraints (latitude/longitude).

TYPE: Coordinates | None

save_to_library

If True, saves the thread to your account history.

TYPE: bool

space_uuid

UUID of a Perplexity Space (collection) to post into.

TYPE: str | None