Saltearse al contenido

Descripción general de la plataforma

La API OmniDoc gestiona los flujos de trabajo de archivos y contenido dentro de una misma cuenta. El solicitante crea recursos con una clave API y, a continuación, utiliza los identificadores estables que recibe para consultarlos, combinarlos, procesarlos o descargarlos.

RecursoPropósito
Documento / ArchivoArchivos fuente y entradas de la biblioteca de archivos propiedad de la cuenta
Trabajo / OperaciónTraducción asíncrona, procesamiento de documentos o trabajos de audio y video
ArtefactoResultados que un trabajo proporciona para vista previa o descarga
Operación de créditoEl registro de lo que una acción facturable cobró y reembolsó

Cada recurso se verifica con la cuenta propietaria. Los clientes solo deben conservar los identificadores públicos y no deben deducir detalles de implementación a partir de los identificadores, nombres de archivo o direcciones de descarga.

  1. Cree o seleccione un recurso de entrada.
  2. Asegúrese de que la cuenta tenga créditos: el saldo se verifica contra un umbral antes de iniciar el trabajo y el uso real se cobra al finalizar.
  3. Cree el trabajo con un Idempotency-Key.
  4. Compruebe el estado del trabajo; los trabajos de traducción de archivos también pueden utilizar SSE o webhooks.
  5. Lea los resultados y el registro de créditos de este trabajo.

Las integraciones externas siempre utilizan claves API, con los mismos permisos que la cuenta que creó la clave. Consulte autenticación .