Social Fetch
Web

Generate web page markdown

Convert a web page into clean markdown.

Operation

GET/v1/web/markdown

Headers

x-api-keystringrequired(header)

API key (`sfk_...`)

Parameters

urlstringrequired(query)

Absolute http or https URL to fetch.

min 1 chars · max 2083 chars

filterstring(query)

Content filter strategy for markdown extraction.

one of: fit, raw, bm25

querystring(query)

Optional query string used by the bm25 filter to rank relevant content.

max 500 chars

cacheModestring(query)

Cache behavior: enabled (read/write cache), bypass (skip cache), or write_only.

one of: enabled, bypass, write_only

Response fields

data
objectrequired

Endpoint-specific response payload.

dataurl
stringrequired

URL that was fetched.

datastatus
integerrequired

HTTP status code reported for the page fetch.

datamarkdown
objectrequired

Markdown content extracted from the page.

datamarkdownraw
stringrequired

Primary markdown text extracted from the page.

datamarkdownfit
string

Filtered markdown optimized for LLM consumption.

datamarkdownwithCitations
string

Markdown with numbered citations for outbound links.

datamarkdownreferences
string

Reference list for cited links in the markdown output.

datametadata
object

Page metadata such as title when available.

meta
objectrequired

Metadata describing the request and billing outcome.

metarequestId
stringrequired

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integerrequired

Credits charged for this request.

≥ 0

metaversion
stringrequired

Public API version that served the response.

one of: v1

Code example

Responses

Markdown extraction result.

Error codes

bad_requestinsufficient_creditsinternal_errorlookup_failedtemporarily_unavailableunauthorized

On this page