開発者 API

標準 API を使用してドキュメント処理タスクの作成、進捗確認、処理結果のダウンロードができます。

Add to Agent

Claude Code、Codex、Cursor、またはその他のコーディング Agent で HumanPen を使用できます。3 つの方式はすべて同じクレジット残高を共有します。

設定不要。 この一文をコピーして Agent に貼り付けてください。Agent がインストール手順を読み、スキルを読み込むディレクトリにクローンし、キーの入力を求めてきます。

プロンプト
Install the HumanPen skill by following the instructions at https://humanpen.net/install/skill-install.md

いずれの方式でも API キーが必要です。

API キーを取得

概要

HumanPen API はサーバーサイド統合向けに設計されており、1 回のリクエストでドキュメントをアップロードして非同期処理タスクを作成し、その後進捗を確認して一時リンクから編集可能な結果をダウンロードできます。

API ベースパス
https://api.humanpen.net/v1
レスポンス形式
業務エンドポイントは統一された JSON 構造を返し、ファイル本体のエンドポイントはバイナリを返します。OpenAPI スキーマは標準の JSON です。

認証

「API キー」でキーを作成し、保護された各リクエストの Authorization ヘッダーに Bearer トークンとして送信してください。完全なキーはキー一覧からいつでもコピーできます。

HTTP
Authorization: Bearer hp_xxx

API キーはバックエンドサービス専用です。ブラウザ、モバイルアプリ、公開リポジトリ、クライアント側のログに含めないでください。

最初のタスクを作成

1 回のリクエストでドキュメントと処理設定を送信し、返されたタスク ID で進捗を確認します。

curl -X POST "https://api.humanpen.net/v1/jobs/humanize" \
  -H "Authorization: Bearer $HP_API_KEY" \
  -F "file=@paper.docx" \
  -F "turnitin_file=@turnitin-report.pdf" \
  -F "strategy=balanced" \
  -F "additional_instructions=Keep terminology and citations unchanged."

API リファレンス

呼び出し順にコアエンドポイントを一覧しています。任意のエンドポイントを展開すると、パラメーター、リクエストボディ、フィールドタイプ、必須項目、成功レスポンス、エラーステータスコードを確認できます。

OpenAPI スキーマを読み込み中…

参考資料

OpenAPI が API の唯一の構造化された契約です。docs.md は通読できる完全な統合ガイド、llms.txt は Agent がこれらの資料を見つけるための簡潔なインデックスです。

レスポンスとトラブルシューティング

成功と失敗の業務 JSON はどちらも安定した code、message、data フィールドを含みます。HTTP ステータスコードもリクエスト結果を表します。

X-Request-ID

すべてのレスポンスにはリクエスト ID が含まれます。問題報告時にこの値を添えると、API、キュー、Worker のログと直接紐付けできます。