# Overview

> The Fileverity API checks images, documents and plain text for AI generation, tampering and AI-written passages. Base URL, models, conventions and where to start.

Source: https://fileverity.com/en/docs

The Fileverity API lets your software check images, documents and plain text with Fileverity models. One API key and one prepaid workspace balance cover every model. Image and document results are the same reports the website produces, each with a report ID, an RFC 3161 timestamp and a public verification page.

New here? Follow the [Quickstart](https://fileverity.com/en/docs/quickstart.md) to make your first call in a few minutes, or [get a test key](https://fileverity.com/console/keys) and call the API right away. For a product overview, see the [API page](https://fileverity.com/en/api), the [AI image detection API](https://fileverity.com/en/api/ai-image-detection) and the [Document fraud detection API](https://fileverity.com/en/api/document-fraud-detection).

## Models

| Model | Checks | How you call it |
| --- | --- | --- |
| `fvimg-2` (FVIMG V2) | Images: AI generation, local edits, content credentials and metadata. Overview: [AI image detection API](https://fileverity.com/en/api/ai-image-detection) | Upload with [`POST /files`](https://fileverity.com/en/docs/files.md), then [`POST /analyses`](https://fileverity.com/en/docs/analyses.md) |
| `fvdoc-3` (FVDOC V3) | Documents: AI-written text, embedded photos, edit history and signatures. Overview: [Document fraud detection API](https://fileverity.com/en/api/document-fraud-detection) | Upload with [`POST /files`](https://fileverity.com/en/docs/files.md), then [`POST /analyses`](https://fileverity.com/en/docs/analyses.md) |
| `fvdoc-3-text` (FVDOC V3 Text) | Plain text: AI-written, partly AI-written or human-written, with the AI-written passages marked | One synchronous call to [`POST /text/detections`](https://fileverity.com/en/docs/text-detections.md) |

Prices, limits and snapshot IDs are listed on [Pricing and billing](https://fileverity.com/en/docs/pricing.md).

## Conventions

- **Base URL.** `https://api.fileverity.com/v1`. HTTPS only.
- **Format.** Requests are JSON, except file uploads, which are multipart. Responses are JSON, except the PDF report. Timestamps are Unix seconds, except inside `result.report`, where times are ISO 8601 in UTC.
- **Authentication.** A bearer API key in the `Authorization` header. See [Authentication and keys](https://fileverity.com/en/docs/authentication.md).
- **IDs.** Objects carry a prefix: `file_` files, `an_` analyses, `tdet_` text detections, `evt_` webhook events, `req_` requests. Report IDs look like `FV-XXXX-XXXX-XXXX`.
- **Request IDs.** Every response has an `x-request-id` header, and every error repeats it as `error.request_id`. Quote it when you [contact support](https://fileverity.com/en/contact).
- **Checks, analyses and reports.** A check is what you run and pay for: an image check, a document check or a text check. In the API, an analysis is one image or document check, and a text detection is one text check. Image and document checks produce a full report; a text check produces a result.
- **Versioning.** The version is in the URL. New fields and endpoints can be added to v1, so ignore fields you do not recognize. A model ID such as `fvimg-2` points to a dated snapshot (`fvimg-2-2026-10-30`). Results report the snapshot that produced them, and you can pin a request to a snapshot by passing its ID as `model`.
- **Languages.** Text detection accepts en, fr, de, es, zh.

## OpenAPI specification

The API is described by an OpenAPI 3.1 document at [https://api.fileverity.com/v1/openapi.json](https://api.fileverity.com/v1/openapi.json). The [API reference](https://fileverity.com/en/docs/api-reference.md) is generated from that document, so the two always agree. The document can be loaded from a browser, so tools such as Swagger UI and Postman can import it by URL, and `GET https://api.fileverity.com/v1` returns links to these docs and to the specification.

## What is in these docs

- [Quickstart](https://fileverity.com/en/docs/quickstart.md): from sign-up to a first result.
- [Authentication and keys](https://fileverity.com/en/docs/authentication.md): live and test keys, revocation and spend limits.
- [Text detections](https://fileverity.com/en/docs/text-detections.md), [Files](https://fileverity.com/en/docs/files.md) and [Analyses](https://fileverity.com/en/docs/analyses.md): the ways to run a check.
- [Webhooks](https://fileverity.com/en/docs/webhooks.md) and [Idempotency](https://fileverity.com/en/docs/idempotency.md): production behavior.
- [Sample code](https://fileverity.com/en/docs/sample-code.md): complete Node.js and Python programs for each check and for webhooks.
- [Document checks in an intake workflow](https://fileverity.com/en/docs/intake-workflow.md): upload, webhook, routing by risk level, human review and later verification.
- [Errors](https://fileverity.com/en/docs/errors.md) and [Rate limits and headers](https://fileverity.com/en/docs/rate-limits.md).
- [Pricing and billing](https://fileverity.com/en/docs/pricing.md) and [Data retention and security](https://fileverity.com/en/docs/security.md).
- [Changelog](https://fileverity.com/en/docs/changelog.md) and the [API reference](https://fileverity.com/en/docs/api-reference.md).

## The same checks in the browser

You do not need the API to run a check. The website offers [Check an image](https://fileverity.com/en/ai-image-detector), [Document verification](https://fileverity.com/en/ai-document-detector) and [Image verification](https://fileverity.com/en/image-verification), and the [Console](https://fileverity.com/console) runs all three checks against your workspace balance.

## Support

Write to [hello@fileverity.com](mailto:hello@fileverity.com) or use the [contact page](https://fileverity.com/en/contact), and include the request ID (`x-request-id`), the time in UTC and the endpoint. Temporary failures return `503 service_unavailable` with a `retry-after` header and are never charged. Need higher limits or volume pricing? [Contact sales](https://fileverity.com/en/contact).

## Reading these docs with an agent

Every page is also available as Markdown: add `.md` to its path, for example `/en/docs/quickstart.md`. The index of all pages is at [/en/docs/llms.txt](https://fileverity.com/en/docs/llms.txt).