Référence API : organisations
Référence API des points de terminaison de gestion des organisations et d’administration des utilisateurs.
Les points de terminaison IA exécutent les requêtes IA de manière asynchrone et vous permettent d’interroger le résultat.
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 :
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 :
Nous utilisons des cookies pour améliorer votre expérience, personnaliser le contenu et analyser le trafic. En cliquant sur « Tout accepter », vous consentez à l’utilisation de cookies.