开发者 API

通过标准 API 创建文档处理任务、查询进度并下载处理结果。

Add to Agent

在 Claude Code、Codex、Cursor 或任何编码 Agent 里使用 HumanPen。三条路共用同一份积分余额。

零配置。 把这句话粘给你的 Agent,它会自己读安装指引、把技能克隆到它加载技能的目录,并向你要一个密钥。

提示词
Install the HumanPen skill by following the instructions at https://humanpen.net/install/skill-install.md

三条路都需要 API 密钥。

获取 API 密钥

概览

HumanPen API 面向服务端集成,可在一次请求中上传文档并异步创建处理任务,随后查询进度并通过临时链接下载可编辑结果。

API 基础路径
https://api.humanpen.net/v1
响应格式
业务接口返回统一 JSON 结构;文件内容接口返回二进制。OpenAPI Schema 使用标准 JSON。

认证

在“API 密钥”中创建密钥,并在每个受保护请求的 Authorization Header 中以 Bearer Token 发送。完整密钥可随时在密钥列表中复制。

HTTP
Authorization: Bearer hp_xxx

API 密钥只适合后端服务使用。不要放进浏览器、移动端 App、公开仓库或客户端日志。

创建第一个任务

在一次请求中提交文档和处理设置,再使用返回的任务 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."

接口参考

按调用顺序列出核心接口。展开任一接口可查看参数、请求体、字段类型、必填项、成功响应和错误状态码。

正在读取 OpenAPI Schema...

参考资源

OpenAPI 是接口的唯一结构化契约;docs.md 是可完整阅读的接入指南,llms.txt 是供 agent 发现这些资料的精简索引。

响应与排错

成功和失败的业务 JSON 都包含稳定的 code、message 和 data 字段;HTTP 状态码仍表达请求结果。

X-Request-ID

每个响应都会返回请求 ID。反馈问题时附上这个值,可以直接关联 API、队列和 worker 日志。