Panoramica della piattaforma
L’API OmniDoc gestisce i flussi di lavoro relativi a file e contenuti all’interno di un unico account. Un utente che effettua la chiamata crea le risorse utilizzando una chiave API, quindi impiega gli ID stabili restituiti per interrogarle, combinarle, elaborarle o scaricarle.
Modello delle risorse
Sezione intitolata “Modello delle risorse”| Risorsa | Scopo |
|---|---|
| Documento / File | File sorgente e voci della libreria file di proprietà dell’account |
| Lavoro / Operazione | Traduzione asincrona, elaborazione documenti o lavori audio e video |
| Artifact | Risultati forniti da un lavoro per l’anteprima o il download |
| Operazione di credito | La registrazione di ciò che è stato addebitato e rimborsato per una singola azione fatturabile |
Ogni risorsa viene verificata in base all’account proprietario. I clienti devono conservare solo gli ID pubblici e non dovrebbero dedurre dettagli implementativi dagli ID, dai nomi dei file o dagli indirizzi di download.
Flusso di chiamata comune
Sezione intitolata “Flusso di chiamata comune”- Crea o scegli una risorsa di input.
- Assicurati che l’account disponga di credito: il saldo viene verificato rispetto a una soglia prima dell’avvio del job e l’utilizzo effettivo viene addebitato al termine.
- Crea il lavoro con un
Idempotency-Key. - Verifica lo stato dell’operazione; i lavori di traduzione dei file possono utilizzare anche SSE o gli webhook.
- Leggi i risultati e il registro dei crediti per questo lavoro.
Identità
Sezione intitolata “Identità”I integrazioni esterne utilizzano sempre chiavi API, con le stesse autorizzazioni dell’account che ha creato la chiave. Vedere autenticazione .
Avvio rapido → Carica un file, crea un lavoro, controlla il suo stato e scarica i risultati