Descripción general de la API
Base URL
https://omnidoc.top/api/v1Envíe Content-Type: application/json con solicitudes JSON. La clave API se incluye en el encabezado X-API-Key o como credencial Bearer.
Servicios
Sección titulada «Servicios»| Servicio | Rutas principales | Propósito |
|---|---|---|
| Carga de archivos | /upload/* | Suba y confirme los documentos |
| Biblioteca de archivos | /storage/files/*, /documents/* | Listar, leer y descargar |
| Traducción | /jobs/*, /artifacts/* | Cree trabajos, consulte el estado y los resultados |
| Herramientas de documento | /document-operations/*, /file-tools/* | Convertir, fusionar, dividir, comprimir y más |
| Traducción instantánea | /ai/* | Traducción de texto breve y segmentos por lotes |
| Audio y video | /media-jobs/*, /media-voices/* | Empleos y voces |
| Glosarios | /glossaries/* | Términos, importación y exportación |
| Uso y créditos | /usage/*, /billing/credits/* | Registros de uso, saldo y liquidación |
| Notificaciones | /sse/*, /webhooks/* | Progreso en vivo y devoluciones de llamada |
Qué servicios puede llamar y cuánto cuestan: servicios y permisos .
Convenciones
Sección titulada «Convenciones»- Los ID de recurso son cadenas opacas.
- Envíe un
Idempotency-Keycon solicitudes de creación; las operaciones de documentos, los trabajos de medios y la creación de voz requieren uno. - Los parámetros de paginación se describen en la página de cada punto final.
- Maneje
429como se describe en errores y reintentos. - Los nombres de los archivos descargados son solo para visualización; utilice el nombre base y aplique los límites del sistema de archivos antes de guardar.
Rastreo de solicitudes
Sección titulada «Rastreo de solicitudes»Mantenga el X-Request-Id de cada respuesta. Cuando contacte con el soporte, proporcione ese valor, la hora de la solicitud y la ruta; nunca envíe la clave API completa ni el contenido del archivo.