Skip to main content
POST
URL to Markdown

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string
required

URL

language
enum<string>

Language

Available options:
en,
,
fr,
de,
es,
pt,
it,
ja,
zh,
ru
headingStyle
enum<string>

Heading style

Available options:
atx,
setext
codeBlockStyle
enum<string>

Code block style

Available options:
fenced,
indented
bulletMarker
enum<string>

Bullet list marker

Available options:
-,
*,
+

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.