DocumentationAPI Reference
Sign in

Convert

Convert a web page to Markdown

Sign in to call the API here free (20 conversions a day), or enter an API key below.

POST
/convert/url

Accepted inputs: url/urls. Options: formats, render, frontmatter, store, metadata.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Query Parameters

wait?integer

Header Parameters

Idempotency-Key?string
Prefer?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Send exactly one input kind.

formats?array<>

Output formats; Markdown when omitted.

frontmatter?boolean

Prepend YAML front matter with the page title, author, publish date, and other page metadata.

metadata?

Your own data, returned unchanged.

render?string

JavaScript rendering. auto renders the page in a browser only when the fetched HTML has no readable content; force always renders; skip never renders.

Default"auto"

Value in

  • "auto"
  • "force"
  • "skip"
store?boolean

Keep the result in the account library.

url?string

A public web page.

Formaturi
urls?array<string>

Several public web pages.

Response Body

application/json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/convert/url" \  -H "Content-Type: application/json" \  -d '{    "url": "https://markitdown.ai/"  }'
{  "async_reason": "respond_async",  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "files": [    {      "bytes": 0,      "content": "string",      "credits": 0,      "error": {        "detail": "string",        "error": "string",        "hint": "string",        "instance": "string",        "message": "string",        "request_id": "string",        "retryable": true,        "status": 0,        "title": "string",        "type": "string"      },      "format": "markdown",      "id": "string",      "links": {},      "mime": "string",      "name": "string",      "object": "file",      "outputs": [        {}      ],      "pages": 0,      "role": "source",      "status": "queued",      "variant": "standard"    }  ],  "files_next_cursor": "string",  "id": "string",  "links": {},  "metadata": null,  "name": "string",  "object": "conversion",  "operation": "parse",  "status": "queued",  "summary": {    "completed": 0,    "failed": 0,    "queued": 0,    "running": 0,    "sources": 0  },  "usage": {    "credits_charged": 0,    "credits_remaining": 0,    "credits_reserved": 0  }}

Errors

Sources and specs: RFC 9110: HTTP Semantics · RFC 7763: The text/markdown Media Type