API リファレンス
ワークフロー API
特記のない限り、すべてのエンドポイントはサインイン済みセッション（Cookie）を必要とします。レスポンスはJSON：{ ok: true, data } または { ok: false, error }。一般的なエラー：400 バリデーションエラー、401 未認証、403 権限なし、404 未検出、429 レート制限、502/503 上流エラー。パブリックの /api/v1 エンドポイントは Authorization: Bearer pdflean_… で認証し、JSONのContent-Typeを送信する必要があります。
ワークフロー
| メソッド | パス | 説明 |
|---|---|---|
| GET | /api/workflows | ワークフロー一覧を取得 |
| POST | /api/workflows | ワークフローを作成（下書き） |
| GET | /api/workflows/:id | ワークフローを取得 |
| PUT | /api/workflows/:id | ワークフローを更新（下書き、バージョン+1） |
| DELETE | /api/workflows/:id | ワークフローを削除 |
| POST | /api/workflows/:id/publish | バージョンを公開 |
| GET | /api/workflows/:id/versions | バージョン一覧 |
| POST | /api/workflows/:id/versions/:version/restore | バージョンを復元 |
トリガーとフック
| メソッド | パス | 説明 |
|---|---|---|
| GET | /api/workflows/triggers | トリガーのリスト |
| POST | /api/workflows/triggers | トリガーを作成（ウェブフック/スケジュール/メール/ドライブ） |
| POST | /api/workflows/triggers/:id/run | トリガーを今すぐ実行 |
| DELETE | /api/workflows/triggers/:id | トリガーを削除 |
| POST | /api/workflows/hook/:token | 受信ウェブフック（トークン認証・セッション不要・JSONボディ） |
実行とレビュー
| メソッド | パス | 説明 |
|---|---|---|
| POST | /api/workflows/runs | 実行を作成（キューに追加） |
| GET | /api/workflows/runs | 実行一覧 |
| GET | /api/workflows/runs/:id | 実行の詳細とステップ |
| POST | /api/workflows/runs/:id/retry | 失敗またはキューされた実行を再試行 |
| GET | /api/workflows/reviews | 保留中のレビュー（人の確認が必要） |
| POST | /api/workflows/reviews/:id | レビューを承認/拒否 |
クラウドブリッジ
| メソッド | パス | 説明 |
|---|---|---|
| GET | /api/workflows/cloud/status | スタンドアロンVPSブリッジの状態 |
| POST | /api/workflows/cloud/convert | Office → PDF 変換（スタンドアロンVPS経由、LibreOffice） |
| POST | /api/workflows/cloud/ocr | OCR（スタンドアロンVPS経由、Tesseract） |
| POST | /api/workflows/cloud/extract | PDFから請求書/汎用フィールドを抽出（pdfjs + ルール） |
アーカイブと保持
| メソッド | パス | 説明 |
|---|---|---|
| GET | /api/workflows/archive | アーカイブ済みドキュメントの一覧 + チェーン整合性 |
| POST | /api/workflows/archive | ドキュメントをアーカイブ（base64、SHA-256ハッシュチェーン） |
| GET | /api/workflows/archive/:id/verify | アーカイブハッシュチェーンの検証 |
| GET | /api/workflows/archive/export | アーカイブ監査CSVをエクスポート（トゥームストーンを含む） |
| POST | /api/workflows/archive/:id/hold | リーガルホールドの設定/解除 |
| POST | /api/workflows/archive/:id/compliance | 不可逆的な WORM コンプライアンスロックを有効にする |
| DELETE | /api/workflows/archive/:id | アーカイブを削除（リーガルホールド中はブロック） |
公開 API v1
| メソッド | パス | 説明 |
|---|---|---|
| GET | /api/v1/openapi.json | OpenAPI 3.1 仕様 (公開、認証なし) |
| GET | /api/v1/me | 現在の API キー所有者 (Bearer キー) |
| GET | /api/v1/usage | 使用状況ダッシュボード: 残高、30 日間の履歴、最近の呼び出し |
| GET | /api/v1/workflows | ワークフロー一覧 (スコープ workflow.read) |
| GET | /api/v1/workflows/:id | ワークフローの取得 (スコープ workflow.read) |
| POST | /api/v1/workflows/:id/run | 実行をキューに追加 (スコープ workflow.run) |
| GET | /api/v1/runs | 実行一覧 (スコープ workflow.read) |
| POST | /api/v1/pdf/merge | PDF を結合 (scope pdf.merge; 2〜10 個の base64 ファイル) |
| POST | /api/v1/pdf/split | 選択したページを保持 (scope pdf.split; "1-3,5" のような範囲指定) |
| POST | /api/v1/pdf/compress | PDF を構造的に圧縮 (scope pdf.compress) |
| GET | /api/v1/jobs/:id | ジョブのステータス (無料) |
| GET | /api/v1/jobs/:id/download | ジョブ結果をダウンロード (無料) |
| POST | /api/v1/convert/office | Office/ODF ドキュメントを変換 (scope pdf.convert) |
| POST | /api/v1/convert/linearize | PDF を高速 Web 表示用にリニア化 (scope pdf.convert) |
| POST | /api/v1/convert/typst | Typst/Markdown ソースを PDF にコンパイル (scope pdf.convert) |
| POST | /api/v1/ocr | スキャンした PDF を検索可能な PDF に OCR (scope pdf.ocr) |
| POST | /api/v1/ocr/text | 単一画像をテキストに OCR (scope pdf.ocr) |
| POST | /api/v1/validate/pdfa | PDF/A 準拠チェック (scope pdf.validate) |
| POST | /api/v1/validate/pdfua | PDF/UA アクセシビリティチェック (scope pdf.validate) |
| POST | /api/v1/validate/signature | 電子署名の検証レポート (scope pdf.validate) |
| POST | /api/v1/sign | PAdES 電子署名 (scope pdf.sign; 任意の PEM キーペア) |
| POST | /api/v1/redact | テキスト一致または領域の完全な墨消し (scope pdf.redact) |
| POST | /api/v1/extract | テキストとルールベースのフィールド抽出 (scope pdf.extract) |
| POST | /api/v1/docling | Docling による構造化レイアウト解析 (scope pdf.extract) |
| POST | /api/v1/scan/pii | 個人情報のテキストスキャン (scope pii.detect) |
Credit consumption
Member credits refresh each billing cycle (no rollover) and are spent before purchased credits. Credits are $0.001 each.
Top up API credits in your account (from $5, never expires)
| Method | Endpoint | Credits |
|---|---|---|
| GET | /jobs/:id | 0 per call |
| GET | /jobs/:id/download | 0 per call |
| GET | /me | 0 per call |
| GET | /runs | 0 per call |
| GET | /usage | 0 per call |
| GET | /workflows | 0 per call |
| GET | /workflows/:id | 0 per call |
| POST | /ai/chat | 3 per call |
| POST | /ai/extract | 5 per call |
| POST | /ai/pii-detect | 4 per call |
| POST | /ai/summarize | 3 per call |
| POST | /ai/translate | 3 per call |
| POST | /convert/linearize | 1 per call |
| POST | /convert/office | 2 per call |
| POST | /convert/typst | 1 per call |
| POST | /docling | 3 per call |
| POST | /extract | 2 per call |
| POST | /ocr | 3 per page |
| POST | /ocr/text | 1 per call |
| POST | /pdf/compress | 1 per call |
| POST | /pdf/merge | 1 per call |
| POST | /pdf/split | 1 per call |
| POST | /redact | 3 per call |
| POST | /scan/pii | 2 per call |
| POST | /sign | 5 per envelope |
| POST | /validate/pdfa | 2 per call |
| POST | /validate/pdfua | 2 per call |
| POST | /validate/signature | 2 per call |
| POST | /workflows/:id/run | 1 per call |
| ai.chat | 2 per call | |
| convert.html_to_pdf | 4 per page | |
| convert.office_to_pdf | 10 per page | |
| convert.pdf_to_office | 12 per page | |
| convert.pdfa | 8 per page | |
| esign.envelope | 750 per envelope | |
| pdf.ocr | 3 per page | |
| pdf.ocr.high | 8 per page |