Bỏ qua để đến nội dung

Tổng quan về API

Base URL

https://omnidoc.top/api/v1

Gửi Content-Type: application/json kèm theo các yêu cầu JSON. Khóa API được đặt trong tiêu đề X-API-Key hoặc dưới dạng thông tin xác thực Bearer.

Dịch vụĐường dẫn chínhMục đích
Tải tệp lên/upload/*Tải lên và xác nhận tài liệu
Thư viện tệp/storage/files/*, /documents/*Liệt kê, đọc và tải xuống
Dịch/jobs/*, /artifacts/*Tạo tác vụ, kiểm tra trạng thái và kết quả
Công cụ tài liệu/document-operations/*, /file-tools/*Chuyển đổi, hợp nhất, tách, nén và nhiều thao tác khác
Dịch ngay lập tức/ai/*Dịch văn bản ngắn và các đoạn dịch theo lô
Âm thanh và video/media-jobs/*, /media-voices/*Công việc và giọng nói
Bảng thuật ngữ/glossaries/*Điều khoản, nhập khẩu và xuất khẩu
Sử dụng và nguồn gốc/usage/*, /billing/credits/*Hồ sơ sử dụng, số dư và thanh toán
Thông báo/sse/*, /webhooks/*Tiến trình trực tiếp và các hàm gọi lại

Những dịch vụ bạn có thể gọi và chi phí của chúng: dịch vụ và quyền hạn .

  • ID tài nguyên là các chuỗi không rõ nghĩa.
  • Gửi một Idempotency-Key kèm theo các yêu cầu tạo; các thao tác tài liệu, công việc phương tiện và tạo giọng nói đều yêu cầu một Idempotency-Key.
  • Các tham số phân trang được mô tả trên trang của từng điểm cuối.
  • Xử lý 429 như mô tả trong lỗi và thử lại .
  • Tên tệp đã tải xuống chỉ dùng để hiển thị; hãy lấy tên cơ sở và áp dụng các giới hạn của hệ thống tập tin trước khi lưu.

Hãy giữ nguyên X-Request-Id của mọi phản hồi. Khi liên hệ với bộ phận hỗ trợ, hãy cung cấp giá trị này, thời gian yêu cầu và đường dẫn; tuyệt đối không gửi khóa API đầy đủ hoặc nội dung tệp.