Sur cette page
> ressources > documentation > api > Référence de l’API : IA

Référence de l’API : IA

Les points de terminaison IA exécutent les requêtes de manière asynchrone et vous permettent d’interroger leur état pour obtenir le résultat.

Lancer une requête directe à l’IA (asynchrone ; interroger POST …/ai/{promptType}/status avec le même corps)

Point de terminaison : POST /v1/tenant/{tenantId}/ai/{promptType}

Authentification : clé API limitée à l’environnement · autorisation write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
promptType processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit chemin Oui Valeurs autorisées : processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Corps de la requête :

{
	"prompt": "string",
	"summaryVariant": "string"
}
Champ Type Obligatoire Description
prompt chaîne Oui Requête en langage naturel
Longueur maximale : 10 000
summaryVariant chaîne Non

Réponse (200) :

Résultat de l’IA (état : success | generating | error)

{
	"status": "success",
	"result": {
		"type": "processAnalysis",
		"analysis": "string"
	},
	"error": "string"
}
Champ Type Obligatoire Description
status success | error | generating Oui Valeurs autorisées : success, error, generating
result object | object | object | object | object | object Non Résultat propre à la requête (présent lorsque l’état est success)
error chaîne Non Message d’erreur lorsque l’état est error

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 429 Limite d’utilisation atteinte

Interroger une génération IA en cours (envoyez exactement le même corps que pour la requête POST initiale)

L’utilisation de POST pour interroger l’état est intentionnelle : la génération est identifiée par prompt + promptType + summaryVariant. La requête d’interrogation répète donc le corps au lieu de cibler un identifiant d’exécution.

Point de terminaison : POST /v1/tenant/{tenantId}/ai/{promptType}/status

Authentification : clé API limitée à l’environnement · autorisation write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId chaîne chemin Oui Format : uuid
promptType processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit chemin Oui Valeurs autorisées : processAnalysis, processQuestion, aiSummary, processDocumentation, processRaci, processMetaEdit

Corps de la requête :

{
	"prompt": "string",
	"summaryVariant": "string"
}
Champ Type Obligatoire Description
prompt chaîne Oui Requête en langage naturel
Longueur maximale : 10 000
summaryVariant chaîne Non

Réponse (200) :

Résultat de l’IA (état : success | generating | error)

{
	"status": "success",
	"result": {
		"type": "processAnalysis",
		"analysis": "string"
	},
	"error": "string"
}
Champ Type Obligatoire Description
status success | error | generating Oui Valeurs autorisées : success, error, generating
result object | object | object | object | object | object Non Résultat propre à la requête (présent lorsque l’état est success)
error chaîne Non Message d’erreur lorsque l’état est error

Erreurs :

  • 401 Clé API manquante, invalide, désactivée ou expirée
  • 429 Limite d’utilisation atteinte

Documentation associée

Concevez de meilleurs processus. Bâtissez une architecture cohérente. Gardez la maîtrise.

Accédez immédiatement à la plateforme, sans carte bancaire ni attente. Représentez clairement le fonctionnement de votre organisation dans des modèles de processus reliés entre eux.

Définissez l’architecture des processus, les responsabilités et les contrôles, puis clarifiez les rôles à chaque niveau.

Démarrez votre essai gratuit et posez les bases d’une gouvernance, d’une gestion et d’une amélioration continue de vos processus.

Démarrez votre essai gratuit dès aujourd’hui.