logo
Développement
Rechercher
API de test Workflow (mise à jour / publication)

API de test Workflow (mise à jour / publication)

Permet aux développeurs, depuis des outils d'IA comme CodeX, Claude, etc. (ayant installé le GPTBots Agent Skill), d'importer la configuration du fichier .flow générée par les Skills dans un Workflow cible sur la plateforme GPTBots et de la publier en ligne.

⚠️ Seuls les Workflows en « mode test » peuvent être appelés. Un appel en mode officiel retourne 403200. Le mode test est sélectionné lors de la création du Workflow et ne peut pas être modifié après la création.

API de mise à jour du Workflow (importer .flow pour remplacer la version actuelle)

Importe le fichier .flow dans le Workflow cible (mode test) et enregistre la configuration actuelle après remplacement en tant que nouvelle version brouillon (qui devient également la « version actuelle »). Les règles sont les suivantes :

  • Bases de connaissances (groupes de données) / tables de base de données / documents de connaissances dans les nœuds : selon la dimension WorkflowID, ceux qui appartiennent toujours au Workflow cible sont conservés, sinon ils sont supprimés ;
  • Workflow / outils (plugins) associés : selon la dimension organisation, ceux qui restent valides sont conservés, sinon ils sont supprimés ;
  • Identifiants tiers : lors de l'importation dans un Workflow existant, les identifiants déjà configurés sur la cible sont réinjectés selon « **le même ID de nœud / plugin », sans vider les nœuds déjà authentifiés, afin de garantir la disponibilité ;

Méthode de requête

POST

URL de la requête

https://api-${endpoint}.gptbots.ai/v1/workflow/version/import

Requête

Exemple de requête

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/workflow/version/import' \ -H 'Authorization: Bearer {WORKFLOW_API_KEY}' \ -H 'Content-Type: multipart/form-data' \ -F 'file=@my-workflow.flow' \ -F 'versionDesc=Imported by AI tool'
                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/workflow/version/import' \
-H 'Authorization: Bearer {WORKFLOW_API_KEY}' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@my-workflow.flow' \
-F 'versionDesc=Imported by AI tool'

                    
Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ Type Description
Authorization Bearer {API Key} Utilisez Authorization: Bearer {API Key} pour l'authentification de l'appel. Obtenez la clé dans le canal « Intégration / API » du Workflow cible et utilisez-la comme API Key.
Content-Type multipart/form-data Type de données, à définir sur multipart/form-data.

Paramètres de la requête

Champ Type Obligatoire Description
file file Oui Fichier .flow binaire.
versionDesc text Non Description de la version.

Le numéro de version est généré automatiquement par le serveur (dernier segment de la version la plus récente +1 ; en l'absence de version historique, il est 1.0.0).

Réponse

Exemple de réponse

{ "code": 0, "msg": "OK", "data": { "botId": "xxx", "botType": "Workflow", "version": "1.0.3" } }
                      
                      {
  "code": 0,
  "msg": "OK",
  "data": {
    "botId": "xxx",
    "botType": "Workflow",
    "version": "1.0.3"
  }
}

                    
Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ Type Description
botId string ID du Workflow cible.
botType string Toujours Workflow.
version string Numéro de la version enregistrée lors de cette opération (c'est-à-dire la version actuelle).

Réponse en cas d'échec

Champ Type Description
code int Code d'erreur.
msg string Détails de l'erreur.

API de publication du Workflow (publier en ligne par numéro de version)

Publie le numéro de version spécifié du Workflow cible (mode test) en tant que version de production en ligne (cette version devient « en ligne », les autres versions reviennent à l'état brouillon).

Méthode de requête

POST

URL de la requête

https://api-${endpoint}.gptbots.ai/v1/workflow/version/release

Requête

Exemple de requête

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/workflow/version/release' \ -H 'Authorization: Bearer {WORKFLOW_API_KEY}' \ -H 'Content-Type: application/json' \ -d '{ "version": "1.0.3" }'
                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/workflow/version/release' \
-H 'Authorization: Bearer {WORKFLOW_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
        "version": "1.0.3"
}'

                    
Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ Type Description
Authorization Bearer {API Key} Utilisez Authorization: Bearer {API Key} pour l'authentification de l'appel. Obtenez la clé dans le canal « Intégration / API » du Workflow cible et utilisez-la comme API Key.
Content-Type application/json Type de données, à définir sur application/json.

Paramètres de la requête

Champ Type Obligatoire Description
version string Oui Numéro de version à publier en ligne (par ex. 1.0.3), généralement le version retourné par l'interface « mise à jour ».

Réponse

Exemple de réponse

{ "code": 0, "msg": "OK" }
                      
                      {
  "code": 0,
  "msg": "OK"
}

                    
Ce bloc de code dans la fenêtre flottante

Réponse réussie

Aucun corps de données ; un code égal à 0 signifie que la publication a réussi.

Réponse en cas d'échec

Champ Type Description
code int Code d'erreur.
msg string Détails de l'erreur.

Codes d'erreur

Les interfaces de mise à jour et de publication partagent le même ensemble de codes d'erreur :

Code Message
0 Succès
40348 Le Workflow n'existe pas
403200 Mode non test : seuls les Workflows en mode test peuvent être mis à jour ou publiés par cette API
403201 Le type du fichier importé ne correspond pas au type du Workflow cible
403202 Échec de l'analyse du fichier .flow importé
403203 Le numéro de version spécifié n'existe pas
403204 Le type de l'API Key ne correspond pas à l'interface : cette interface n'accepte que la Workflow Key
40353 Le nombre de publications dépasse la limite du forfait