API reference

Base URL https://api.markitdown.ai/v1. Each page below is generated from https://api.markitdown.ai/openapi.json (version 2.0.0) and lists the parameters, request body and responses of one operation. The per-format estimate endpoints share one page, and every error code is in one table at /docs/errors. Hand-written guides live under Documentation.

• Error codesproblem+json catalog
• Guidesauthentication, quickstart, webhooks

• POST/v1/convert/excelConvert Excel to Markdown
• POST/v1/convert/htmlConvert HTML to Markdown
• POST/v1/convert/imageConvert an image to Markdown
• POST/v1/convert/markdown/htmlConvert Markdown to HTML
• POST/v1/convert/markdown/textConvert Markdown to plain text
• POST/v1/convert/pdfConvert PDF to Markdown
• POST/v1/convert/powerpointConvert PowerPoint to Markdown
• POST/v1/convert/textConvert text to Markdown
• POST/v1/convert/urlConvert a web page to Markdown
• POST/v1/convert/wordConvert Word to Markdown
• POST/v1/convert/{name}/estimateEstimate credits for any conversion

• GET/v1/conversionsList conversions
• GET/v1/conversions/{id}Get a conversion
• DELETE/v1/conversions/{id}Delete a conversion and its files
• GET/v1/conversions/{id}/eventsServer-Sent Events progress stream
• GET/v1/conversions/{id}/filesList a conversion's source files (with their outputs)
• GET/v1/conversions/{id}/files/{file_id}Get one file
• GET/v1/conversions/{id}/files/{file_id}/contentDownload a file's content (source preview or output body)
• POST/v1/conversions/{id}/files/{file_id}/retryRetry a failed source file

• POST/v1/uploadsStart a chunked upload
• GET/v1/uploads/{id}Upload status, for resuming
• DELETE/v1/uploads/{id}Abort an upload
• POST/v1/uploads/{id}/completeComplete a chunked upload

• POST/v1/webhooksCreate a webhook endpoint
• GET/v1/webhooksList outbound webhook endpoints
• DELETE/v1/webhooks/{id}Delete a webhook endpoint

• GET/v1/formatsThe accepted input/option matrix per convert name

• GET/v1/usageCredit balance, plan and recent conversions