API ReferenceExtract

Extract a URL

View as Markdown

Authentication

AuthorizationBearer
Your API key, sent as a Bearer token.

Query parameters

urlstringRequired>=1 character
max_charsinteger or nullOptional>=1

Response

Successful Response
extract_idstring
Opaque id for this extract call.
session_idstring

Caller-supplied or generated.

resultslist of objects
One result per successfully extracted URL.
creditsinteger

Cost - 2 credits per URL successfully extracted, +1 per URL that hit the LLM (focused excerpts or summary).

errorslist of objects

Per-URL failures (not present in results).

statuseslist of objects

Per-URL status row (success or error; cached or live).

warningslist of strings or null
Reserved for future use.
subpages_discoveredintegerDefaults to 0

Total subpage candidates surfaced across all parent URLs before objective-aware ranking trimmed the list.

subpages_extractedintegerDefaults to 0
Total subpages actually fetched and returned across all parent URLs.
usagelist of objects or null

Parallel-style usage line items broken down by SKU (currently surfaces sku_subpage_rank when the objective-aware subpage ranker ran).

scratchpadmap from strings to any or null

Per-request scratchpad payload when SCRATCHPAD_FIRST=true and an objective was provided. Carries the single tool-use Claude answer plus retrieval stats.

Errors

422
Unprocessable Entity Error