Visão geral da API
Base URL
https://omnidoc.top/api/v1Envie Content-Type: application/json com solicitações JSON. A chave da API deve ser incluída no cabeçalho X-API-Key ou como credencial Bearer.
Serviços
Seção intitulada “Serviços”| Serviço | Caminhos principais | Propósito |
|---|---|---|
| Carregamento de arquivo | /upload/* | Carregue e confirme os documentos |
| Biblioteca de arquivos | /storage/files/*, /documents/* | Listar, ler e baixar |
| Tradução | /jobs/*, /artifacts/* | Crie trabalhos, verifique o status e os resultados |
| Ferramentas de documento | /document-operations/*, /file-tools/* | Converter, mesclar, dividir, compactar e muito mais |
| Tradução instantânea | /ai/* | Tradução de textos curtos e segmentos em lote |
| Áudio e vídeo | /media-jobs/*, /media-voices/* | Empregos e vozes |
| Glossários | /glossaries/* | Termos, importação e exportação |
| Uso e créditos | /usage/*, /billing/credits/* | Registros de uso, saldo e liquidação |
| Notificações | /sse/*, /webhooks/* | Progresso em tempo real e callbacks |
Quais serviços você pode chamar e quanto eles custam: serviços e permissões .
Convenções
Seção intitulada “Convenções”- Os IDs de recurso são strings opacas.
- Envie um
Idempotency-Keycom solicitações de criação; operações de documentos, trabalhos de mídia e criação de voz exigem um. - Os parâmetros de paginação são descritos na página de cada endpoint.
- Trate
429conforme descrito em erros e tentativas de reenvio. - Os nomes dos arquivos baixados são apenas para exibição; utilize o nome base e respeite os limites do seu sistema de arquivos antes de salvar.
Rastreamento de solicitações
Seção intitulada “Rastreamento de solicitações”Mantenha o X-Request-Id de cada resposta. Ao entrar em contato com o suporte, informe esse valor, o horário da solicitação e o caminho; nunca envie a chave completa da API nem o conteúdo dos arquivos.