Tổng quan

API của Fileverity cho phép phần mềm của bạn kiểm tra ảnh, tài liệu và văn bản thuần túy bằng các mô hình của Fileverity. Một khóa API và một số dư không gian làm việc trả trước dùng chung cho mọi mô hình. Kết quả ảnh và tài liệu chính là các báo cáo mà website tạo ra, mỗi báo cáo có mã báo cáo, dấu thời gian RFC 3161 và một trang xác minh công khai.

Mới bắt đầu? Hãy làm theo phần Bắt đầu nhanh để thực hiện lệnh gọi đầu tiên chỉ trong vài phút, hoặc lấy khóa thử nghiệm và gọi API ngay. Để xem tổng quan về sản phẩm, hãy đọc trang API, API phát hiện ảnh AI và API phát hiện gian lận tài liệu.

Mô hình#

Giá, giới hạn và mã snapshot được liệt kê tại Giá và thanh toán.

Quy ước#

• Base URL. https://api.fileverity.com/v1. Chỉ hỗ trợ HTTPS.
• Định dạng. Yêu cầu ở dạng JSON, trừ yêu cầu tải tệp lên dùng multipart. Phản hồi là JSON, trừ báo cáo PDF. Dấu thời gian tính bằng giây Unix, trừ trong result.report, nơi thời gian được ghi theo ISO 8601 ở múi giờ UTC.
• Xác thực. Khóa API bearer trong header Authorization. Xem Xác thực và khóa API.
• Mã định danh. Mỗi đối tượng có một tiền tố: file_ cho tệp, an_ cho lượt phân tích, tdet_ cho lượt phát hiện văn bản, evt_ cho sự kiện webhook, req_ cho yêu cầu. Mã báo cáo có dạng FV-XXXX-XXXX-XXXX.
• Mã yêu cầu. Mọi phản hồi đều có header x-request-id, và mọi lỗi đều lặp lại giá trị này trong error.request_id. Hãy cung cấp mã này khi bạn liên hệ hỗ trợ.
• Lượt kiểm tra, lượt phân tích và báo cáo. Lượt kiểm tra là đơn vị bạn chạy và trả phí: kiểm tra ảnh, kiểm tra tài liệu hoặc kiểm tra văn bản. Trong API, một lượt phân tích là một lượt kiểm tra ảnh hoặc tài liệu, còn một lượt phát hiện văn bản là một lượt kiểm tra văn bản. Lượt kiểm tra ảnh và tài liệu tạo ra một báo cáo đầy đủ; lượt kiểm tra văn bản tạo ra một kết quả.
• Phiên bản. Phiên bản nằm trong URL. Có thể thêm trường và endpoint mới vào v1, vì vậy hãy bỏ qua các trường bạn không nhận ra. Mã mô hình như fvimg-2 trỏ đến một snapshot có ghi ngày (fvimg-2-2026-10-30). Kết quả cho biết snapshot đã tạo ra chúng, và bạn có thể cố định một yêu cầu theo một snapshot bằng cách truyền mã của snapshot đó vào model.
• Ngôn ngữ. Phát hiện văn bản chấp nhận en, fr, de, es, zh.

Đặc tả OpenAPI#

API được mô tả bằng một tài liệu OpenAPI 3.1 tại https://api.fileverity.com/v1/openapi.json. Tham chiếu API được tạo từ tài liệu này nên hai bên luôn khớp nhau. Tài liệu có thể tải từ trình duyệt, vì vậy các công cụ như Swagger UI và Postman có thể nhập bằng URL, và GET https://api.fileverity.com/v1 trả về các liên kết tới tài liệu này và tới đặc tả.

Nội dung của tài liệu này#

• Bắt đầu nhanh: từ đăng ký đến kết quả đầu tiên.
• Xác thực và khóa API: khóa thật và khóa thử nghiệm, thu hồi khóa và hạn mức chi tiêu.
• Phát hiện văn bản, Tệp và Lượt phân tích: các cách chạy một lượt kiểm tra.
• Webhook và Idempotency: cách hoạt động trong môi trường production.
• Mã mẫu: các chương trình Node.js và Python hoàn chỉnh cho từng loại kiểm tra và cho webhook.
• Kiểm tra tài liệu trong quy trình tiếp nhận hồ sơ: tải lên, webhook, phân luồng theo mức độ rủi ro, xem xét thủ công và xác minh sau này.
• Lỗi và Giới hạn tốc độ và header.
• Giá và thanh toán và Lưu giữ dữ liệu và bảo mật.
• Nhật ký thay đổi và Tham chiếu API.

Cùng các lượt kiểm tra đó trong trình duyệt#

Bạn không cần dùng API để chạy một lượt kiểm tra. Website cung cấp Kiểm tra ảnh, Xác minh tài liệu và Xác minh hình ảnh, còn Console chạy cả ba loại kiểm tra và trừ vào số dư không gian làm việc của bạn.

Hỗ trợ#

Hãy gửi email tới hello@fileverity.com hoặc dùng trang liên hệ, kèm mã yêu cầu (x-request-id), thời gian theo UTC và endpoint. Lỗi tạm thời trả về 503 service_unavailable kèm header retry-after và không bao giờ bị tính phí. Cần giới hạn cao hơn hoặc giá theo khối lượng? Liên hệ bộ phận kinh doanh.

Đọc tài liệu này bằng AI agent#

Mỗi trang đều có sẵn dưới dạng Markdown: thêm .md vào đường dẫn của trang, ví dụ /vi/docs/quickstart.md. Danh mục của tất cả các trang nằm tại /vi/docs/llms.txt.