API リファレンス
画像変換
画像を SVG にベクター化、または PNG、PDF、TIFF、PPTX に書き出します。フローチャートにも対応します。
JSON 本文#
POST /images/conversions。必要なスコープ:figures:generate。
| フィールド | 型 | 必須 | 既定値 | 規則 |
|---|---|---|---|---|
| image | string | はい | — | 最大 20 MB の PNG または JPEG の file_id、またはフローチャートの SVG 出力。svg は WebP も対応 |
| format | string | はい | — | svg、png、pdf、tiff、pptx のいずれか |
| vector_mode | string | いいえ | editable_text | svg のみ:editable_text または full_vector |
| dpi | integer | いいえ | 300 | svg 以外:300、600、1000 |
| width | integer | いいえ | 2048 | フローチャート SVG のみ:長辺のピクセル数 256~4096、総ピクセル数は最大 8,388,608 |
SVG ベクター化#
- 150 クレジットで、有料プランが必要です。ウェブサイトのキャンバス編集と同じベクター化処理を使用します。入力は PNG、JPEG、WebP 画像です。
editable_textは文字を編集可能な SVG テキストとして保持し、full_vectorは文字を含むすべての要素をパスに変換します。- ジョブとして実行されます。ベクター化タスクが受け付けられた後にのみクレジットを確保し、ジョブの
creditsは台帳から読み取ります。ベクター化が失敗すると返金され、そのキーに対してTASK_FAILEDを返します。 - すでにベクター化された画像を変換すると、以前の SVG を返し、このジョブには課金しません。
- タスク開始前にベクター化サービスが一時的に利用できない場合は、
Retry-After付きの503 SERVICE_UNAVAILABLEを返します。同じキーで再試行してください。
PNG、PDF、TIFF、PPTX#
- 無料で、アカウントごとに 1 日最大 200 回変換できます。即時に完了し、レスポンスは
succeededのジョブです。 - 変換は、入力がすべての検証を通過してから、Idempotency-Key ごとに一度だけ日次枠に数えます。同じキーでの再試行は重複して数えません。枠を超えると、
details.reason = DAILY_CONVERSION_LIMITと日次枠がリセットされるまでのRetry-Afterを伴う429 RATE_LIMITEDを返します。 - 入力は PNG、JPEG 画像、またはフローチャートの SVG 出力です。WebP は使用できません(
UNSUPPORTED_SOURCE_FORMAT)。 - エンコード後の出力が 24 MiB を超えるファイルは
400 INVALID_REQUEST(OUTPUT_TOO_LARGE)で拒否されます。より小さい画像を変換してください。 dpiはファイルに書き込まれ、PDF と PPTX の実寸ページサイズを決めます。ピクセルの再サンプリングは行いません。ピクセル数を増やすには、先に高解像度化してください。- PNG と TIFF の入力には PNG が必要です。PDF と PPTX は JPEG も使用できます。TIFF は可逆の Deflate 圧縮を使用します。
- PPTX は画像を配置した 1 枚のスライドで、編集可能な図形ではありません。
フローチャートの書き出し#
フローチャートの SVG 出力は PNG、PDF、TIFF、PPTX に変換できます。サーバーは Arial と Noto フォントを使用し、長辺を width ピクセルで描画します(既定値 2048、最大 4096、総ピクセル数は最大 8,388,608。正方形では最大 2896 px)。上限を超える指定は 400 INVALID_REQUEST(RENDER_TOO_LARGE)を返します。フォントで表示できない文字は空の四角にせず、400 INVALID_REQUEST(SVG_NOT_RENDERABLE)で拒否します。描画サービス自体の障害は Retry-After 付きの 503 SERVICE_UNAVAILABLE(SVG_RENDERER_UNAVAILABLE)を返すため、同じキーで再試行してください。その他の SVG ファイルは入力に使用できません。
cURL#
curl -X POST https://scifig.ai/api/v1/images/conversions \
-H "Authorization: Bearer $SCIFIG_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Prefer: wait=25" \
-H "Content-Type: application/json" \
-d '{
"image": "<file_id>",
"format": "pdf",
"dpi": 600
}'JavaScript#
const response = await fetch('https://scifig.ai/api/v1/images/conversions', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.SCIFIG_API_KEY}`,
'Idempotency-Key': crypto.randomUUID(),
Prefer: 'wait=25',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"image": "<file_id>",
"format": "pdf",
"dpi": 600
}),
});
const result = await response.json();
console.log(response.status, result);Python#
import os
import uuid
import requests
headers = {
"Authorization": f"Bearer {os.environ['SCIFIG_API_KEY']}",
"Idempotency-Key": str(uuid.uuid4()),
"Prefer": "wait=25",
}
response = requests.post(
"https://scifig.ai/api/v1/images/conversions",
headers=headers,
json={
"image": "<file_id>",
"format": "pdf",
"dpi": 600
},
timeout=60,
)
print(response.status_code, response.json())