Struct SmartScraperRequest 

pub struct SmartScraperRequest {

    pub website_url: String,
    pub user_prompt: String,
    pub output_schema: Option<Value>,
    pub page_complexity: Option<PageComplexity>,
    pub detail_level: Option<DetailLevel>,
    pub parse_mode: Option<ParseMode>,
    pub plain_text: Option<bool>,
    pub include_tags: Option<Vec<String>>,
    pub exclude_tags: Option<Vec<String>>,
    pub reduce_content: Option<bool>,
    pub experimental: Option<bool>,
    pub headers: Option<HashMap<String, String>>,
    pub max_age: Option<u64>,
    pub stealth: Option<bool>,
}

Request body for Client::smartscraper.

Build with SmartScraperRequest::new; only fields you touch are serialized.

Fields

website_url: String

The URL to extract from. Required.

user_prompt: String

Plain-English description of what to extract. Required. (Wire field name is user_prompt, not prompt.)

output_schema: Option<Value>

JSON Schema the result is validated against (one repair attempt).

page_complexity: Option<PageComplexity>

Page-complexity hint.

detail_level: Option<DetailLevel>

How exhaustively to populate the result.

parse_mode: Option<ParseMode>

Cleaner mode.

plain_text: Option<bool>

Return raw text under result (bypasses schema validation).

include_tags: Option<Vec<String>>

Whitelist of tags to keep before extraction.

exclude_tags: Option<Vec<String>>

Blacklist of tags to drop before extraction.

reduce_content: Option<bool>

Trim long content before extraction (tri-state; server default when unset).

experimental: Option<bool>

Opt in to an alternate extraction path that can do better on hard-to-parse pages. Behavior may change without notice.

headers: Option<HashMap<String, String>>

Custom request headers forwarded to the fetcher. Providing headers disables URL caching for this request.

max_age: Option<u64>

URL-cache opt-in in seconds (same semantics as /scrape).

stealth: Option<bool>

Browser-based stealth fetch. +5 credits.

Implementations

impl SmartScraperRequest

pub fn new( website_url: impl Into<String>, user_prompt: impl Into<String>, ) -> Self

Start a request for website_url with the given user_prompt.

pub fn output_schema(self, schema: Value) -> Self

Set the JSON Schema for the output.

pub fn page_complexity(self, complexity: PageComplexity) -> Self

Set the page-complexity hint.

pub fn detail_level(self, level: DetailLevel) -> Self

Set the detail level.

pub fn parse_mode(self, mode: ParseMode) -> Self

Set the cleaner mode.

pub fn plain_text(self, plain_text: bool) -> Self

Return raw text instead of parsed JSON (bypasses schema validation).

pub fn include_tags<I, S>(self, tags: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the tag whitelist.

pub fn exclude_tags<I, S>(self, tags: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the tag blacklist.

pub fn reduce_content(self, reduce_content: bool) -> Self

Trim long content before extraction.

pub fn experimental(self, experimental: bool) -> Self

Opt in to an alternate extraction path that can do better on hard-to-parse pages. Behavior may change without notice.

pub fn header(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a single custom request header.

pub fn headers(self, headers: HashMap<String, String>) -> Self

Replace all custom request headers.

pub fn max_age(self, seconds: u64) -> Self

Opt into URL caching: accept cache entries fresher than seconds.

pub fn stealth(self, stealth: bool) -> Self

Use browser-based stealth fetch (+5 credits).

Trait Implementations

impl Clone for SmartScraperRequest

fn clone(&self) -> SmartScraperRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SmartScraperRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SmartScraperRequest

fn default() -> SmartScraperRequest

Returns the “default value” for a type.

impl Serialize for SmartScraperRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.