Sur cette page

Référence de l’API : IA

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

Démarrer une requête IA directe (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 au tenant · périmètre write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string 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 string Oui Requête en langage naturel
Longueur maximale : 10000
summaryVariant string Non

Réponse (200) :

Résultat 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 Données de résultat propres à la requête, présentes lorsque l’état est success
error string Non Message d’erreur lorsque l’état est error

Erreurs :

  • 401 Clé API absente, non valide, désactivée ou expirée
  • 429 Limite d’utilisation atteinte

Interroger une génération IA en cours (envoyer exactement le même corps que celui du POST qui l’a démarrée)

L’utilisation de POST pour l’interrogation est intentionnelle : la génération est identifiée par prompt + promptType + summaryVariant. L’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 au tenant · périmètre write

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string 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 string Oui Requête en langage naturel
Longueur maximale : 10000
summaryVariant string Non

Réponse (200) :

Résultat 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 Données de résultat propres à la requête, présentes lorsque l’état est success
error string Non Message d’erreur lorsque l’état est error

Erreurs :

  • 401 Clé API absente, non valide, désactivée ou expirée
  • 429 Limite d’utilisation atteinte