Pular para o conteúdo

Visão geral da plataforma

A API OmniDoc gerencia fluxos de trabalho de arquivos e conteúdos dentro de uma única conta. Um solicitante cria recursos com uma chave de API e, em seguida, utiliza os IDs estáveis retornados para consultar, combinar, processar ou baixar esses recursos.

RecursoPropósito
Documento / ArquivoArquivos de origem e entradas da biblioteca de arquivos pertencentes à conta
Trabalho / OperaçãoTradução assíncrona, processamento de documentos ou tarefas de áudio e vídeo
ArtefatoResultados que um trabalho entrega para pré-visualização ou download
Operação de créditoO registro de qual ação faturável foi cobrada e reembolsada

Cada recurso é verificado em relação à conta proprietária. Os clientes precisam manter apenas os IDs públicos e não devem inferir detalhes de implementação a partir de IDs, nomes de arquivos ou endereços de download.

  1. Crie ou escolha um recurso de entrada.
  2. Certifique-se de que a conta tenha créditos: o saldo é verificado em relação a um limite antes do início da tarefa, e o uso efetivo é cobrado ao final.
  3. Crie o trabalho com um Idempotency-Key.
  4. Verifique o status do trabalho; trabalhos de tradução de arquivos também podem usar SSE ou webhooks.
  5. Leia os resultados e o registro de crédito deste trabalho.

Integrações externas sempre utilizam chaves de API, com as mesmas permissões da conta que criou a chave. Consulte autenticação .