锐消 RedactX 接口
- 基础地址
- 版本
- 数据格式
- 请求为 multipart/form-data 或查询参数；响应为 JSON、PDF 或图片
认证
服务端设置了环境变量 REDACTX_API_KEY 时，除 /v1/health 外的所有接口都要带请求头 X-API-Key，否则返回 401。未设置时无需认证。服务默认只绑定本机回环地址。
任务按 Key 隔离：REDACTX_API_KEY 是管理员 Key，可访问全部任务；管理员用后台脚本为每位使用者生成的用户 Key，只能访问自己提交的任务，访问别人的任务返回 404。同一来源 10 分钟内输错 Key 20 次后暂时返回 429。
错误格式
出错时返回对应的 HTTP 状态码，响应体统一为：
{"error": {"code": "NOT_FOUND", "message": "任务不存在或已过期删除"}}| 状态码 | code | 含义 |
|---|---|---|
| 400 | INVALID_FILE INVALID_OPTIONS CONVERT_FAILED 等 | 文件无法识别、选项不合法、文档转换失败、加密 PDF 密码错误 |
| 401 | BAD_API_KEY | API Key 缺失、不正确或已吊销 |
| 429 | TOO_MANY_ATTEMPTS | 同一来源 Key 错误次数过多，10 分钟后再试 |
| 404 | NOT_FOUND | 任务、报告或预览不存在（可能已到期删除） |
| 409 | NOT_READY BUSY | 任务尚未完成；或正在处理，暂不能删除 |
| 413 | TOO_LARGE | 超出上传大小（默认单个文件 30 MB）、页数上限，或同步接口的 10 页 / 20 MB 限制 |
options 字段
POST /v1/jobs 与 POST /v1/redact 的 options 表单字段是一个 JSON 字符串，所有字段都可省略。
| 字段 | 类型 | 默认 | 说明 |
|---|---|---|---|
entities | string[] | 病案审核默认勾选 | 要遮盖的实体类型 code，见下方“实体类型” |
default_style | string | label | 默认打码样式 code，见下方“打码样式” |
styles | object | {} | 按实体类型单独指定样式，如 {"SIGNATURE": "hatch"} |
custom_words | string[] | [] | 额外要遮盖的词（每个至少 2 个字），如院区名称 |
mode | string | strict | strict 严格（遮盖框外扩更多）或 balanced 平衡 |
label_text | string | type | 浅色标签上写类型（type）或一致性代号（alias，如“姓名1”） |
dpi | number | 200 | 渲染分辨率：150、200 或 300 |
verify | string | boolean | "auto" | 出厂自检：打码后再识别一遍，补打遗漏。"auto" 只自检扫描页（文字层页自检要多花数倍时间），true 全部页，false 关闭 |
keep_source | boolean | false | 保留打码前的页面，复核时可以删框、改框（PUT /v1/jobs/{job_id}/review）；复核完成或到期时删除。不保留时复核只能加框 |
{"entities": ["PERSON", "STAFF", "ORG", "ID_CARD", "PHONE", "MEDICAL_ID", "SIGNATURE", "SEAL"],
"default_style": "label", "styles": {"SIGNATURE": "hatch"}, "mode": "strict", "dpi": 200}本页由 /openapi.json 生成，不加载任何外部资源。