# Fileverity API 文档

> Fileverity API 开发者文档：检测图像、文档和纯文本中的 AI 生成、篡改以及 AI 撰写的段落。每个页面也提供 Markdown 版本，在同一路径后加 .md 即可。

## 概览

- 基础 URL：`https://api.fileverity.com/v1`（仅限 HTTPS，JSON）。
- 身份验证：在 `Authorization` 请求头中使用 Bearer API 密钥。Live 密钥以 `fv_live_` 开头；测试密钥以 `fv_test_` 开头，返回固定的示例结果，永不扣费。
- 图片检测：模型 `fvimg-2`（FVIMG V2），每张图片 US$1.99。先用 `POST /files` 上传，再调用 `POST /analyses`。
- 文档检测：模型 `fvdoc-3`（FVDOC V3），每份文档 US$5.99。先用 `POST /files` 上传，再调用 `POST /analyses`。
- 文本检测：模型 `fvdoc-3-text`（FVDOC V3 Text），每 1,000 字符 US$0.14，至少 100 个词。只需对 `POST /text/detections` 进行一次同步调用。

API 采用预付费方式，无需订阅：从 US$19 起为工作区余额充值。您的第一个工作区含 5 次免费图片或文档检测，以及 5,000 个免费文本字符。失败的检测不收费。余额自您最近一次充值起 12 个月内有效，充值款项除法律要求或您的协议另有规定外，概不退款。 上传的文件在分析开始时删除，最迟 24 小时后删除。您发送的文本不会被存储。结果保留 7 天。

## 入门

- [概览](https://fileverity.com/zh/docs.md): Fileverity API 用于检测图片、文档和纯文本中的 AI 生成、篡改以及 AI 撰写的段落。内容包括基础 URL、模型、约定，以及从哪里开始。
- [快速入门](https://fileverity.com/zh/docs/quickstart.md): 创建工作区、创建 API 密钥，并使用 cURL、JavaScript fetch 或 Python requests 运行您的第一次文本和图片检测。
- [身份验证与密钥](https://fileverity.com/zh/docs/authentication.md): 使用 Bearer API 密钥进行身份验证。内容包括 Live 密钥与测试密钥、测试模式的返回内容、撤销密钥，以及为每个密钥设置每月支出上限。

## 指南

- [文本检测](https://fileverity.com/zh/docs/text-detections.md): 通过 POST /text/detections 将纯文本判定为 AI 撰写、混合或人类撰写。内容包括请求和响应字段、段落偏移量、限制与计费。
- [文件](https://fileverity.com/zh/docs/files.md): 向 Fileverity 上传图片和文档：4 MB 以内的文件使用 multipart，50 MB 以内的文件使用预签名上传。内容包括文件对象、限制与保留期。
- [分析](https://fileverity.com/zh/docs/analyses.md): 创建图片和文档分析，通过 Prefer: wait 或轮询等待结果，取消分析，下载 PDF 报告，并了解报告对象和核验页。
- [Webhooks](https://fileverity.com/zh/docs/webhooks.md): 接收 analysis.completed、analysis.failed 和 balance.low 事件。包括 JavaScript 和 Python 中的 Standard Webhooks 签名校验、重试、自动停用和测试事件。
- [幂等性](https://fileverity.com/zh/docs/idempotency.md): 在 POST 请求中发送 Idempotency-Key，使重试的请求不会让同一次检测运行或计费两次。包括行为、重放和冲突。
- [示例代码](https://fileverity.com/zh/docs/sample-code.md): Fileverity API 的完整 Node.js 和 Python 程序：检测图片、检测大型 PDF、检测 AI 撰写的文本以及校验 Webhook 签名。
- [受理流程中的文档检测](https://fileverity.com/zh/docs/intake-workflow.md): 在受理流程中加入文档检测：上传、接收 Webhook、按风险等级分流、排入人工复核队列、保存报告编号并在之后核验。
- [错误](https://fileverity.com/zh/docs/errors.md): Fileverity API 的错误格式、HTTP 状态码和完整的错误码表，并说明哪些错误应当重试。
- [速率限制与 HTTP 头](https://fileverity.com/zh/docs/rate-limits.md): 每个 API 密钥的请求速率限制、速率限制响应头、429 和 503 响应中的 retry-after，以及 Fileverity API 设置的其他响应头。
- [价格与计费](https://fileverity.com/zh/docs/pricing.md): Fileverity API 的模型、价格和限制，预付余额及其有效期和退款，免费额度，支出上限，自动充值和余额不足提醒。
- [数据保留与安全](https://fileverity.com/zh/docs/security.md): Fileverity API 存储哪些数据、保留多久：上传的文件、结果、文本、请求日志和 Webhook 投递记录，以及密钥和端点如何受到保护。

## 参考

- [API 参考](https://fileverity.com/zh/docs/api-reference.md): Fileverity API 的所有接口，包含参数、请求和响应的 schema、错误码与示例，由 OpenAPI 3.1 规范生成。
- [更新日志](https://fileverity.com/zh/docs/changelog.md): Fileverity API 的变更。v1 版本于 2026 年 11 月发布。

## 机器可读

- [OpenAPI 3.1 规范](https://api.fileverity.com/v1/openapi.json): API 参考的来源。
- [合并为一个文件的全部文档页面](https://fileverity.com/zh/docs/llms-full.txt): 以上所有页面，以 Markdown 格式合并。