Workflow-Test-API (Aktualisieren / Veröffentlichen)

Ermöglicht Entwickler:innen, in KI-Tools wie CodeX, Claude usw. (mit installierter GPTBots Agent Skill) die von den Skills erzeugte .flow-Dateikonfiguration in einen Ziel-Workflow der GPTBots-Plattform zu importieren und zu veröffentlichen.

⚠️ Nur Workflows im „Testmodus" können aufgerufen werden. Ein Aufruf im Produktivmodus gibt 403200 zurück. Der Testmodus wird beim Erstellen des Workflows ausgewählt und kann nach der Erstellung nicht mehr geändert werden.

Workflow-Aktualisierungs-API (Import einer .flow-Datei zum Ersetzen der aktuellen Version)

Importiert die .flow-Datei in den Ziel-Workflow (Testmodus) und speichert die ersetzte aktuelle Konfiguration als eine neue Entwurfsversion (die zugleich zur „aktuellen Version" wird). Es gelten folgende Regeln:

• Wissensdatenbank (Datengruppe) / Datenbanktabellen / Wissensdokumente in den Knoten: nach Dimension WorkflowID; gehören sie weiterhin zum Ziel-Workflow, werden sie beibehalten, andernfalls verworfen;
• Verknüpfte Workflows / Tools (Plugins): nach Dimension Organisation; sind sie weiterhin gültig, werden sie beibehalten, andernfalls verworfen;
• Anmeldedaten von Drittanbietern: Beim Import in einen bestehenden Workflow werden die bereits am Ziel konfigurierten Anmeldedaten anhand „identischer Knoten-/Plugin-ID" zurückgeschrieben; bereits authentifizierte Knoten werden nicht geleert, um die Nutzbarkeit sicherzustellen;

Anfragemethode

POST

Anfrage-URL

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

Anfrage

Beispielanfrage

                      
                      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'

                    

Anfrage-Header

Anfrageparameter

Die Versionsnummer wird serverseitig automatisch generiert (letzter Abschnitt der neuesten Version +1; ohne vorhandene Historie ist sie 1.0.0).

Antwort

Beispielantwort

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

                    

Erfolgsantwort

Fehlerantwort

Workflow-Veröffentlichungs-API (Veröffentlichung einer Versionsnummer als Online-Version)

Veröffentlicht die angegebene Versionsnummer des Ziel-Workflows (Testmodus) als produktive Online-Version (diese Version wird „online", die übrigen Versionen kehren in den Entwurfsstatus zurück).

Anfragemethode

POST

Anfrage-URL

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

Anfrage

Beispielanfrage

                      
                      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"
}'

                    

Anfrage-Header

Anfrageparameter

Antwort

Beispielantwort

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

                    

Erfolgsantwort

Kein Datenkörper; code gleich 0 bedeutet erfolgreiche Veröffentlichung.

Fehlerantwort

Fehlercodes

Die Aktualisierungs- und die Veröffentlichungs-Schnittstelle teilen sich denselben Satz an Fehlercodes: