Zig API Reference
Zig API Reference v1.8.0
Section titled “Zig API Reference v1.8.0”Functions
Section titled “Functions”generate_citations()
Section titled “generate_citations()”Convert markdown links to numbered citations.
[Example](https://example.com) becomes Example[1]
with [1]: <https://example.com> in the reference list.
Images !alt are preserved unchanged.
Signature:
pub fn generate_citations(markdown: []const u8) []u8Example:
const result = generate_citations("value");Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
markdown |
\[\]const u8 |
Yes | The markdown |
Returns: []u8
create_engine()
Section titled “create_engine()”Create a new crawl engine with the given configuration.
If config is null, uses CrawlConfig.default().
Returns an error if the configuration is invalid.
Signature:
pub fn create_engine(config: ?[]const u8) CrawlError!CrawlEngineHandleExample:
const result = try create_engine(.{});Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
config |
?\[\]const u8 |
No | The configuration options |
Returns: CrawlEngineHandle
Errors: Throws CrawlError.
scrape()
Section titled “scrape()”Scrape a single URL, returning extracted page data.
Signature:
pub fn scrape(engine: ?[]const u8, url: []const u8) CrawlError![]u8Example:
const result = try scrape(.{}, "value");Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
engine |
?\[\]const u8 |
Yes | The crawl engine handle |
url |
\[\]const u8 |
Yes | The URL to fetch |
Returns: []u8
Errors: Throws CrawlError.
crawl()
Section titled “crawl()”Crawl a website starting from url, following links up to the configured depth.
Signature:
pub fn crawl(engine: ?[]const u8, url: []const u8) CrawlError![]u8Example:
const result = try crawl(.{}, "value");Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
engine |
?\[\]const u8 |
Yes | The crawl engine handle |
url |
\[\]const u8 |
Yes | The URL to fetch |
Returns: []u8
Errors: Throws CrawlError.
map_urls()
Section titled “map_urls()”Discover all pages on a website by following links and sitemaps.
Signature:
pub fn map_urls(engine: ?[]const u8, url: []const u8) CrawlError![]u8Example:
const result = try map_urls(.{}, "value");Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
engine |
?\[\]const u8 |
Yes | The crawl engine handle |
url |
\[\]const u8 |
Yes | The URL to fetch |
Returns: []u8
Errors: Throws CrawlError.
interact()
Section titled “interact()”Execute browser actions on a single page.
Signature:
pub fn interact(engine: ?[]const u8, url: []const u8, actions: []const u8) CrawlError![]u8Example:
const result = try interact(.{}, "value", &[_]u8{});Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
engine |
?\[\]const u8 |
Yes | The crawl engine handle |
url |
\[\]const u8 |
Yes | The URL to fetch |
actions |
\[\]const u8 |
Yes | The actions |
Returns: []u8
Errors: Throws CrawlError.
batch_scrape()
Section titled “batch_scrape()”Scrape multiple URLs concurrently.
Signature:
pub fn batch_scrape(engine: ?[]const u8, urls: []const u8) CrawlError![]u8Example:
const result = try batch_scrape(.{}, &[_]u8{});Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
engine |
?\[\]const u8 |
Yes | The crawl engine handle |
urls |
\[\]const u8 |
Yes | The urls |
Returns: []u8
Errors: Throws CrawlError.
batch_crawl()
Section titled “batch_crawl()”Crawl multiple seed URLs concurrently, each following links to configured depth.
Signature:
pub fn batch_crawl(engine: ?[]const u8, urls: []const u8) CrawlError![]u8Example:
const result = try batch_crawl(.{}, &[_]u8{});Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
engine |
?\[\]const u8 |
Yes | The crawl engine handle |
urls |
\[\]const u8 |
Yes | The urls |
Returns: []u8
Errors: Throws CrawlError.
ActionResult
Section titled “ActionResult”Result from a single page action execution.
| Field | Type | Default | Description |
|---|---|---|---|
action_index |
u64 |
— | Zero-based index of the action in the sequence. |
action_type |
\[\]const u8 |
— | The type of action that was executed. |
success |
bool |
— | Whether the action completed successfully. |
data |
\[\]const u8? |
null |
Action-specific return data (screenshot bytes, JS return value, scraped HTML). |
error |
\[\]const u8? |
null |
Error message if the action failed. |
ArticleMetadata
Section titled “ArticleMetadata”Article metadata extracted from article:* Open Graph tags.
| Field | Type | Default | Description |
|---|---|---|---|
published_time |
\[\]const u8? |
null |
The article publication time. |
modified_time |
\[\]const u8? |
null |
The article modification time. |
author |
\[\]const u8? |
null |
The article author. |
section |
\[\]const u8? |
null |
The article section. |
tags |
\[\]const \[\]const u8 |
[] |
The article tags. |
BatchCrawlResult
Section titled “BatchCrawlResult”Result from a single URL in a batch crawl operation.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | The seed URL that was crawled. |
result |
CrawlResult? |
null |
The crawl result, if successful. |
error |
\[\]const u8? |
null |
The error message, if the crawl failed. |
BatchCrawlResults
Section titled “BatchCrawlResults”Aggregate result of a batch crawl, exposing per-URL results plus precomputed counts.
The counts are derived once at construction so every binding language can read them
as plain integer fields without re-iterating the results vector.
| Field | Type | Default | Description |
|---|---|---|---|
results |
\[\]const BatchCrawlResult |
[] |
Per-URL crawl results, in the order seed URLs were submitted. |
total_count |
u64 |
— | Total number of seed URLs in the batch (equal to results.len()). |
completed_count |
u64 |
— | Number of seed URLs whose crawl succeeded (error is null). |
failed_count |
u64 |
— | Number of seed URLs whose crawl failed (error is Some). |
BatchCrawlStreamRequest
Section titled “BatchCrawlStreamRequest”Request to begin a multi-URL streaming crawl.
Wraps a set of seed URLs for delivery through the streaming-adapter binding surface. Required as a struct because alef’s streaming adapter requires a named request type — primitives are not supported.
| Field | Type | Default | Description |
|---|---|---|---|
urls |
\[\]const \[\]const u8 |
[] |
The seed URLs to crawl. Each URL is followed independently up to the engine’s configured depth. |
BatchScrapeResult
Section titled “BatchScrapeResult”Result from a single URL in a batch scrape operation.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | The URL that was scraped. |
result |
ScrapeResult? |
null |
The scrape result, if successful. |
error |
\[\]const u8? |
null |
The error message, if the scrape failed. |
BatchScrapeResults
Section titled “BatchScrapeResults”Aggregate result of a batch scrape, exposing per-URL results plus precomputed counts.
The counts are derived once at construction so every binding language can read them
as plain integer fields without re-iterating the results vector.
| Field | Type | Default | Description |
|---|---|---|---|
results |
\[\]const BatchScrapeResult |
[] |
Per-URL scrape results, in the order URLs were submitted. |
total_count |
u64 |
— | Total number of URLs in the batch (equal to results.len()). |
completed_count |
u64 |
— | Number of URLs whose scrape succeeded (error is null). |
failed_count |
u64 |
— | Number of URLs whose scrape failed (error is Some). |
BrowserConfig
Section titled “BrowserConfig”Browser fallback configuration.
| Field | Type | Default | Description |
|---|---|---|---|
mode |
BrowserMode |
BrowserMode.auto |
When to use the headless browser fallback. |
backend |
BrowserBackend |
BrowserBackend.chromiumoxide |
Browser backend used to render JavaScript-heavy pages. |
endpoint |
\[\]const u8? |
null |
CDP WebSocket endpoint for connecting to an external browser instance. |
timeout |
i64 |
30000ms |
Timeout for browser page load and rendering (in milliseconds when serialized). |
overall_timeout |
i64 |
60000ms |
Overall deadline for a single browser fetch, covering browser launch (or page acquisition from a shared pool), page setup, navigation, rendering, and screenshot capture. Must exceed timeout to leave room for launch and setup overhead; a fetch that has not returned within this deadline fails with a timeout error (in milliseconds when serialized). Shutdown/teardown is governed separately by shutdown_timeout and is not counted against this deadline: an already-computed result is delivered to the caller without waiting for the browser process to exit. |
shutdown_timeout |
i64 |
5000ms |
How long to wait for the browser process to close and exit cleanly during teardown before the process is forcibly killed (in milliseconds when serialized). |
wait |
BrowserWait |
BrowserWait.network_idle |
Wait strategy after browser navigation. |
wait_selector |
\[\]const u8? |
null |
CSS selector to wait for when wait is Selector. |
extra_wait |
i64? |
null |
Extra time to wait after the wait condition is met. |
proxy |
ProxyConfig? |
null |
Proxy for browser fetches. Overrides CrawlConfig.proxy when set. Native backend supports http/https only (no SOCKS5). |
block_url_patterns |
\[\]const \[\]const u8 |
[] |
URL patterns to block before the network request fires. Supports * wildcards. Useful for skipping ads/analytics/large images. Honored by BrowserBackend.Native; chromiumoxide ignores this field today. |
eval_script |
\[\]const u8? |
null |
JavaScript snippet evaluated after navigation completes. Scraping captures the native backend result in ScrapeResult.browser.eval_result. Interactions run this script before page actions on both browser backends but do not include the script result in InteractionResult. |
robots_user_agent |
\[\]const u8? |
null |
User-agent used when fetching robots.txt. Defaults to BrowserConfig.user_agent (or crawlberg’s default) if unset. Native only. |
capture_network_events |
bool |
false |
Capture the full network event stream into the result. Default false (only the document event is captured). Native only. |
session_affinity |
bool |
true |
Enable session affinity: reuse chromiumoxide Pages for same-domain requests so cookies + fingerprint + solved challenges persist. Default: true. When false, each request gets a fresh Page. |
BrowserExtras
Section titled “BrowserExtras”Browser-specific extras populated when the native browser backend was used.
Available on ScrapeResult.browser when BrowserBackend.Native handled the request.
| Field | Type | Default | Description |
|---|---|---|---|
eval_result |
\[\]const u8? |
null |
Return value of BrowserConfig.eval_script, if provided. |
network_events |
\[\]const ResponseMeta |
[] |
Network events captured during page navigation (only populated when BrowserConfig.capture_network_events is true). |
cookies |
\[\]const CookieInfo |
[] |
All non-expired cookies present in the browser’s cookie jar after navigation completes (includes both prior cookies and server Set-Cookie). |
CitationReference
Section titled “CitationReference”A single numbered reference in a citation list — produced by the citation
extractor when content uses inline [N]-style markers.
| Field | Type | Default | Description |
|---|---|---|---|
index |
u64 |
— | 1-based reference number as it appears in the source text. |
url |
\[\]const u8 |
— | Resolved absolute URL for this reference. |
text |
\[\]const u8 |
— | Human-readable anchor text or title for the reference. |
CitationResult
Section titled “CitationResult”Result of citation conversion.
| Field | Type | Default | Description |
|---|---|---|---|
content |
\[\]const u8 |
— | Markdown with links replaced by numbered citations. |
references |
\[\]const CitationReference |
[] |
Numbered reference list: (index, url, text). |
ContentConfig
Section titled “ContentConfig”Content extraction and conversion configuration.
Controls how HTML is converted to the output format. Uses html-to-markdown-rs as the conversion engine for all formats (markdown, plain text, djot).
| Field | Type | Default | Description |
|---|---|---|---|
output_format |
\[\]const u8 |
"markdown" |
Output format: "markdown" (default), "plain", "djot". |
preprocessing_preset |
\[\]const u8 |
"standard" |
Preprocessing aggressiveness: "minimal", "standard" (default), "aggressive". - Minimal: only scripts/styles removed. - Standard: also removes nav, nav-hinted headers/footers/asides, forms. - Aggressive: removes all footers/asides unconditionally. |
remove_navigation |
bool |
true |
Remove navigation elements (nav, breadcrumbs, menus). Default: true. |
remove_forms |
bool |
true |
Remove form elements. Default: true. |
strip_tags |
\[\]const \[\]const u8 |
[] |
HTML tag names to strip (render children only, remove the tag wrapper). Default: []. |
preserve_tags |
\[\]const \[\]const u8 |
[] |
HTML tag names to preserve as raw HTML in output. |
exclude_selectors |
\[\]const \[\]const u8 |
["noscript"] |
CSS selectors for elements to exclude entirely (element + all content). Unlike strip_tags (which removes the wrapper but keeps children), excluded elements and all descendants are dropped. Supports CSS selectors: .class, #id, [attribute], compound selectors. Default: ["noscript"]. <noscript> fallback content (no-JS notices, tracking pixels, GTM iframes) is meant for browsers with JavaScript disabled, not for a markdown reader, and strip_tags cannot drop it — on preprocessing_preset: "standard" (crawlberg’s only path) it only removes the wrapper and still renders the children. Example: [".cookie-banner", "#ad-container", "[role='complementary']"] |
skip_images |
bool |
false |
Skip image elements in output. Default: false. |
max_depth |
u64? |
null |
Max DOM traversal depth. Prevents stack overflow on deeply nested HTML. |
wrap |
bool |
false |
Enable line wrapping. Default: false. |
wrap_width |
u64 |
80 |
Wrap width when wrap is enabled. Default: 80. |
include_document_structure |
bool |
true |
Include document structure tree in output. Default: true. |
extract_metadata |
bool |
true |
Prepend a YAML frontmatter block (title, description, etc., extracted from <head>) to the markdown output. Default: true. This only controls the frontmatter text inside markdown.content. Crawlberg never reads <head> metadata back out of the converter’s result – PageMetadata is populated independently by crate.html.metadata.extract_metadata from the parsed DOM, so turning this off does not lose any metadata field. |
CookieInfo
Section titled “CookieInfo”Information about an HTTP cookie received from a response.
| Field | Type | Default | Description |
|---|---|---|---|
name |
\[\]const u8 |
— | The cookie name. |
value |
\[\]const u8 |
— | The cookie value. |
domain |
\[\]const u8? |
null |
The cookie domain, if specified. |
path |
\[\]const u8? |
null |
The cookie path, if specified. |
CrawlConfig
Section titled “CrawlConfig”Configuration for crawl, scrape, and map operations.
| Field | Type | Default | Description |
|---|---|---|---|
max_depth |
u64? |
null |
Maximum crawl depth (number of link hops from the start URL). |
max_pages |
u64? |
null |
Maximum number of pages to crawl. |
max_links_per_page |
u64? |
null |
Maximum links enqueued from a single page. Defaults to 10000. Bounds the work one hostile or pathological page can create; links past the cap are dropped and a warning is logged. |
max_concurrent |
u64? |
null |
Maximum number of concurrent requests. |
crawl_strategy |
CrawlStrategyKind |
CrawlStrategyKind.bfs |
Traversal order. Defaults to breadth-first. A frontier or strategy set explicitly on CrawlEngineBuilder takes precedence over this field. |
content_filter |
ContentFilterKind? |
null |
Content filter applied to each page. null keeps every page. A content filter set explicitly on CrawlEngineBuilder takes precedence. |
bm25_query |
\[\]const u8? |
null |
Query the BM25 content filter scores pages against. Required by ContentFilterKind.Bm25. |
bm25_threshold |
f64? |
null |
Minimum BM25 score a page must reach to be kept. Defaults to 0.0. |
respect_robots_txt |
bool |
false |
Whether to respect robots.txt directives. |
soft_http_errors |
bool |
false |
When true, HTTP-level error responses (404 NotFound, 403 Forbidden, WAF blocks) are surfaced as ScrapeResult records with the matching status_code rather than raised as CrawlError. Default false preserves the historical throw-on-error contract for direct fetches. Independently of this flag, 404s reached at the end of a redirect chain are always surfaced softly — the user opted into redirect-following, so receiving a 404 there is part of the normal flow rather than an unexpected error. |
user_agent |
\[\]const u8? |
null |
Custom user-agent string. |
stay_on_domain |
bool |
false |
Whether to confine document links (.pdf, .docx, .zip, …) to the seed domain. Page links are always confined to the seed host, widened to its subdomains by Self.allow_subdomains; this flag does not loosen that. It applies only to document links, which are classified by file extension before their host is considered and so are followed cross-host by default – the usual case being documents served from a CDN or object store. Set this to true to require documents to live on the seed domain too. |
allow_subdomains |
bool |
false |
Whether subdomains of the seed host are in scope. Applies to page links unconditionally, and to document links when Self.stay_on_domain is set. |
include_paths |
\[\]const \[\]const u8 |
[] |
Regex patterns for paths to include during crawling. |
exclude_paths |
\[\]const \[\]const u8 |
[] |
Regex patterns for paths to exclude during crawling. |
path_patterns_match_query |
bool |
false |
Whether include_paths/exclude_paths match against path?query instead of just path. Defaults to false, matching path only: a pattern anchored with $ (e.g. /feed/?$) changes meaning once the query joins the matched text, so this must stay opt-in rather than silently changing what an existing config matches. |
dedup_include_query |
bool |
false |
Whether the crawl-dedup key includes the (sorted) query string. Defaults to false, matching historical behavior: /item?id=1 and /item?id=2 are treated as one page and only the first is fetched. true keeps the query, sorted, in the key, so each distinct query is fetched once. |
strip_tracking_params |
bool |
false |
Whether to strip tracking_params from a discovered URL before it is deduplicated, fetched, and reported. Defaults to false, so no tracking parameters are stripped unless explicitly enabled. |
tracking_params |
\[\]const \[\]const u8 |
["utm_*", "fbclid", "gclid", "ref"] |
Query parameter name patterns to strip when strip_tracking_params is true. A pattern ending in * matches by prefix (utm_* matches utm_source, utm_campaign, …); any other pattern matches the parameter name exactly. Defaults to ["utm_*", "fbclid", "gclid", "ref"], applied only once strip_tracking_params is enabled. |
custom_headers |
std.StringHashMap(\[\]const u8) |
{} |
Custom HTTP headers to send with each request. |
request_timeout |
i64 |
30000ms |
Timeout for individual HTTP requests (in milliseconds when serialized). |
rate_limit_ms |
u64? |
null |
Per-domain rate limit in milliseconds. When set, enforces a minimum delay between requests to the same domain. Defaults to 200ms when null. |
max_redirects |
u64 |
10 |
Maximum number of redirects to follow. |
retry_count |
u64 |
0 |
Number of retry attempts for failed requests. Bounded by MAX_RETRY_COUNT. |
retry_codes |
\[\]const u16 |
[] |
HTTP status codes that should trigger a retry. |
retry_initial_delay_ms |
u64 |
100 |
Initial delay, in milliseconds, before the first retry. Doubled on each subsequent attempt (capped at retry_max_delay_ms). Defaults to 100ms. |
retry_max_delay_ms |
u64 |
60000 |
Upper bound, in milliseconds, on the exponential retry backoff. Defaults to 60s. |
rate_limit_jitter_ratio |
f64 |
0 |
Fraction of the per-domain rate-limit delay to randomly jitter by, in [0.0, 1.0]. 0.0 (the default) applies no jitter and preserves the previous fixed-interval behaviour; 0.1 jitters the delay by up to ±10%. |
cookies_enabled |
bool |
false |
Whether to enable cookie handling. |
auth |
AuthConfig? |
null |
Authentication configuration. |
max_body_size |
u64? |
null |
Maximum response body size in bytes. null does not mean unbounded: an unset cap falls back to a 100 MiB safety ceiling, because HTTP responses are decompressed while being read and a few hundred compressed bytes can otherwise expand to gigabytes in memory. To read bodies larger than that, set this explicitly. |
remove_tags |
\[\]const \[\]const u8 |
[] |
CSS selectors for tags to remove from HTML before processing. |
content |
ContentConfig |
— | Content extraction and conversion configuration. |
map_limit |
u64? |
null |
Maximum number of URLs to return from a map operation. |
map_search |
\[\]const u8? |
null |
Search filter for map results (case-insensitive substring match on URLs). |
download_assets |
bool |
false |
Whether to download assets (CSS, JS, images, etc.) from the page. |
asset_types |
\[\]const AssetCategory |
[] |
Filter for asset categories to download. |
max_asset_size |
u64? |
null |
Maximum size in bytes for individual asset downloads. |
browser |
BrowserConfig |
— | Browser configuration. |
proxy |
ProxyConfig? |
null |
Proxy configuration for HTTP requests. |
user_agents |
\[\]const \[\]const u8 |
[] |
List of user-agent strings for rotation. If non-empty, overrides user_agent. |
capture_screenshot |
bool |
false |
Whether to capture a screenshot when using the browser. Only supported by scrape() with BrowserBackend.Chromiumoxide and BrowserMode.Always or Stealth. A screenshot is 100–500 KB of PNG per page, so crawl() does not carry screenshots in CrawlPageResult/CrawlResult at all — a multi-thousand-page crawl holding one per page in memory is not a safe default. Setting this with any other configuration (a different backend, BrowserMode.Auto/Never, or during crawl()) has no effect and logs a warning rather than silently doing nothing. |
follow_document_urls |
bool |
false |
Re-enqueue discovered LinkType.Document URLs into the crawl frontier so the crawl follows links from document pages (PDFs, etc.) as it would from HTML pages. Default: false (documents terminate at materialisation). |
document_url_depth |
u32? |
null |
Maximum document-depth (from the seed URL through document links only) when follow_document_urls is true. null means inherit max_depth. Independent of max_depth: a document URL is enqueued only if BOTH the outer max_depth and (if set) document_url_depth permit it. |
download_documents |
bool |
true |
Whether to download non-HTML documents (PDF, DOCX, images, code, etc.) instead of skipping them. Defaults to true — unlike download_assets and capture_screenshot, which default to false. |
document_max_size |
u64? |
52428800 |
Maximum size in bytes for document downloads. Defaults to 50 MB. |
document_mime_types |
\[\]const \[\]const u8 |
[] |
Allowlist of MIME types to download. If empty, uses built-in defaults. |
document_output_dir |
\[\]const u8? |
null |
Directory to stream downloaded document bytes into instead of holding them in memory on DownloadedDocument.content. When set, content is left empty and DownloadedDocument.content_path is populated with <dir>/<content_hash>.<ext>. null (default) preserves today’s in-memory-only behavior. Has no effect on wasm32, which has no filesystem — use document_content_encoding there instead. |
document_content_encoding |
DocumentContentEncoding? |
null |
Opt-in encoding that duplicates DownloadedDocument.content into a serializable field for language bindings that need the bytes in-memory (content itself is alef(skip)ed). null (default) means no encoding is produced. Independent of document_output_dir — set both to get a file on disk and an in-memory copy. |
warc_output |
\[\]const u8? |
null |
Path to write WARC output. If null, WARC output is disabled. |
browser_profile |
\[\]const u8? |
null |
Named browser profile for persistent sessions (cookies, localStorage). Chromiumoxide backend only. The native backend runs an in-process JavaScript engine with no Chrome process and therefore no profile directory, so this is ignored there and logs a warning. It is also ignored — with a warning — when a shared browser pool is in use (the pool launches before any per-crawl config exists) or when connecting to an external CDP endpoint whose process crawlberg does not own. |
save_browser_profile |
bool |
false |
Whether to save changes back to the browser profile on exit. |
ssrf |
SsrfPolicy |
crawlberg::SsrfPolicy::from_env() |
SSRF policy for outbound network requests. Default: deny private networks, allow http/https only, max 5 redirects. All policy fields are exposed to language bindings. wasm32 (including Node.js): deny_private does not stop hostname-based requests. There is no DNS resolution on this target, so only a literal IP host is checked against the policy — a domain name is always permitted, regardless of deny_private. Under Node, where fetch enforces no CORS, this means a service embedding the wasm binding can be driven to internal hosts by domain name even with deny_private = true. Enforce egress restrictions at the network layer for that deployment target; do not rely on this field. See crawlberg.net.validate_url. |
ssrf_deny_private_explicit |
bool? |
null |
Pins SsrfPolicy.deny_private to a caller-chosen value, bypassing the CRAWLBERG_ALLOW_PRIVATE_NETWORK operator override entirely for this config. ssrf.deny_private is a plain, always-serialized bool: several alef-generated bindings construct SsrfPolicy.default() (hardcoding deny_private: true) whenever their caller never touches SSRF settings at all, so true on that field alone cannot distinguish “the caller wants private networks denied” from “the binding’s own structural default landed on true”. The environment variable exists precisely to resolve that ambiguity in the common case by treating any true as inconclusive and deferring to the operator. Set this field when that default-deferral is wrong for your call — e.g. a test that must prove deny_private: true still denies even while the operator has set CRAWLBERG_ALLOW_PRIVATE_NETWORK suite-wide for every other call. null (default) preserves today’s behavior: the environment variable may still flip ssrf.deny_private to false. Some(value) pins ssrf.deny_private to value and the environment variable is not consulted for this config. |
CrawlEngineHandle
Section titled “CrawlEngineHandle”Opaque handle to a configured crawl engine.
Constructed via create_engine with an optional CrawlConfig.
Default implementations for all pluggable components are used internally.
CrawlPageResult
Section titled “CrawlPageResult”The result of crawling a single page during a crawl operation.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | The original URL of the page. |
normalized_url |
\[\]const u8 |
— | The normalized URL of the page. |
status_code |
u16 |
— | The HTTP status code of the response. |
content_type |
\[\]const u8 |
— | The Content-Type header value. |
html |
\[\]const u8 |
— | The HTML body of the response. |
body_size |
u64 |
— | The size of the response body in bytes. |
metadata |
PageMetadata |
— | Extracted metadata from the page. |
links |
\[\]const LinkInfo |
[] |
Links found on the page. |
images |
\[\]const ImageInfo |
[] |
Images found on the page. |
feeds |
\[\]const FeedInfo |
[] |
Feed links found on the page. |
json_ld |
\[\]const JsonLdEntry |
[] |
JSON-LD entries found on the page. |
depth |
u64 |
— | The depth of this page from the start URL. |
stayed_on_domain |
bool |
— | Whether this page is on the same domain as the start URL. |
was_skipped |
bool |
— | Whether this page was skipped (binary or PDF content). |
is_pdf |
bool |
— | Whether the content is a PDF. |
detected_charset |
\[\]const u8? |
null |
The detected character set encoding. |
markdown |
MarkdownResult? |
null |
Markdown conversion of the page content. |
extracted_data |
\[\]const u8? |
null |
Structured data extracted by LLM. Populated when extraction is configured. |
extraction_meta |
ExtractionMeta? |
null |
Metadata about the LLM extraction pass (cost, tokens, model). |
downloaded_document |
DownloadedDocument? |
null |
Downloaded non-HTML document (PDF, DOCX, image, code, etc.). |
browser_used |
bool |
— | Whether the browser fallback was used to fetch this page. |
final_url |
\[\]const u8 |
— | The URL this page’s content was actually fetched from, after following any HTTP, Refresh header, or <meta http-equiv="refresh"> redirect url pointed at. Equal to url when the fetch did not redirect. |
redirect_count |
u64 |
— | Redirect hops taken to reach final_url from url. |
CrawlResult
Section titled “CrawlResult”The result of a multi-page crawl operation.
| Field | Type | Default | Description |
|---|---|---|---|
pages |
\[\]const CrawlPageResult |
[] |
The list of crawled pages. |
final_url |
\[\]const u8 |
— | The final URL after following redirects. |
redirect_count |
u64 |
— | The number of redirects followed. |
was_skipped |
bool |
— | Whether any page was skipped during crawling. |
error |
\[\]const u8? |
null |
An error message, if the crawl encountered an issue. |
cookies |
\[\]const CookieInfo |
[] |
Cookies collected during the crawl. |
stayed_on_domain |
bool |
— | Whether all crawled pages stayed on the same domain as the start URL. |
browser_used |
bool |
— | Whether the browser fallback was used for any page in this crawl. |
CrawlStreamRequest
Section titled “CrawlStreamRequest”Request to begin a single-URL streaming crawl.
Wraps a single seed URL for delivery through the streaming-adapter binding surface. Required as a struct because alef’s streaming adapter requires a named request type — primitives are not supported.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | The seed URL to crawl. |
DownloadedAsset
Section titled “DownloadedAsset”A downloaded asset from a page.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | The original URL of the asset. |
content_hash |
\[\]const u8 |
— | The SHA-256 content hash of the asset. |
mime_type |
\[\]const u8? |
null |
The MIME type from the Content-Type header. |
size |
u64 |
— | The size of the asset in bytes. |
asset_category |
AssetCategory |
AssetCategory.image |
The category of the asset. |
html_tag |
\[\]const u8? |
null |
The HTML tag that referenced this asset (e.g., “link”, “script”, “img”). |
DownloadedDocument
Section titled “DownloadedDocument”A downloaded non-HTML document (PDF, DOCX, image, code file, etc.).
When the crawler encounters non-HTML content and download_documents is
enabled, it downloads the raw bytes and populates this struct instead of
skipping the resource.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | The URL the document was fetched from. |
mime_type |
\[\]const u8 |
— | The MIME type from the Content-Type header. |
size |
u64 |
— | Size of the document in bytes. |
filename |
\[\]const u8? |
null |
Filename extracted from Content-Disposition or URL path. |
content_hash |
\[\]const u8 |
— | SHA-256 hex digest of the content. |
headers |
std.StringHashMap(\[\]const u8) |
{} |
Selected response headers. |
truncated |
bool |
— | True when content (or the file at content_path) was truncated to document_max_size; size still reports the original, untruncated length. |
content_path |
\[\]const u8? |
null |
Filesystem path the document was streamed to when document_output_dir was set. content is empty in memory when this is populated. |
content_base64 |
\[\]const u8? |
null |
Base64-encoded copy of content, populated only when document_content_encoding was set to Base64. |
ExtractionMeta
Section titled “ExtractionMeta”Metadata about an LLM extraction pass.
| Field | Type | Default | Description |
|---|---|---|---|
cost |
f64? |
null |
Estimated cost of the LLM call in USD. |
prompt_tokens |
u64? |
null |
Number of prompt (input) tokens consumed. |
completion_tokens |
u64? |
null |
Number of completion (output) tokens generated. |
model |
\[\]const u8? |
null |
The model identifier used for extraction. |
chunks_processed |
u64 |
— | Number of content chunks sent to the LLM. |
FaviconInfo
Section titled “FaviconInfo”Information about a favicon or icon link.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | The icon URL. |
rel |
\[\]const u8 |
— | The rel attribute (e.g., “icon”, “apple-touch-icon”). |
sizes |
\[\]const u8? |
null |
The sizes attribute, if present. |
mime_type |
\[\]const u8? |
null |
The MIME type, if present. |
FeedInfo
Section titled “FeedInfo”Information about a feed link found on a page.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | The feed URL. |
title |
\[\]const u8? |
null |
The feed title, if present. |
feed_type |
FeedType |
FeedType.rss |
The type of feed. |
HeadingInfo
Section titled “HeadingInfo”A heading element extracted from the page.
| Field | Type | Default | Description |
|---|---|---|---|
level |
u8 |
— | The heading level (1-6). |
text |
\[\]const u8 |
— | The heading text content. |
HreflangEntry
Section titled “HreflangEntry”An hreflang alternate link entry.
| Field | Type | Default | Description |
|---|---|---|---|
lang |
\[\]const u8 |
— | The language code (e.g., “en”, “fr”, “x-default”). |
url |
\[\]const u8 |
— | The URL for this language variant. |
ImageInfo
Section titled “ImageInfo”Information about an image found on a page.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | The image URL. |
alt |
\[\]const u8? |
null |
The alt text, if present. |
width |
u32? |
null |
The width attribute, if present and parseable. |
height |
u32? |
null |
The height attribute, if present and parseable. |
source |
ImageSource |
ImageSource.img |
The source of the image reference. |
InteractionResult
Section titled “InteractionResult”Result of executing a sequence of page interaction actions.
| Field | Type | Default | Description |
|---|---|---|---|
action_results |
\[\]const ActionResult |
[] |
Results from each executed action. |
final_html |
\[\]const u8 |
— | Final page HTML after all actions completed. |
final_url |
\[\]const u8 |
— | Final page URL (may have changed due to navigation). |
screenshot_base64 |
\[\]const u8? |
null |
Base64-encoded PNG screenshot taken after all actions. Populated only when a PageAction.Screenshot action actually ran, so callers that never request a screenshot do not pay the encoding cost. |
JsonLdEntry
Section titled “JsonLdEntry”A JSON-LD structured data entry found on a page.
| Field | Type | Default | Description |
|---|---|---|---|
schema_type |
\[\]const u8 |
— | The @type value from the JSON-LD object. |
name |
\[\]const u8? |
null |
The name value, if present. |
raw |
\[\]const u8 |
— | The raw JSON-LD string. |
LinkInfo
Section titled “LinkInfo”Information about a link found on a page.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | The resolved URL of the link. |
text |
\[\]const u8 |
— | The visible text of the link. |
link_type |
LinkType |
LinkType.internal |
The classification of the link. |
rel |
\[\]const u8? |
null |
The rel attribute value, if present. |
nofollow |
bool |
— | Whether the link has rel="nofollow". |
MapResult
Section titled “MapResult”The result of a map operation, containing discovered URLs.
| Field | Type | Default | Description |
|---|---|---|---|
urls |
\[\]const SitemapUrl |
[] |
The list of discovered URLs. |
MarkdownResult
Section titled “MarkdownResult”Rich markdown conversion result from HTML processing.
| Field | Type | Default | Description |
|---|---|---|---|
content |
\[\]const u8 |
— | Converted markdown text. |
document_structure |
\[\]const u8? |
null |
Structured document tree with semantic nodes. |
tables |
\[\]const \[\]const u8 |
[] |
Extracted tables with structured cell data. |
warnings |
\[\]const \[\]const u8 |
[] |
Non-fatal processing warnings. |
citations |
bool |
— | Whether citation conversion was applied and produced at least one reference. true when the markdown contained inline links that were converted to numbered citation references. The converted content (with [N] markers) is available in content; the full reference list is accessible via generate_citations if needed separately. |
fit_content |
\[\]const u8? |
null |
Content-filtered markdown optimized for LLM consumption. |
PageMetadata
Section titled “PageMetadata”Metadata extracted from an HTML page’s <meta> tags and <title> element.
| Field | Type | Default | Description |
|---|---|---|---|
title |
\[\]const u8? |
null |
The page title from the <title> element. |
description |
\[\]const u8? |
null |
The meta description. |
canonical_url |
\[\]const u8? |
null |
The canonical URL from <link rel="canonical">. |
keywords |
\[\]const u8? |
null |
Keywords from <meta name="keywords">. |
author |
\[\]const u8? |
null |
Author from <meta name="author">. |
viewport |
\[\]const u8? |
null |
Viewport content from <meta name="viewport">. |
theme_color |
\[\]const u8? |
null |
Theme color from <meta name="theme-color">. |
generator |
\[\]const u8? |
null |
Generator from <meta name="generator">. |
robots |
\[\]const u8? |
null |
Robots content from <meta name="robots">. |
html_lang |
\[\]const u8? |
null |
The lang attribute from the <html> element. |
html_dir |
\[\]const u8? |
null |
The dir attribute from the <html> element. |
og_title |
\[\]const u8? |
null |
Open Graph title. |
og_type |
\[\]const u8? |
null |
Open Graph type. |
og_image |
\[\]const u8? |
null |
Open Graph image URL. |
og_description |
\[\]const u8? |
null |
Open Graph description. |
og_url |
\[\]const u8? |
null |
Open Graph URL. |
og_site_name |
\[\]const u8? |
null |
Open Graph site name. |
og_locale |
\[\]const u8? |
null |
Open Graph locale. |
og_video |
\[\]const u8? |
null |
Open Graph video URL. |
og_audio |
\[\]const u8? |
null |
Open Graph audio URL. |
og_locale_alternates |
\[\]const \[\]const u8? |
[] |
Open Graph locale alternates. |
twitter_card |
\[\]const u8? |
null |
Twitter card type. |
twitter_title |
\[\]const u8? |
null |
Twitter title. |
twitter_description |
\[\]const u8? |
null |
Twitter description. |
twitter_image |
\[\]const u8? |
null |
Twitter image URL. |
twitter_site |
\[\]const u8? |
null |
Twitter site handle. |
twitter_creator |
\[\]const u8? |
null |
Twitter creator handle. |
dc_title |
\[\]const u8? |
null |
Dublin Core title. |
dc_creator |
\[\]const u8? |
null |
Dublin Core creator. |
dc_subject |
\[\]const u8? |
null |
Dublin Core subject. |
dc_description |
\[\]const u8? |
null |
Dublin Core description. |
dc_publisher |
\[\]const u8? |
null |
Dublin Core publisher. |
dc_date |
\[\]const u8? |
null |
Dublin Core date. |
dc_type |
\[\]const u8? |
null |
Dublin Core type. |
dc_format |
\[\]const u8? |
null |
Dublin Core format. |
dc_identifier |
\[\]const u8? |
null |
Dublin Core identifier. |
dc_language |
\[\]const u8? |
null |
Dublin Core language. |
dc_rights |
\[\]const u8? |
null |
Dublin Core rights. |
article |
ArticleMetadata? |
null |
Article metadata from article:* Open Graph tags. |
hreflangs |
\[\]const HreflangEntry? |
[] |
Hreflang alternate links. |
favicons |
\[\]const FaviconInfo? |
[] |
Favicon and icon links. |
headings |
\[\]const HeadingInfo? |
[] |
Heading elements (h1-h6). |
word_count |
u64? |
null |
Computed word count of the page body text. |
ProxyConfig
Section titled “ProxyConfig”Proxy configuration for HTTP requests.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | Proxy URL (e.g. “http://proxy:8080”, “socks5://proxy:1080”). |
username |
\[\]const u8? |
null |
Optional username for proxy authentication. |
password |
\[\]const u8? |
null |
Optional password for proxy authentication. |
ResponseMeta
Section titled “ResponseMeta”Response metadata extracted from HTTP headers.
| Field | Type | Default | Description |
|---|---|---|---|
etag |
\[\]const u8? |
null |
The ETag header value. |
last_modified |
\[\]const u8? |
null |
The Last-Modified header value. |
cache_control |
\[\]const u8? |
null |
The Cache-Control header value. |
server |
\[\]const u8? |
null |
The Server header value. |
x_powered_by |
\[\]const u8? |
null |
The X-Powered-By header value. |
content_language |
\[\]const u8? |
null |
The Content-Language header value. |
content_encoding |
\[\]const u8? |
null |
The Content-Encoding header value. |
ScrapeResult
Section titled “ScrapeResult”The result of a single-page scrape operation.
| Field | Type | Default | Description |
|---|---|---|---|
status_code |
u16 |
— | The HTTP status code of the response. |
final_url |
\[\]const u8 |
— | The final URL after following all redirects. |
content_type |
\[\]const u8 |
— | The Content-Type header value. |
html |
\[\]const u8 |
— | The HTML body of the response. |
body_size |
u64 |
— | The size of the response body in bytes. |
metadata |
PageMetadata |
— | Extracted metadata from the page. |
links |
\[\]const LinkInfo |
[] |
Links found on the page. |
images |
\[\]const ImageInfo |
[] |
Images found on the page. |
feeds |
\[\]const FeedInfo |
[] |
Feed links found on the page. |
json_ld |
\[\]const JsonLdEntry |
[] |
JSON-LD entries found on the page. |
is_allowed |
bool |
— | Whether the URL is allowed by robots.txt. |
crawl_delay |
u64? |
null |
The crawl delay from robots.txt, in seconds. |
noindex_detected |
bool |
— | Whether a noindex directive was detected. |
nofollow_detected |
bool |
— | Whether a nofollow directive was detected. |
x_robots_tag |
\[\]const u8? |
null |
The X-Robots-Tag header value, if present. |
is_pdf |
bool |
— | Whether the content is a PDF. |
was_skipped |
bool |
— | Whether the page was skipped (binary or PDF content). |
detected_charset |
\[\]const u8? |
null |
The detected character set encoding. |
auth_header_sent |
bool |
— | Whether an authentication header was sent with the request. |
response_meta |
ResponseMeta? |
null |
Response metadata extracted from HTTP headers. |
assets |
\[\]const DownloadedAsset |
[] |
Downloaded assets from the page. |
js_render_hint |
bool |
— | Whether the page content suggests JavaScript rendering is needed. |
browser_used |
bool |
— | Whether the browser fallback was used to fetch this page. |
markdown |
MarkdownResult? |
null |
Markdown conversion of the page content. |
extracted_data |
\[\]const u8? |
null |
Structured data extracted by LLM. Populated when extraction is configured. |
extraction_meta |
ExtractionMeta? |
null |
Metadata about the LLM extraction pass (cost, tokens, model). |
screenshot_base64 |
\[\]const u8? |
null |
Base64-encoded PNG screenshot of the page. Populated only when CrawlConfig.capture_screenshot was enabled for this request, so callers that never requested a screenshot do not pay the encoding cost. |
downloaded_document |
DownloadedDocument? |
null |
Downloaded non-HTML document (PDF, DOCX, image, code, etc.). |
browser |
BrowserExtras? |
null |
Browser-specific extras (eval result, network events, cookies). Only populated when BrowserBackend.Native was used for this request. |
SitemapUrl
Section titled “SitemapUrl”A URL entry from a sitemap.
| Field | Type | Default | Description |
|---|---|---|---|
url |
\[\]const u8 |
— | The URL. |
lastmod |
\[\]const u8? |
null |
The last modification date, if present. |
changefreq |
\[\]const u8? |
null |
The change frequency, if present. |
priority |
\[\]const u8? |
null |
The priority, if present. |
SsrfPolicy
Section titled “SsrfPolicy”SSRF policy configuration.
| Field | Type | Default | Description |
|---|---|---|---|
deny_private |
bool |
true |
If true, reject URLs that resolve to private/metadata IP ranges. |
allowlist |
\[\]const HostMatcher |
[] |
Hostnames and IP ranges permitted regardless of deny_private. The allowlist is an override of deny_private, not an intersection with it. Precedence, in order: 1. deny_private == false permits everything; the allowlist is not consulted. 2. A hostname matching an Exact or Suffix entry is permitted immediately, before DNS resolution — so the deny-list is never applied to it. This trusts the host string: a name that resolves into private space is still permitted. 3. A literal or resolved IP inside a Cidr entry is permitted even though it is in the default deny-list. 4. Otherwise the default deny-list decides. An empty allowlist therefore denies nothing by itself — it simply leaves deny_private and the deny-list in sole control. |
max_redirects |
u8 |
5 |
Maximum number of HTTP redirects to follow during validation. |
scheme_allowlist |
\[\]const \[\]const u8 |
["http", "https"] |
Allowed URI schemes. Default: ["http", "https"]. Only http and https are supported. An empty list denies every URL. |
BrowserMode
Section titled “BrowserMode”When to use the headless browser fallback.
| Value | Description |
|---|---|
auto |
Automatically detect when JS rendering is needed and fall back to browser. |
always |
Always use the browser for every request. |
never |
Never use the browser fallback. |
stealth |
Always use the browser with all stealth surfaces enabled. Behaves like Always for escalation purposes (every request is routed through the browser tier), but additionally enables: - browser JavaScript stealth patches - native-backend TLS fingerprint spoofing - stealth-aware default user-agent when no explicit UA is set - 1920×1080 viewport override Use this instead of setting the now-removed BrowserConfig.stealth boolean field. |
BrowserWait
Section titled “BrowserWait”Wait strategy for browser page rendering.
| Value | Description |
|---|---|
network_idle |
Wait until network activity is idle. |
selector |
Wait for a specific CSS selector to appear in the DOM. |
fixed |
Wait for a fixed duration after navigation. |
BrowserBackend
Section titled “BrowserBackend”Browser backend used for JavaScript rendering.
| Value | Description |
|---|---|
chromiumoxide |
Existing Chromium/CDP backend powered by chromiumoxide. |
native |
Crawlberg-owned native browser backend derived from Obscura. |
DocumentContentEncoding
Section titled “DocumentContentEncoding”Opt-in encoding applied to a downloaded document’s bytes for callers who need the content available in a serializable field rather than reading it from disk.
null (the CrawlConfig.document_content_encoding default) produces neither — unlike
screenshots, base64-encoding a document by default would duplicate an already
up-to-document_max_size buffer (50 MB default) in memory per document.
| Value | Description |
|---|---|
base64 |
Populate DownloadedDocument.content_base64 with a base64-encoded copy. |
CrawlStrategyKind
Section titled “CrawlStrategyKind”Traversal order for a crawl.
Selects both the queue discipline and the selection strategy, because global order is a property of the frontier: the engine hands its bounded selection window to the strategy, so a strategy alone can only reorder URLs that have already been dequeued.
| Value | Description |
|---|---|
bfs |
Breadth-first: a FIFO frontier visits every URL at one depth before the next. |
dfs |
Depth-first: a LIFO frontier descends into a page’s children before its siblings. |
best_first |
Highest-priority-first within the selection window, scored by CrawlStrategy.score_url. |
adaptive |
Like BestFirst, but stops once newly crawled pages stop contributing new terms. |
ContentFilterKind
Section titled “ContentFilterKind”Content filter applied to each crawled page before it reaches the result.
| Value | Description |
|---|---|
bm25 |
Keep only pages scoring at or above bm25_threshold for bm25_query. |
AuthConfig
Section titled “AuthConfig”Authentication configuration.
| Value | Description |
|---|---|
basic |
HTTP Basic authentication. — Fields: username: []const u8, password: []const u8 |
bearer |
Bearer token authentication. — Fields: token: []const u8 |
header |
Custom authentication header. — Fields: name: []const u8, value: []const u8 |
LinkType
Section titled “LinkType”The classification of a link.
| Value | Description |
|---|---|
internal |
A link to the same domain. |
external |
A link to a different domain. |
anchor |
A fragment-only link (e.g., #section). |
document |
A link to a downloadable document (PDF, DOC, etc.). |
ImageSource
Section titled “ImageSource”The source of an image reference.
| Value | Description |
|---|---|
img |
An <img> tag. |
picture_source |
A <source> tag inside <picture>. |
og_image |
An og:image meta tag. |
twitter_image |
A twitter:image meta tag. |
FeedType
Section titled “FeedType”The type of a feed (RSS, Atom, or JSON Feed).
| Value | Description |
|---|---|
rss |
RSS feed. |
atom |
Atom feed. |
json_feed |
JSON Feed. |
AssetCategory
Section titled “AssetCategory”The category of a downloaded asset.
| Value | Description |
|---|---|
document |
A document file (PDF, DOC, etc.). |
image |
An image file. |
audio |
An audio file. |
video |
A video file. |
font |
A font file. |
stylesheet |
A CSS stylesheet. |
script |
A JavaScript file. |
archive |
An archive file (ZIP, TAR, etc.). |
data |
A data file (JSON, XML, CSV, etc.). |
other |
An unrecognized asset type. |
CrawlEvent
Section titled “CrawlEvent”An event emitted during a streaming crawl operation.
Not available on wasm32 targets — streaming requires native concurrency
primitives (tokio channels, JoinSet) that are not supported on wasm32.
Delivered to bindings through each target’s native streaming idiom.
| Value | Description |
|---|---|
page |
A single page has been crawled. — Fields: result: CrawlPageResult |
error |
An error occurred while crawling a URL. — Fields: url: []const u8, error: []const u8 |
complete |
The crawl has completed. — Fields: pages_crawled: u64 |
PageAction
Section titled “PageAction”A single page interaction action.
Actions are serialized with a type tag using camelCase naming,
except ExecuteJs which is explicitly renamed to "executeJs".
| Value | Description |
|---|---|
click |
Click on an element matching the given CSS selector. — Fields: selector: []const u8 |
type_text |
Type text into an element matching the given CSS selector. — Fields: selector: []const u8, text: []const u8 |
press |
Press a keyboard key (e.g. “Enter”, “Tab”, “Escape”). — Fields: key: []const u8 |
scroll |
Scroll the page or a specific element. — Fields: direction: ScrollDirection, selector: []const u8, amount: i64 |
wait |
Wait for a duration or for an element to appear. — Fields: milliseconds: i64, selector: []const u8 |
screenshot |
Take a screenshot of the current page. — Fields: full_page: bool |
execute_js |
Execute arbitrary JavaScript in the page context. Safety: The script runs with full page privileges in the browser context. Only execute scripts from trusted sources. — Fields: script: []const u8 |
scrape |
Scrape the current page HTML. |
ScrollDirection
Section titled “ScrollDirection”Direction for a scroll action.
| Value | Description |
|---|---|
up |
Scroll upward. |
down |
Scroll downward. |
HostMatcher
Section titled “HostMatcher”Hostname/IP allowlist matcher for SSRF policy.
Serializes as an internally-tagged object so each variant is distinguishable on the wire and round-trips losslessly:
{"type": "exact", "value": "api.example.com"}{"type": "suffix", "value": ".example.com"}{"type": "cidr", "value": "10.0.0.0/8"}A bare JSON string is still accepted on deserialization and resolves to Exact,
preserving configs written against the previous untagged representation.
Exact: HostMatcher.Exact
| Value | Description |
|---|---|
exact |
Exact hostname match (case-insensitive). — Fields: value: []const u8 |
suffix |
Suffix match: “.xberg.io” matches “api.xberg.io” and “xberg.io”. — Fields: value: []const u8 |
cidr |
CIDR match: “10.0.0.0/8” matches IP addresses in that range. — Fields: value: []const u8 |
Errors
Section titled “Errors”CrawlError
Section titled “CrawlError”Errors that can occur during crawling, scraping, or mapping operations.
| Variant | Description |
|---|---|
not_found |
The requested page was not found (HTTP 404). |
unauthorized |
The request was unauthorized (HTTP 401). |
forbidden |
The request was forbidden (HTTP 403). |
waf_blocked |
The request was blocked by a WAF or bot protection (HTTP 403 with WAF indicators). vendor is the lowercase identifier of the detected WAF (e.g. “cloudflare”, “datadome”). When the engine cannot identify the vendor, it uses “unknown”. message is the freeform description for logs and human readers. The stable error tag remains forbidden: waf/blocked: MESSAGE so existing log-grep patterns and cross-language bindings continue to work; vendor is surfaced separately for structured consumers. |
timeout |
The request timed out. |
rate_limited |
The request was rate-limited (HTTP 429). |
server_error |
A server error occurred (HTTP 5xx). |
bad_gateway |
A bad gateway error occurred (HTTP 502). |
gone |
The resource is permanently gone (HTTP 410). |
connection |
A connection error occurred. |
dns |
A DNS resolution error occurred. |
ssl |
An SSL/TLS error occurred. |
data_loss |
Data was lost or truncated during transfer. |
browser_error |
The browser failed to launch, connect, or navigate. |
browser_timeout |
The browser page load or rendering timed out. |
invalid_config |
The provided configuration is invalid. |
unsupported |
The requested capability is not supported by the active backend or build. |
ssrf_policy_violation |
A URL was rejected by SSRF policy (private IP, metadata, disallowed scheme, etc). |
other |
An unclassified error occurred. |
SsrfError
Section titled “SsrfError”SSRF validation error.
| Variant | Description |
|---|---|
denied_by_policy |
URL denied by SSRF policy: private IP, metadata IP, etc. |
not_on_allowlist |
Host not on allowlist when an allowlist is configured. |
invalid_cidr |
Allowlist entry is not a parseable CIDR block. |
dns_resolution_failed |
DNS resolution failed for hostname. |
invalid_url |
Invalid URL format. |
disallowed_scheme |
URL scheme not in allowlist (e.g., ftp:// when only http/https allowed). |
too_many_redirects |
Too many HTTP redirects encountered during validation. |