L’API Ultineo AI
Lancez les applications du catalogue depuis vos logiciels. L’API échange du JSON sur HTTPS, authentifie chaque appel avec une clé de projet et répond toujours dans la même enveloppe.
Construite autour de trois ressources
- Catalogue
Les applications publiées, les plus utilisées en premier, chacune avec les champs qu’elle attend.
- Exécutions
Un appel lance une application avec ses champs ; un autre relit l’exécution avec sa réponse.
- Clés
Des clés de projet avec des portées, une expiration facultative et un statut que vous pouvez désactiver.
Authentification et portées
- Une clé en en-tête
Envoyez votre clé de projet dans l’en-tête Authorization de chaque appel, uniquement en HTTPS.
- Limitée à un projet
Une clé est liée à un projet et ne peut jamais lire ni écrire les données d’un autre projet, quelle que soit la requête.
- Conservée sous forme d’empreinte
Seule une empreinte de la clé est conservée : elle n’est affichée en entier qu’une fois. Une clé perdue est remplacée, jamais récupérée.
Lancez une exécution et lisez sa réponse
- Créer
Indiquez l’application et fournissez une valeur par champ, avec le nom de champ donné par le catalogue.
- Suivre
Les exécutions sont asynchrones : relisez l’exécution jusqu’au statut terminé ou en échec. Ces deux statuts sont définitifs.
- Lire
Une exécution terminée porte sa réponse, sa durée et ses jetons consommés en entrée et en sortie.
Une seule enveloppe pour chaque réponse
- Les trois mêmes clés
Chaque réponse porte le code de statut, un titre court et la réponse, en cas de succès comme d’échec.
- Des messages stables
Les messages d’erreur sont des phrases anglaises stables qui nomment la portée manquante ou la valeur refusée.
- Les limites de formule sont explicites
Un appel non couvert par la formule, ou qui dépasserait son enveloppe, est refusé avec son propre code de statut.
Obtenir une clé
L’accès API est inclus dans les formules payantes d’Ultineo AI. Il n’y a pas encore d’inscription en libre-service : notre équipe ouvre votre projet et vous remet sa première clé.
Reliez vos logiciels à Ultineo AI
Dites-nous ce que vous voulez automatiser et nous ouvrirons votre projet et sa clé API.
Questions sur l’API
Les formules payantes. La formule gratuite donne accès aux applications, sans l’API.
Non. Les instructions appartiennent au propriétaire de l’application. L’API renvoie les champs, qui sont ce que l’on remplit.
Créer une exécution répond aussitôt avec le statut nouveau. Relisez l’exécution jusqu’à ce qu’elle soit terminée pour obtenir la réponse.
Oui. Chaque clé porte des portées et une expiration facultative, et une clé ne peut jamais créer une autre clé de portée plus large que la sienne.