# 概览

> Fileverity API 用于检测图片、文档和纯文本中的 AI 生成、篡改以及 AI 撰写的段落。内容包括基础 URL、模型、约定，以及从哪里开始。

来源： https://fileverity.com/zh/docs

Fileverity API 让您的软件可以使用 Fileverity 模型检测图片、文档和纯文本。一个 API 密钥和一份预付的工作区余额即可覆盖所有模型。图片和文档的检测结果与网站生成的报告相同，每份报告都带有报告编号、RFC 3161 时间戳和公开核验页。

初次使用？按照[快速入门](https://fileverity.com/zh/docs/quickstart.md)，几分钟内即可发出第一次调用；也可以[获取测试密钥](https://fileverity.com/console/keys?lang=zh)，立即调用 API。产品概述请参阅 [API 页面](https://fileverity.com/zh/api)、[AI 生成图片检测 API](https://fileverity.com/zh/api/ai-image-detection) 和[文档伪造检测 API](https://fileverity.com/zh/api/document-fraud-detection)。

## 模型

| 模型 | 检测内容 | 调用方式 |
| --- | --- | --- |
| `fvimg-2`（FVIMG V2） | 图片：AI 生成、局部编辑、内容凭证和元数据。概述：[AI 生成图片检测 API](https://fileverity.com/zh/api/ai-image-detection) | 先用 [`POST /files`](https://fileverity.com/zh/docs/files.md) 上传，再调用 [`POST /analyses`](https://fileverity.com/zh/docs/analyses.md) |
| `fvdoc-3`（FVDOC V3） | 文档：AI 撰写的文本、内嵌照片、编辑历史和签名。概述：[文档伪造检测 API](https://fileverity.com/zh/api/document-fraud-detection) | 先用 [`POST /files`](https://fileverity.com/zh/docs/files.md) 上传，再调用 [`POST /analyses`](https://fileverity.com/zh/docs/analyses.md) |
| `fvdoc-3-text`（FVDOC V3 Text） | 纯文本：判定为 AI 撰写、部分由 AI 撰写或人类撰写，并标出其中由 AI 撰写的段落 | 对 [`POST /text/detections`](https://fileverity.com/zh/docs/text-detections.md) 发起一次同步调用 |

价格、限制和快照 ID 列于[价格与计费](https://fileverity.com/zh/docs/pricing.md)。

## 约定

- **基础 URL**：`https://api.fileverity.com/v1`。仅支持 HTTPS。
- **格式**：请求使用 JSON，文件上传除外，文件上传使用 multipart。响应使用 JSON，PDF 报告除外。时间戳以 Unix 秒数表示，`result.report` 内除外，其中的时间采用 UTC 的 ISO 8601 格式。
- **身份验证**：在 `Authorization` 请求头中携带 Bearer API 密钥。参见[身份验证与密钥](https://fileverity.com/zh/docs/authentication.md)。
- **ID**：对象 ID 带有前缀，`file_` 表示文件，`an_` 表示分析，`tdet_` 表示文本检测，`evt_` 表示 Webhook 事件，`req_` 表示请求。报告编号形如 `FV-XXXX-XXXX-XXXX`。
- **请求 ID**：每个响应都带有 `x-request-id` 响应头，每个错误也会在 `error.request_id` 中重复该值。[联系技术支持](https://fileverity.com/zh/contact)时请附上该 ID。
- **检测、分析与报告**：检测是您运行并为之付费的操作，包括图片检测、文档检测和文本检测。在 API 中，一次图片或文档检测对应一个分析（analysis），一次文本检测对应一个文本检测（text detection）。图片和文档检测生成完整报告；文本检测返回检测结果。
- **版本**：版本号位于 URL 中。v1 可能新增字段和接口，因此请忽略无法识别的字段。`fvimg-2` 这样的模型 ID 指向带日期的快照（`fvimg-2-2026-10-30`）。结果会注明生成它的快照，您也可以把快照 ID 作为 `model` 传入，将请求固定到该快照。
- **语言**：文本检测支持 en、fr、de、es、zh。

## OpenAPI 规范

API 由位于 [https://api.fileverity.com/v1/openapi.json](https://api.fileverity.com/v1/openapi.json) 的 OpenAPI 3.1 文档描述。[API 参考](https://fileverity.com/zh/docs/api-reference.md)由该文档生成，因此两者始终一致。该文档可从浏览器加载，因此 Swagger UI、Postman 等工具可以通过 URL 导入它；`GET https://api.fileverity.com/v1` 会返回指向本文档和该规范的链接。

## 文档目录

- [快速入门](https://fileverity.com/zh/docs/quickstart.md)：从注册到获得第一个结果。
- [身份验证与密钥](https://fileverity.com/zh/docs/authentication.md)：Live 密钥与测试密钥、撤销密钥和支出上限。
- [文本检测](https://fileverity.com/zh/docs/text-detections.md)、[文件](https://fileverity.com/zh/docs/files.md)和[分析](https://fileverity.com/zh/docs/analyses.md)：运行检测的几种方式。
- [Webhooks](https://fileverity.com/zh/docs/webhooks.md) 和[幂等性](https://fileverity.com/zh/docs/idempotency.md)：生产环境中的行为。
- [示例代码](https://fileverity.com/zh/docs/sample-code.md)：针对每种检测和 Webhook 的完整 Node.js 与 Python 程序。
- [受理流程中的文档检测](https://fileverity.com/zh/docs/intake-workflow.md)：上传、Webhook、按风险等级分流、人工复核和后续核验。
- [错误](https://fileverity.com/zh/docs/errors.md)和[速率限制与 HTTP 头](https://fileverity.com/zh/docs/rate-limits.md)。
- [价格与计费](https://fileverity.com/zh/docs/pricing.md)和[数据保留与安全](https://fileverity.com/zh/docs/security.md)。
- [更新日志](https://fileverity.com/zh/docs/changelog.md)和 [API 参考](https://fileverity.com/zh/docs/api-reference.md)。

## 在浏览器中运行同样的检测

运行检测并不一定要使用 API。网站提供 [AI 生成图片检测](https://fileverity.com/zh/ai-image-detector)、[文档检测](https://fileverity.com/zh/ai-document-detector)和[图像鉴伪](https://fileverity.com/zh/image-verification)，而[控制台](https://fileverity.com/console?lang=zh)会用您的工作区余额运行这三种检测。

## 技术支持

请发邮件至 [hello@fileverity.com](mailto:hello@fileverity.com) 或使用[联系页面](https://fileverity.com/zh/contact)，并附上请求 ID（`x-request-id`）、UTC 时间和所调用的接口。临时性故障会返回带有 `retry-after` 响应头的 `503 service_unavailable`，且不会收费。需要更高的限额或批量价格？[联系销售团队](https://fileverity.com/zh/contact)。

## 用 AI 智能体阅读本文档

每个页面都提供 Markdown 版本：在路径后加上 `.md` 即可，例如 `/zh/docs/quickstart.md`。全部页面的索引位于 [/zh/docs/llms.txt](https://fileverity.com/zh/docs/llms.txt)。