Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json
url
string
required

The URL to read.

formats
string[]

Output formats: markdown (default), html, screenshot.

only_main_content
boolean

Strip nav/ads/footers (default true).

extract
string

Optional question to answer using the page content.

Response

OK

url
string
title
string
markdown
string
metadata
object
html
string

Only when requested via formats.

screenshot_url
string

Only when requested via formats.

extracted
string

AI answer — only when extract is provided.