あらゆるファイルワークフローに対応する1つの共通API

このエンドポイントは公開されているため、開発者はAPIキーをリクエストまたは設定する前に、汎用変換カタログを確認できます。

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分まで継続します。

フォームフィールド	種類	説明
target_format	文字列	pdf、docx、mp3、jpg などの、指定された出力拡張子。
files	file[]	アップロードされた1つ以上のソースファイルです。API は、アップロードされたファイル名からソース形式を判定します。

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 アーカイブを返します。

大容量ファイル、バッチ処理、長時間実行される音声・動画タスク、または処理中にアップロードリクエストを開いたままにしない本番アプリケーションには、非同期変換を使用してください。

フォームフィールド	種類	説明
target_format	文字列	希望する出力形式です。ソースとターゲットが変換ペアを構成します。たとえば mp42mp3 です。
files	file[]	変換する1つ以上のファイル。

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
}

非同期ジョブを作成した後、このエンドポイントをポーリングしてください。ジョブのステータス、0.0 から 1.0 までの数値による進捗値、および変換に失敗した場合のエラー詳細が返されます。

ヘッダー	説明
X-API-Key	開発者用APIキー。

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キーで変換済みの出力を取得してください。

結果タイプ	動作
出力ファイルは1つだけ	API は変換されたファイルを直接ストリーミングします。
resultfile マニフェスト	ジョブが結果マニフェストを提供する場合、APIはそのマニフェストで指定されたファイルを返します。
複数の出力ファイル	APIは、生成されたファイルをその場で .zip アーカイブにまとめます。

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)