クイックスタート

このガイドではcURLとPDF-to-Markdownエンドポイントを使用します。同じ送信とポーリングのパターンはEPUB変換にも適用されます。

1. APIキーを作成する

OOMOL ConsoleでAPIキーを作成します。サーバー上またはシークレットマネージャーに保管し、ブラウザバンドルや公開クライアントアプリケーションには絶対に含めないでください。

2. 変換タスクを送信する

サンプルのキーとPDF URLを置き換えて、送信エンドポイントにリクエストを送信します。

curl --request POST "https://fusion-api.oomol.com/v1/pdf-transform-markdown/submit" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "pdfURL": "https://pdfcraft.ai/examples/api-quickstart.pdf",
    "model": "gundam"
  }'

レスポンスにはタスクIDであるsessionIDが含まれます。これを独自のジョブレコードとともに保存し、以下のTASK_IDの代わりに使用することで、リトライとダウンロードの追跡が可能になります。

3. 結果をポーリングする

ステータスがcompletedまたはfailedになるまで、または最大試行回数や期限に達するまで、結果エンドポイントにリクエストを送信します。非2xxレスポンスはエラーとして扱い、stateが不明な場合はポーリングを停止してください。最初は短い遅延で開始し、より長いドキュメントの場合は試行間でバックオフしてください。

curl --request GET "https://fusion-api.oomol.com/v1/pdf-transform-markdown/result/TASK_ID" \
  --header "Authorization: Bearer YOUR_API_KEY"

タスクの状態はstateから読み取ります。completedの場合は、data.downloadURLから生成されたファイルをダウンロードします。failedの場合は、返された失敗理由を記録して処理します。

次のステップ

• 認証、タスクの状態、リトライについては、API overviewを確認してください。
• フィールドレベルのリクエストとレスポンスの詳細が必要な場合は、API Referenceを使用してください。

完全なサンプルを実行する

Python 3 サンプルをダウンロードして内容を確認してください。環境変数 PDF_CRAFT_API_KEY を読み取り、クレジットを消費する可能性がある変換を1回送信し、タスク ID を保存して、期限内に結果を取得・検証します。中断後は再送信せず、同じタスクの取得を再開してください。

python3 api-quickstart.py
python3 api-quickstart.py --resume pdf-craft-task.json