inktomd API

POST/convert

Convert a file to Markdown.

Request (multipart/form-data):

• file: [binary file data]

Response:

{
  "markdown": "# Document Title\n\nContent here..."
}

Example (curl):

curl -X POST https://www.inktomd.com/api/convert \
  -F "[email protected]"

Example (Python):

import requests

with open("document.pdf", "rb") as f:
    response = requests.post(
        "https://www.inktomd.com/api/convert",
        files={"file": f}
    )
    
markdown = response.json()["markdown"]
print(markdown)

Example (JavaScript):

const formData = new FormData();
formData.append('file', fileInput.files[0]);

const response = await fetch('https://www.inktomd.com/api/convert', {
  method: 'POST',
  body: formData
});

const { markdown } = await response.json();

POST/convert-url

Convert a URL to Markdown.

Request (application/json):

{
  "url": "https://example.com/article"
}

Response:

{
  "markdown": "# Article Title\n\nContent here..."
}

Example (curl):

curl -X POST https://www.inktomd.com/api/convert-url \
  -H "Content-Type: application/json" \
  -d '{"url": "https://en.wikipedia.org/wiki/Markdown"}'

GET/health

Check API status.

Response:

{
  "status": "ok"
}