Aller au contenu

Aperçu de la plateforme

L’API OmniDoc gère les flux de fichiers et de contenus au sein d’un même compte. Un appelant crée des ressources à l’aide d’une clé API, puis utilise les identifiants stables renvoyés pour les interroger, les combiner, les traiter ou les télécharger.

RessourceObjectif
Document / FichierFichiers source et entrées de la bibliothèque de fichiers appartenant au compte
Travail / OpérationTraduction asynchrone, traitement de documents ou tâches audio et vidéo
ArtifactRésultats qu’un travail fournit pour l’aperçu ou le téléchargement
Opération de créditL’enregistrement de ce qu’une action facturable a facturé et remboursé

Chaque ressource est vérifiée par rapport au compte propriétaire. Les clients doivent uniquement conserver les identifiants publics et ne doivent pas déduire de détails d’implémentation à partir des identifiants, des noms de fichiers ou des adresses de téléchargement.

  1. Créez ou sélectionnez une ressource d’entrée.
  2. Assurez-vous que le compte dispose de crédits : le solde est vérifié par rapport à un seuil avant le démarrage du job, et la consommation réelle est facturée à l’achèvement.
  3. Créez le travail avec un Idempotency-Key.
  4. Vérifiez l’état du travail ; les travaux de traduction de fichiers peuvent également utiliser SSE ou des webhooks.
  5. Consultez les résultats et le journal des crédits pour cette tâche.

Les intégrations externes utilisent toujours des clés API, avec les mêmes permissions que le compte qui a créé la clé. Voir authentification .