Web

File to markdown

Upload a document and get it back as markdown: PDF, Word, Excel, CSV, OpenDocument, Apple Numbers, and images (scanned PDFs and images are OCR'd). multipart/form-data with a file field, 10 MB cap; HTML files are rejected — use the URL endpoint for web pages. The upload is validated before any credit is charged.

Credits: 1 (refunded on failure).

post/api/v1/markdown/file

Request

  • Base URL: https://scrapewhale.dev
  • URL: https://scrapewhale.dev/api/v1/markdown/file
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Response

Success.

idstring required
status'completed' required
titlestring nullable
sourceType'url' | 'file' required
sourceUrlstring nullable
providerstring required

Conversion engine: "jina", "cloudflare", or "tools-api".

extractorstring

Present when the URL routed through a structured extractor.

markdownstring required
dataobject

Raw structured payload (present when an extractor claimed the URL).

contentCharsinteger
creditsChargedinteger required
createdAtinteger required

Unix epoch milliseconds.

Changes

No recorded changes to this operation across all 1 revision of this API.