本文へスキップ
open-toolsopen-tools

API

open-tools API

すべてのツールをプログラムから利用できます。大量のPDFや画像処理を、あなたのパイプラインに組み込めます。

クイックスタート

  1. アカウントを作成 まだお持ちでない場合。
  2. APIキーは アカウント → APIキーから発行します。完全なトークンが表示されるのは 一度だけです。今すぐコピーしてください。
  3. すべてのリクエストでトークンを Authorization: Bearer otk_… として渡します。

リファレンス

完全なOpenAPI仕様 — すべてのエンドポイント、パラメータ、レスポンス形式 — はFastAPIアプリから自動生成され、JSONとして配信されます。Swagger UIとReDocの両方で表示できます。

インタラクティブなAPIリファレンスを開く →

生のスペックやライブコンソールがお好みですか?機械可読なOpenAPI JSONと、Swagger UI / ReDocのエクスプローラーは、ログイン済みアカウントでご利用いただけます:

例 — PDFを分割

ファイルをアップロードし、結果をポーリングします:

# 1. Upload and create the job
curl -X POST 'https://api.open-tools.app/api/upload' \
  -H 'Authorization: Bearer otk_YOUR_KEY' \
  -F 'file=@input.pdf' \
  -F 'job_type=pdf-split' \
  -F 'parameters={"pages": "1-3"}'
# → {"job_id": "abc123", "status": "queued", "ws_token": "..."}

# 2. Poll job status (or subscribe via WebSocket /ws/<job_id>?token=<ws_token>)
curl 'https://api.open-tools.app/api/jobs/abc123' \
  -H 'Authorization: Bearer otk_YOUR_KEY'
# → {"status": "completed", "output_file_url": "https://api.open-tools.app/api/download/users/42/..."}

# 3. Download the result
curl -o output.pdf 'https://api.open-tools.app/api/download/users/42/<uuid>.pdf' \
  -H 'Authorization: Bearer otk_YOUR_KEY'

エラーコード

すべてのエラーは同じエンベロープ形式です:

{
  "detail": {
    "error": {
      "code": "INVALID_FILE_TYPE",
      "message": "image-resize requires PNG, JPG, or WEBP.",
      "details": { "expected_extensions": [".png", ".jpg", ".webp"] }
    }
  }
}
HTTPコード意味
400INVALID_FILE_TYPEファイル拡張子がこのジョブの許可リストにありません。
400INVALID_FILE_SIGNATUREマジックバイトが拡張子と一致しません。
400INVALID_PARAMETERS parameters JSONがスキーマ検証に失敗しました。
401AUTH_REQUIREDリクエストにセッションCookieまたはAPIキーがありません。
403REAUTH_REQUIRED機密操作です。セッションが15分以上前です。
413FILE_TOO_LARGEアップロードが50 MBの上限を超えています。
429RATE_LIMITEDティアの時間枠を超えました。参照: Retry-After.
500INTERNAL_ERRORバグです。 request_id ヘッダーを添えてお知らせください。

レート制限と利用状況

各アカウントには、分・時間・日・月ごとのバケットがあります。現在の利用状況は アカウントダッシュボードで確認できます。429が出た場合は、時間枠が進むまでお待ちください。レスポンスにはRetry-After 秒が含まれます。