Skip to main content
POST
Extract Markdown

Authorizations

Authorization
string
header
required

Use Authorization: Bearer YOUR_API_KEY

Body

application/json
url
string<uri>
required

Public http or https URL of the page to read. Loopback and private addresses are not accepted.

Maximum string length: 2000
scope
enum<string>
default:main

main keeps the article body and drops navigation and boilerplate; full keeps the whole page.

Available options:
main,
full
effort
enum<string>
default:standard

Effort to spend on the page: min is fastest, standard is the balanced default, max handles pages that render themselves in the browser.

Available options:
min,
standard,
max
country
string
default:""

Optional ISO 3166-1 alpha-2 country code (e.g. CO) for pages that serve different content by country. Omit for the default route.

Pattern: ^([A-Za-z]{2})?$
include_metadata
boolean
default:false

Include the page's title, author, dates and other metadata in the response.

Response

Successful response

data
object
required