Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Body

application/json
url
string<uri>
required
Required string length: 1 - 2083
fact_check
boolean
default:false
follow_subdomains
boolean
default:false
formats
enum<string>[]
Available options:
markdown,
json,
raw
include_frames
boolean
default:false
json_prompt
string | null
json_schema
Json Schema · object | null
max_age_ms
integer | null
Required range: 0 <= x <= 2592000000
max_depth
integer | null
Required range: x >= 0
max_pages
integer
default:1
Required range: 1 <= x <= 50
only_main_content
boolean
default:false
parse_pdf
boolean
default:true
render_js
boolean
default:false
tags
string[] | null
timeout
integer | null
default:60
Required range: 1 <= x <= 180
wait_for
integer | null
Required range: x >= 0

Response

Scrape concluído

credits_used
integer
required
remaining_credits
integer
required
scrape_status
enum<string>
required
Available options:
success,
blocked_antibot,
timeout,
extraction_failed
success
boolean
required
error
string | null
json
Json · object | null
json_extraction_error_code
string | null

Presente apenas quando formats inclui json e a extração falhou por completo. json permanece com todas as properties do schema em None — o motivo da falha fica fora do namespace do schema.

Allowed value: "extraction_failed"
markdown
string | null
metadata
ScrapeMetadata · object | null
rawHtml
string | null