メインコンテンツまでスキップ

Agent Workflow Preset API

概要: rokadoc の Agent Flow（複数エージェントノードを組み合わせたワークフロー）はWeb UI のエディターで作成・保存します。本APIではそのプリセット（保存済みフロー）を一覧・取得できます。取得した agent_nodes / edges の構造をそのまま Agent Flow 実行API の encoded_flow に再投入することで、UI で組んだフローを API 経由で実行できます。

備考

プリセットの作成・編集は Web UI のフローエディターから行ってください。

アクセスレベル​

アクセスレベル共有範囲
personal作成ユーザーのみ
spaceスペース所属メンバー全員

GET /v1/user/agent-workflow-presets​

ログインユーザーに紐づくプリセット一覧を取得します。

GET /v1/user/agent-workflow-presets

Headers​

  • api-key : string(required) - rokadoc APIキー

Query Parameters​

なし

Request Example​

curl -X 'GET' \
"https://api.rokadoc.ntt.com/v1/user/agent-workflow-presets" \
-H "api-key: ${ROKADOC_API_KEY}"

Response​

200 OK - プリセット一覧​

レスポンスは配列形式です（{code, data} のラップはありません）。

[
  {
    "id": "xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "サンプルプリセット",
    "description": null,
    "agent_nodes": [
      { "id": "start-node", "node_type": "start" },
      {
        "id": "node-xxxxxxxxxxx",
        "node_type": "search_agent",
        "agent_master_id": "xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "use_llm": "gpt-5.1",
        "reasoning_effort": "medium",
        "system_prompt": "",
        "tags_filter": [],
        "search_top_k": 3,
        "tags_filter_include": true,
        "adjacent_chunks": 1,
        "retrieval_query_generation_system_prompt": ""
      },
      { "id": "end-node", "node_type": "end" }
    ],
    "edges": [
      { "source": "start-node", "target": "node-xxxxxxxxxxx", "source_handle": null },
      { "source": "node-xxxxxxxxxxx", "target": "end-node", "source_handle": null }
    ],
    "agent_masters": [
      { "id": "xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "name": "..." }
    ],
    "access_level": "personal",
    "registered_user_id": "xxxxxxxxxxxx",
    "space_id": null,
    "created_at": "2026-04-21T02:57:30.216231Z",
    "updated_at": "2026-04-21T02:57:30.216231Z"
  }
]
  • id : string - プリセットID（実行APIでの参照には使用しません。agent_nodes / edges を直接使います）
  • name : string - プリセット名
  • description : string|null - プリセットの説明
  • agent_nodes : array - エージェントノードの配列。node_type をキーとした discriminated union（start / end / search_agent / default_agent / human_input / auto_reply / ai_router）。各ノードの詳細フィールドは UI で編集した内容がそのまま保存されたもの
  • edges : array - ノード間の接続定義
    • source : string - 遷移元ノードID
    • target : string - 遷移先ノードID
    • source_handle : string|null - 遷移元のハンドルID（yes / no などの分岐用）
  • agent_masters : array - フロー内で参照される Agent Master の定義
  • access_level : string - personal または space
  • registered_user_id : string - 登録したユーザーID
  • space_id : string|null - スペースに共有されている場合のスペースID
  • created_at / updated_at : string - 作成・更新日時（ISO 8601）

注意事項​

  • レスポンス全体（特に agent_nodes / edges）をそのまま保存しておくと、後のAgent Flow 実行API の encoded_flow に再利用できます

GET /v1/space/{space_id}/agent-workflow-presets​

指定スペースに紐づくプリセット一覧を取得します。スペース機能を利用していて、スペース内で共有されたフローを参照する場合に使います。

GET /v1/space/{space_id}/agent-workflow-presets

Headers​

  • api-key : string(required) - rokadoc APIキー
必須パラメータ​
  • space_id : string(required) - スペースID（パスパラメータ）

Request Example​

curl -X 'GET' \
"https://api.rokadoc.ntt.com/v1/space/${SPACE_ID}/agent-workflow-presets" \
-H "api-key: ${ROKADOC_API_KEY}"

Response​

レスポンス形式は GET /v1/user/agent-workflow-presets と同じ配列形式です。

GET /v1/api/agent-workflow-presets/{preset_id}​

指定IDのプリセットを取得します。一覧APIで取得できる項目と同じ構造のオブジェクトを単体で返します。

GET /v1/api/agent-workflow-presets/{preset_id}

Headers​

  • api-key : string(required) - rokadoc APIキー
必須パラメータ​
  • preset_id : string(required) - プリセットID（パスパラメータ）

Request Example​

curl -X 'GET' \
"https://api.rokadoc.ntt.com/v1/api/agent-workflow-presets/${PRESET_ID}" \
-H "api-key: ${ROKADOC_API_KEY}"

Response​

200 OK - プリセット詳細​

GET /v1/user/agent-workflow-presets のレスポンス配列の1要素と同じ構造を、配列にラップせず単体オブジェクトとして返します。