API
API แปลงเอกสาร
API แปลงเอกสารคือ API แบบ HTTPS ที่รับไฟล์ URL หรือ HTML ในการเรียก POST /v1/convert/{name} ครั้งเดียว และคืนค่า Markdown
การทดลองใช้แบบไม่ต้องสมัครรับไฟล์สูงสุด 10 MB และสูงสุด 25 หน้า โดยแปลง 3 ครั้งต่อ IP ต่อชั่วโมง และ 10 ครั้งต่อวัน Lite เริ่มที่ $20 ต่อเดือน ไฟล์สูงสุด 100 MB; Pro อยู่ที่ $50 ต่อเดือน; Max อยู่ที่ $100 ต่อเดือน
- หนึ่งการเรียก POST /v1/convert/{name} ต่อไฟล์ URL หรือข้อความในบรรทัด
- Markdown ในคำตอบภายใน 60 วินาที หรือคืนค่าการแปลงให้โพล
- ใช้เอนจินแปลงเดียวกับเว็บแอป
# Upload a local file; Markdown comes back in the same response
curl -X POST https://api.markitdown.ai/v1/convert/pdf \
-H "x-api-key: mdai_…" \
-F file=@nist-cswp-29-csf-2.0.pdf
# Or convert a public web page
curl -X POST https://api.markitdown.ai/v1/convert/url \
-H "x-api-key: mdai_…" \
-H "content-type: application/json" \
-d '{"url":"https://markitdown.ai/blog/why-pdfs-break-llms"}'
# Took longer than the wait window? Long-poll the conversion
curl "https://api.markitdown.ai/v1/conversions/<id>?wait=100" \
-H "x-api-key: mdai_…"API แปลงเอกสารทำงานอย่างไร
สามขั้นตอนจาก API key สู่ Markdown แต่ละการเรียกรอสูงสุด 60 วินาทีและตอบด้วยผลลัพธ์; คำขอที่ยาวกว่าหรือหลายไฟล์จะคืน 202 พร้อมการแปลงให้โพล แทนที่จะยึดการเชื่อมต่อไว้
สร้าง API key
สร้าง key ใน ตั้งค่า → นักพัฒนา (ต้องมีสมาชิกที่ใช้งานอยู่) แล้วส่งในส่วนหัว x-api-key
POST /v1/convert/{name}
ส่งไฟล์ URL สาธารณะ หรือข้อความในบรรทัดไปยังปลายทางของรูปแบบนั้น หนึ่งการเรียกใช้ข้อมูลเข้าได้หนึ่งชนิด
ใช้ Markdown ที่ได้
อ่านผลลัพธ์จากคำตอบ หรือรอที่ /v1/conversions/{id} หลังได้รับ 202
คำตอบและ webhook
คำตอบด้านล่างแสดงสัญญาของ API ด้วยผลลัพธ์ตัวแยกวิเคราะห์ DOCX ที่ผ่านการตรวจสอบ; ตัวระบุการแปลงเป็นตัวยึดตำแหน่ง การแปลงที่เสร็จจะคืนค่า Markdown พร้อมเครดิตที่ใช้ไป ส่วน 202 มีส่วนหัว Location ไปยังการแปลง; โพลด้วย ?wait= สตรีมเหตุการณ์ของมัน หรือให้ webhook บอกคุณเมื่อมันเสร็จ
{
"id": "cnv_3f7c…",
"object": "conversion",
"name": "word",
"status": "completed",
"files": [ { "outputs": [ { "format": "markdown", "content": "## Review Findings\n\nRisk ratings follow the standard High / Medium / Low scale defined in the vendor risk management policy.\n\n| Vendor | Risk Rating | Finding | Owner |\n| --- | --- | --- | --- |\n| CloudScan OCR | Medium | No documented data retention limit on uploaded scans | Security |\n| PayBridge | Low | SOC 2 Type II renewed; no open items | Finance |\n| LingoTrans API | High | Sub-processor list not disclosed on request | Legal |\n| ArchiveNow Storage | Medium | Encryption at rest confirmed; key rotation overdue | Security |\n" } ] } ],
"usage": { "credits_charged": 1 }
}POST https://your-app.example.com/webhooks
{
"type": "conversion.completed",
"data": { "id": "cnv_3f7c…", "object": "conversion", "status": "completed" }
}สมัครรับ conversion.completed และ conversion.failed เพื่อตอบสนองทันทีที่การแปลงแบบยาวหรือหลายไฟล์เสร็จ แทนที่จะโพล การส่งจะลงนามด้วยส่วนหัว Standard Webhooks
API แยกวิเคราะห์เอกสาร และ Markdown API
ทีมค้นหา API แยกวิเคราะห์เอกสารเมื่อต้องการโครงสร้างจากไฟล์ และค้นหา Markdown API เมื่อผลลัพธ์ต้องไปอยู่ในพรอมป์หรือคลัง ทั้งสองคำอธิบายบริการนี้ หน้าเฉพาะรูปแบบอย่าง pdf to markdown api และ url to markdown api เป็นจุดเชื่อมไปยังตัวแปลงเหล่านั้น — พวกมันใช้ปลายทาง /v1/convert/{name} ชุดเดียวกัน
ปลายทางแปลง
POST /v1/convert/{name} — หนึ่งปลายทางต่อรูปแบบ — รับไฟล์ URL หรือข้อความ และคืน Markdown ข้อความ HTML หรือผลลัพธ์รายหน้า
API key
key ประจำบัญชีที่ส่งผ่านส่วนหัว x-api-key ทำให้การแปลงเข้ากับเซิร์ฟเวอร์หรือสคริปต์ใดก็ได้
หลายไฟล์และ webhook
ส่งหลายไฟล์ไปยังการเรียกแปลงครั้งเดียวและรับการแปลงกลับมาหนึ่งรายการ; webhook รายงานทุก conversion.completed หรือ conversion.failed
เรนเดอร์ Markdown
POST /v1/convert/markdown/html หรือ /markdown/text เปลี่ยน Markdown กลับเป็น HTML หรือข้อความล้วนโดยไม่ใช้เครดิต
กรณีใช้งาน
ทีมต่อมันไว้ตรงไหน
การนำข้อมูลเข้า RAG
แปลงเอกสารภายในงานนำข้อมูลเข้าก่อนการแบ่งชิ้นและฝัง
เอเจนต์ AI
ให้เอเจนต์เปลี่ยนไฟล์ใด ๆ เป็นข้อความสะอาดระหว่างทางในไปป์ไลน์
ไปป์ไลน์เนื้อหา
ป้อน Markdown เข้าสู่ CMS ไซต์เอกสาร หรือฐานความรู้โดยอัตโนมัติ
เครื่องมือภายใน
เพิ่มการแปลงเอกสารให้ผลิตภัณฑ์และเครื่องมือหลังบ้านที่คุณใช้อยู่
การยืนยันตัวตน การใช้งาน และขีดจำกัด
- API key เป็นของบัญชีคุณ ใช้ได้เฉพาะบน /v1 และส่งในส่วนหัว x-api-key — บัญชีต้องมีสมาชิก Lite, Pro หรือ Max ที่ใช้งานอยู่
- การใช้งานใช้เครดิตเดียวกับเว็บแอป — หน้าเอกสารทั่วไปและหน้า OCR ราคา 1 เครดิตต่อหน้า
- ขีดจำกัดอัตราตามแพ็กเกจคือ Lite 20, Pro 40 และ Max 60 คำขอต่อนาที
- มี Idempotency-Key ทุกการเรียก POST /v1/convert/{name} การลองใหม่จึงไม่คิดเงินซ้ำ
- ทุกปลายทาง v1 ฟิลด์คำขอ และคำตอบมีบันทึกในเอกสารอ้างอิง API ที่สร้างขึ้น; ความล้มเหลวใช้ problem+json โดยมี URI type ที่ชี้ไปยังหน้ารหัสข้อผิดพลาด ที่ตรงกัน
คู่มือ
จัดการสถานะเสร็จ
จัดการทั้งการเสร็จทันทีและแบบอะซิงโครนัสในไคลเอนต์ API แปลงเอกสาร การส่งที่สำเร็จอาจคืนผลลัพธ์ที่เสร็จแล้ว ขณะที่ HTTP 202 บอกว่างานยังดำเนินต่อหลังการตอบกลับ เก็บตัวระบุการแปลงและใช้ปลายทาง Location หรือสถานะการแปลงตามเอกสารก่อนอ่านผลลัพธ์ อย่าทำดัชนีตรงเข้าผลลัพธ์แรกที่สันนิษฐานไว้เพียงเพราะคำขอ HTTP สำเร็จ การแปลงที่เสร็จแล้วอาจมีการล้มเหลวระดับไฟล์ ให้ตรวจทุกไฟล์ในคำขอหลายต้นทาง เก็บบริบทให้พอที่จะเชื่อมผลลัพธ์ที่คืนมาแต่ละรายการกับต้นทางที่แอปของคุณส่งไป วิธีนี้ทำให้การแปลงที่ช้าหรือล้มเหลวบางส่วนไม่กลายเป็นเอกสารว่างเปล่าในระบบปลายทางอย่างเงียบ ๆ
ขีดจำกัดคำขอเทียบกับขีดจำกัดแพ็กเกจ
API แปลงเอกสารใช้ขีดจำกัดทั้งกับคำขอและบัญชี คำขอ multipart หนึ่งครั้งใส่ไฟล์ได้สูงสุด 100 ไฟล์ รวมกันไม่เกิน 100 MB คำขอผ่าน URL รับได้สูงสุด 20 ต้นทาง สมาชิกของคุณควบคุมเครดิต พื้นที่จัดเก็บ ขีดจำกัดต่อไฟล์ และจำนวนงานพร้อมกันแยกต่างหาก ไฟล์ของ Pro อาจได้รับอนุญาตตามสมาชิกแต่ใหญ่เกินหนึ่งคำขอ multipart; กรณีนั้นให้ใช้ขั้นตอนอัปโหลดแบบแบ่งส่วนตามเอกสาร อย่าเลี่ยงคำขอที่ถูกปฏิเสธโดยคิดว่าแพ็กเกจสูงสุดจะลบขีดจำกัดการรับส่ง อ่านข้อผิดพลาดและใช้วิธีป้อนข้อมูลที่ออกแบบมาสำหรับขนาดต้นทางนั้น
เก็บบริบทของต้นทาง
เก็บตัวระบุต้นทางของคุณไว้ข้างตัวระบุการแปลง ผลลัพธ์จะได้ตรวจสอบย้อนกลับไปยังงานที่ส่งมันได้ ฟิลด์ metadata ของ API บรรจุข้อมูลที่ผู้เรียกใส่เอง; ไม่ได้รับประกันว่าจะสกัดชื่อหน้าเว็บ ผู้เขียน หรือวันที่เผยแพร่ ถ้าแอปของคุณต้องการข้อเท็จจริงเหล่านั้น ให้เก็บและตรวจสอบในขั้นตอนแยกที่เหมาะสม ตรวจว่าผลลัพธ์คืนมาในคำตอบหรือผ่านชิ้นงานที่อ้างอิง ก่อนอ่านข้อความของมัน และเก็บเอกสารต้นฉบับไว้เมื่อเวิร์กโฟลว์ของคุณต้องมีร่องรอยการตรวจสอบ API แปลงเอกสารเตรียมเนื้อหาสำหรับขั้นถัดไป ส่วนแอปของคุณยังคงรับผิดชอบในการเชื่อมเนื้อหานั้นกับต้นทางและตัดสินใจว่าจะเก็บไว้นานแค่ไหน
ทดสอบก่อนเปิดใช้
ทดสอบไฟล์เล็กที่สำเร็จมากกว่าหนึ่งไฟล์ก่อนเชื่อม API แปลงเอกสารเข้ากับเวิร์กโฟลว์โปรดักชัน รวมข้อมูลเข้าที่ต้องเสร็จแบบอะซิงโครนัส ไฟล์ที่ไม่รองรับหรือเสียหาย คำขอหลายต้นทางที่ผลลัพธ์ปนกัน และคำตอบที่ไคลเอนต์ของคุณต้องถือว่าเป็นข้อผิดพลาดขีดจำกัด ตรวจว่าตรรกะลองใหม่ของคุณไม่ส่งไฟล์ที่สำเร็จซ้ำหลังล้มเหลวบางส่วน เก็บข้อมูลรับรอง API ไว้บนเซิร์ฟเวอร์ อย่าวางในโค้ดเบราว์เซอร์หรือตัวอย่างสาธารณะ ตรวจ Markdown จริงสำหรับชนิดต้นทางที่เป็นตัวแทนก่อนประเมินการค้นคืนหรือพฤติกรรมโมเดลปลายทาง ไคลเอนต์ที่จัดการข้อผิดพลาดการรับส่งถูกต้องยังต้องมีการตรวจระดับเนื้อหาเพื่อพิสูจน์ว่าเอกสารที่ได้มีประโยชน์
คำถามที่พบบ่อย
คำถามที่พบบ่อยเกี่ยวกับ API แปลงเอกสารเป็น Markdown
ยืนยันตัวตนกับ API แปลงเอกสารอย่างไร?
สร้าง API key ในบัญชีของคุณและส่งในส่วนหัว `x-api-key` key ผูกกับบัญชีของคุณ
ขั้นตอนการแปลงจริงเป็นอย่างไร?
POST /v1/convert/{name} ด้วยไฟล์ URL สาธารณะ หรือข้อความ เมื่อเอกสารเสร็จภายในหน้าต่างรอ Markdown จะกลับมาในคำตอบเดียวกัน; ไม่เช่นนั้นคุณจะได้ 202 พร้อมการแปลงให้รอด้วย GET /v1/conversions/{id}?wait=
การแปลงเป็นแบบซิงโครนัสไหม?
โดยค่าเริ่มต้นจะซิงก์ภายในหน้าต่างรอ: POST /v1/convert/{name} รอผลลัพธ์และคืนในคำตอบ หรือคืน 202 พร้อม Location เมื่อการแปลงเสร็จไม่ทัน ส่ง Prefer: respond-async เพื่อข้ามการรอ
สมัครรับเหตุการณ์ใดได้บ้าง?
webhook ขาออกรองรับ conversion.completed และ conversion.failed คุณจึงตอบสนองได้ทันทีที่การแปลงเสร็จ แทนการโพล
แพ็กเกจใดรวมการเข้าถึง API?
การเข้าถึง API มีในแพ็กเกจแบบชำระเงิน ดูขีดจำกัดแพ็กเกจและเครดิตปัจจุบันได้ที่หน้าราคา
การใช้งาน API คิดเงินอย่างไร?
การแปลงผ่าน API หักจากยอดเครดิตเดียวกับเว็บแอป หน้าเอกสารทั่วไปและหน้า OCR ราคา 1 เครดิตต่อหน้า
หา pdf to markdown api หรือ url to markdown api ได้ที่ไหน?
วลีเหล่านั้นเป็นหน้าเฉพาะรูปแบบ ไม่ใช่โฮสต์เพิ่ม ใช้หมายเหตุ pdf to markdown api บน /pdf-to-markdown และหมายเหตุ url to markdown api บน /url-to-markdown แล้วเรียกปลายทางอัปโหลดและแปลงชุดเดียวกันที่บันทึกไว้ที่นี่
ขีดจำกัดอัตราของ API key คือเท่าไร?
คำขอถูกจำกัดอัตราต่อบัญชี: Lite 20, Pro 40 และ Max 60 คำขอต่อนาที