API สากลหนึ่งเดียวสำหรับทุกเวิร์กโฟลว์ของไฟล์

ปลายทางนี้เปิดให้ใช้งาน เพื่อให้นักพัฒนาสามารถตรวจสอบแคตตาล็อกการแปลงแบบสากลได้ก่อนที่จะร้องขอหรือกำหนดค่า API key

curl "https://api.converter.app/public/pairs"

JavaScript

const response = await fetch('https://api.converter.app/public/pairs');
const pairs = await response.json();
console.log(pairs.supported_pairs);

Python

import requests

response = requests.get('https://api.converter.app/public/pairs')
response.raise_for_status()
pairs = response.json()
print(pairs['supported_pairs'])

คำตอบตัวอย่าง

{
  "supported_pairs": [
    { "from": "mp3", "to": "text" },
    { "from": "mp4", "to": "mp3" },
    { "from": "mov", "to": "mp4" },
    { "from": "wav", "to": "mp3" },
    { "from": "mkv", "to": "mp4" }
  ]
}

ใช้การแปลงแบบซิงโครนัสเมื่อคุณต้องการผลลัพธ์ทันทีในการตอบกลับ HTTP เดียวกัน คำขอจะยังคงเปิดอยู่ในขณะที่ API เริ่มงานแปลงและรอให้เสร็จสมบูรณ์ โดยรอได้นานสูงสุด 30 นาที

curl -X POST "https://api.converter.app/convert/sync" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "target_format=pdf" \
  -F "files=@/path/to/document.docx" \
  -o converted.pdf

JavaScript

const form = new FormData();
form.append('target_format', 'pdf');
form.append('files', fileInput.files[0]);

const response = await fetch('https://api.converter.app/convert/sync', {
  method: 'POST',
  headers: {
    'X-API-Key': apiKey
  },
  body: form
});

const convertedFile = await response.blob();

Python

import requests

headers = {'X-API-Key': 'YOUR_API_KEY'}
data = {'target_format': 'pdf'}

with open('/path/to/document.docx', 'rb') as document:
    files = {'files': document}
    response = requests.post(
        'https://api.converter.app/convert/sync',
        headers=headers,
        data=data,
        files=files
    )

response.raise_for_status()
with open('converted.pdf', 'wb') as output:
    output.write(response.content)

ระบบจะสตรีมไฟล์ที่แปลงแล้วโดยตรง หากการแปลงสร้างหลายไฟล์ API จะส่งกลับเป็นไฟล์เก็บถาวร .zip

ใช้การแปลงแบบอะซิงโครนัสสำหรับไฟล์ขนาดใหญ่ การประมวลผลแบบเป็นชุด งานเสียงหรือวิดีโอที่ใช้เวลานาน หรือแอปพลิเคชันระดับการผลิตที่ไม่ควรเปิดคำขออัปโหลดค้างไว้ระหว่างที่งานกำลังทำงาน

cURL

curl -X POST "https://api.converter.app/convert" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "target_format=mp3" \
  -F "files=@/path/to/video.mp4"

JavaScript

const form = new FormData();
form.append('target_format', 'mp3');
form.append('files', fileInput.files[0]);

const response = await fetch('https://api.converter.app/convert', {
  method: 'POST',
  headers: {
    'X-API-Key': apiKey
  },
  body: form
});

const job = await response.json();
console.log(job.jobid, job.remaining_quota);

Python

import requests

headers = {'X-API-Key': 'YOUR_API_KEY'}
data = {'target_format': 'mp3'}

with open('/path/to/video.mp4', 'rb') as video:
    files = {'files': video}
    response = requests.post(
        'https://api.converter.app/convert',
        headers=headers,
        data=data,
        files=files
    )

response.raise_for_status()
job = response.json()
print(job['jobid'], job['remaining_quota'])

การตอบกลับสำเร็จ

{
  "status": "success",
  "jobid": "b3f6b2e8f5c34c4ab01c93c4d1b2f9e8",
  "pair": "mp42mp3",
  "remaining_quota": 42
}

เรียกใช้ endpoint นี้หลังจากสร้างงานแบบอะซิงโครนัสแล้ว โดยจะส่งคืนสถานะของงาน ค่าความคืบหน้าเป็นตัวเลขตั้งแต่ 0.0 ถึง 1.0 และรายละเอียดข้อผิดพลาดหากการแปลงล้มเหลว

curl "https://api.converter.app/progress/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch('https://api.converter.app/progress/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8', {
  headers: {
    'X-API-Key': apiKey
  }
});

const progress = await response.json();
console.log(progress.status, progress.progress);

Python

import requests

headers = {'X-API-Key': 'YOUR_API_KEY'}
response = requests.get(
    'https://api.converter.app/progress/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8',
    headers=headers
)
response.raise_for_status()
progress = response.json()
print(progress['status'], progress['progress'])

{
  "jobid": "b3f6b2e8f5c34c4ab01c93c4d1b2f9e8",
  "progress": 1.0,
  "status": "completed",
  "error": null
}

สถานะที่เป็นไปได้คือ processing, completed และ failed ความคืบหน้าเป็นตัวเลขระหว่าง 0.0 และ 1.0.

เมื่องานแบบไม่พร้อมกันถึงสถานะ completed ให้ดึงไฟล์ที่แปลงแล้วด้วย API key เดียวกับที่ใช้สร้างงานนั้น

curl -L "https://api.converter.app/download/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8" \
  -H "X-API-Key: YOUR_API_KEY" \
  -o converted-output.zip

JavaScript

const response = await fetch('https://api.converter.app/download/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8', {
  headers: {
    'X-API-Key': apiKey
  }
});

const file = await response.blob();

Python

import requests

headers = {'X-API-Key': 'YOUR_API_KEY'}
response = requests.get(
    'https://api.converter.app/download/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8',
    headers=headers
)
response.raise_for_status()

with open('converted-output.zip', 'wb') as output:
    output.write(response.content)