poai_ サーバー間 APIキー
- 作成したアカウントの権限(管理者:全アカウント)
- ブラウザコードに決して提供しない
- Originヘッダー不要
- MCPでブロック済み
- IPアドレスに制限可能
認証とキー
PaperOffice-APIのすべての製品エンドポイントは、Authorization: Bearer ヘッダーを要求します。OAuthフローやリフレッシュは不要です。
2つのトークンタイプ、明確な権限、文書化されたレート制限。
curl -X POST "https://api.paperoffice.ai/latest/job/add/workflow" \ -H "Authorization: Bearer po_ut_YOUR_API_KEY" \ -F "file_1=@invoice.pdf" \ -F "idp_collection=invoice" \ -F "model=basic-pro-max" import requestsresponse = requests.post( "https://api.paperoffice.ai/latest/job/add/workflow", headers={"Authorization": "Bearer po_ut_YOUR_API_KEY"}, files={"file_1": open("invoice.pdf", "rb")}, data={"idp_collection": "invoice", "model": "basic-pro-max"},)print(response.json()) const form = new FormData();form.append("file_1", new Blob([await readFile("invoice.pdf")]), "invoice.pdf");form.append("idp_collection", "invoice");form.append("model", "basic-pro-max");const response = await fetch("https://api.paperoffice.ai/latest/job/add/workflow", { method: "POST", headers: { Authorization: "Bearer po_ut_YOUR_API_KEY" }, body: form,});console.log(await response.json()); 初回呼び出し
/latest/job/add/ の後のパスは操作名です。通常は handler___command 形式(例:paperoffice_aiocr___generate)であり、構造化された IDP の場合は専用の workflow パイプラインを使用します。
Authorization: Bearer po_ut_… — 製品エンドポイントに必要なものはこれだけです。poai_ と po_ut_ は Origin ヘッダーを送信しません。
handler___command に3つのアンダースコアを使用します。ワークフローは独自のスラグを持つ例外です。ドット表記は API に HTTP 400 JOB_CONFIG_INVALID で応答します。
client_waitはデフォルトでtrueです:APIは接続を保持し、結果をインラインで返します。時間枠が足りない場合、HTTP 202がjob_idおよびpoll_urlと共に返され、GET /latest/job/get/{job_id}によるポーリングが可能になります。
idp_collection=invoiceの場合、推奨モデルはbasic-pro-maxです。実際に使用されるモデルはレスポンスフィールドのmodelで返され、リクエストされたものと異なる場合があります。
トークンタイプ
両方ともサーバーに配置する必要があります。作成、ローテーション、取り消しは、アプリ内のアカウント → APIで行います。
poai_ サーバー間 po_ut_ ユーザー関連 ブラウザからの直接呼び出しは、これらの2つのトークンではなく、Publishable Key po_pk_ を介して実行されます。これは発生源に依存し、予算とレート制限があります。 Publishable Keysを表示
権限
User Token は、指定された領域においてユーザーの権限を正確に反映します。作成時に特定の領域のみを選択して付与することはできません。範囲を制限する場合は、ユーザーグループの権限を持つグループトークン(po_gt_)を使用してください。
documents アップロード、ダウンロード、処理
workspaces フォルダと構造の管理
ai_jobs OCR、IDP、抽出
billing 利用状況と残高の確認
users チームメンバーを管理する
webhooks イベントを受信する
knowledge_base ナレッジベースとFAQ
agents IDPエージェントを設定
workflows 自動化を作成
compliance 監査、GDPR、アーカイブ
レート制限
トークンごとにカウントされます。Bearerなしの場合はIPアドレスごとにカウントされます。以下の値は、すべてのプランで適用される文書化された最小値です。
各レスポンスのRateLimit-*およびX-RateLimit-*ヘッダーには、現在のウィンドウでまだ利用可能な残量が示されます。
APIはRATE_LIMIT_EXCEEDEDを返します。Retry-Afterヘッダーに記載された時間後にリクエストを再試行してください。
有料プランはこれらの最低値を上回ります。どのプランにどの容量が含まれるかは、料金ページをご参照ください。
セキュリティ
運用中に機能する6つのメカニズム — 各々に検証可能なステータスコードまたはアプリ内の場所があります。
キーはアプリ内の「アカウント → API」で作成、一覧表示、ローテーション、取り消しが行われます。取り消されたトークンは HTTP 401 TOKEN_NOT_FOUND を返します。
期限切れのトークンは HTTP 401 および BEARERTOKEN_EXPIRED を返し、不正なトークンは HTTP 401 および INVALID_TOKEN を返します。Publishable Keys は作成日から 180 日間有効です。
Freeプランでは、トークンごとにレート制限が適用されます。有料プランではアカウント単位でカウントされ、Creditsが存在する限り、レート制限は適用されません。
Publishable Keys は各リクエストで Allowlist からの Origin を要求します。それ以外の場合、API は 403 ORIGIN_HEADER_REQUIRED または DOMAIN_NOT_ALLOWED で応答します。
請求対象となる各レスポンスには_billingブロックが含まれます。呼び出しごとの評価にはGET /latest/billing/usage-detailを使用します。
ブラウザキーに対して、アカウントログイン、キー管理、OAuth、パートナー管理者権限、支払い変更およびパスワードクラックはブロックされています。プロダクトAPIs(請求書読み取りおよびWebhooksを含む)は許可されています。Workspaceの削除、ゴミ箱の空欄化、法的管理解除はアプリ内でのみ実行可能です(403 UI_ONLY_ENDPOINT)。
運用と信頼性
契約、セキュリティ、サポート、制限事項など、すべてを一元リンクで提供。
次のステップ
開発者向けファネルにおける推奨される次のステップと、関連する2つの分岐先。
AI-DMS
ドキュメント。インテリジェンス。真の効果。
PaperOffice AIは、AI-DMSです。1つのDMS基盤の上に4つの機能領域を備え、3つのアクセス方法でご利用いただけます。
機能、モジュール、および利点の概要。
文書の取得、整理、検索、共同編集。
あなたのシステムやAIワークフローにシームレスに統合。
インストール不要、数秒で準備完了です。
すべてのツールを検索