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.
Modèle de ressource
Section intitulée « Modèle de ressource »| Ressource | Objectif |
|---|---|
| Document / Fichier | Fichiers source et entrées de la bibliothèque de fichiers appartenant au compte |
| Travail / Opération | Traduction asynchrone, traitement de documents ou tâches audio et vidéo |
| Artifact | Résultats qu’un travail fournit pour l’aperçu ou le téléchargement |
| Opération de crédit | L’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.
Flux d’appel courant
Section intitulée « Flux d’appel courant »- Créez ou sélectionnez une ressource d’entrée.
- 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.
- Créez le travail avec un
Idempotency-Key. - Vérifiez l’état du travail ; les travaux de traduction de fichiers peuvent également utiliser SSE ou des webhooks.
- Consultez les résultats et le journal des crédits pour cette tâche.
Identité
Section intitulée « Identité »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 .
Démarrage rapide → Téléchargez un fichier, créez une tâche, vérifiez son état et téléchargez les résultats