Workflow テスト API（更新 / 公開）

CodeX や Claude などの AI ツール（GPTBots Agent Skill をインストール済み）において、Skills が生成した .flow ファイル設定を GPTBots プラットフォーム上の対象 Workflow にインポートして公開できるよう、開発者をサポートします。

⚠️ 「テストモード」の Workflow のみ呼び出すことができます。 正式モードで呼び出すと 403200 が返されます。テストモードは Workflow 作成時に選択し、作成後は変更できません。

Workflow 更新 API（.flow をインポートして現在のバージョンを置き換える）

.flow ファイルを対象 Workflow（テストモード）にインポートし、置き換え後の現在の設定を新しいドラフトバージョンとして保存します（同時に「現在のバージョン」となります）。具体的なルールは以下のとおりです。

• ノード内のナレッジベース（データグループ）/ データベーステーブル / ナレッジドキュメント：WorkflowID 単位で判定し、引き続き対象 Workflow に属するものは保持し、それ以外は破棄します。
• 関連付けられた workflow / ツール（プラグイン）：組織単位で判定し、引き続き有効なものは保持し、それ以外は破棄します。
• サードパーティ認証情報：既存の Workflow にインポートする際は「同一のノード / プラグイン ID」に基づいて対象側で設定済みの認証情報を補完し、認証済みノードをクリアせず、可用性を確保します。

リクエストメソッド

POST

リクエストURL

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

リクエスト

リクエスト例

                      
                      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'

                    

リクエストヘッダー

リクエストパラメータ

バージョン番号はサーバー側で自動生成されます（最新バージョンの末尾セグメント +1、履歴バージョンがない場合は 1.0.0）。

レスポンス

レスポンス例

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

                    

成功時のレスポンス

失敗時のレスポンス

Workflow 公開 API（バージョン番号を指定して本番バージョンとして公開する）

対象（テストモード）Workflow の指定したバージョン番号を本番環境の本番バージョンとして公開します（当該バージョンが「本番」となり、その他のバージョンはドラフト状態に戻ります）。

リクエストメソッド

POST

リクエストURL

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

リクエスト

リクエスト例

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

                    

リクエストヘッダー

リクエストパラメータ

レスポンス

レスポンス例

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

                    

成功時のレスポンス

データ本体はありません。code が 0 であれば公開成功です。

失敗時のレスポンス

エラーコード

更新インターフェースと公開インターフェースは同一のエラーコードセットを共有します。