Skip to main content

建構端點

info

/build 端點由 AgentBuilder 的前端視覺編輯器程式碼使用。 這些端點是 AgentBuilder 內部程式碼庫的一部分。

不要使用這些端點在應用程式中執行 Flow，這些應用程式使用您的 AgentBuilder Flow。 要在您的應用程式中執行 Flow，請參閱 Flow觸發端點。

/build 端點支援 AgentBuilder 前端程式碼在 AgentBuilder 視覺編輯器中建構 Flow。 您可以使用這些端點建構頂點和 Flow，以及執行具有串流事件回應的 Flow。 當貢獻 AgentBuilder 程式碼庫時，您可能需要使用或理解這些端點。

建構 Flow並串流事件​

此端點建構並執行 Flow，返回一個工作 ID，可用於串流執行事件。

  1. 發送 POST 請求到 /build/$FLOW_ID/flow 端點：


    _10
    curl -X POST \
    _10
    "$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
    _10
    -H "accept: application/json" \
    _10
    -H "Content-Type: application/json" \
    _10
    -H "x-api-key: $LANGFLOW_API_KEY" \
    _10
    -d '{
    _10
    "inputs": {
    _10
    "input_value": "Tell me a story"
    _10
    }
    _10
    }'

    Result

    _10
    {
    _10
    "job_id": "123e4567-e89b-12d3-a456-426614174000"
    _10
    }

  2. 在從建構端點接收工作 ID 後，使用 /build/$JOB_ID/events 端點來串流執行結果：


    _10
    curl -X GET \
    _10
    "$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events" \
    _10
    -H "accept: application/json" \
    _10
    -H "x-api-key: $LANGFLOW_API_KEY"

    Result

    _10
    {"event": "vertices_sorted", "data": {"ids": ["ChatInput-XtBLx"], "to_run": ["Prompt-x74Ze", "ChatOutput-ylMzN", "ChatInput-XtBLx", "OpenAIModel-d1wOZ"]}}
    _10
    _10
    {"event": "add_message", "data": {"timestamp": "2025-03-03T17:42:23", "sender": "User", "sender_name": "User", "session_id": "d2bbd92b-187e-4c84-b2d4-5df365704201", "text": "Tell me a story", "files": [], "error": false, "edit": false, "properties": {"text_color": "", "background_color": "", "edited": false, "source": {"id": null, "display_name": null, "source": null}, "icon": "", "allow_markdown": false, "positive_feedback": null, "state": "complete", "targets": []}, "category": "message", "content_blocks": [], "id": "28879bd8-6a68-4dd5-b658-74d643a4dd92", "flow_id": "d2bbd92b-187e-4c84-b2d4-5df365704201"}}
    _10
    _10
    // ... Additional events as the flow executes ...
    _10
    _10
    {"event": "end", "data": {}}

/build/$FLOW_ID/events 端點有一個 stream 查詢參數，預設為 true。 要停用串流並一次獲取所有事件，請設定 ?stream=false。


_10
curl -X GET \
_10
"$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events?stream=false" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $LANGFLOW_API_KEY"

建構標頭​

標頭資訊範例
Content-Type必要。指定 JSON 格式。"application/json"
accept可選。指定回應格式。"application/json"
x-api-key可選。僅在啟用驗證時需要。"sk-..."

建構參數​

參數類型描述
inputsobject可選。FLOWComponents的輸入值。
dataobject可選。要覆蓋儲存配置的FLOW資料。
filesarray[string]可選。要使用的檔案路徑列表。
start_component_idstring可選。執行應開始的Components ID。Components id 值可以在 AgentBuilder JSON 檔案 中找到
stop_component_idstring可選。執行應停止的Components ID。Components id 值可以在 AgentBuilder JSON 檔案 中找到。
log_buildsBoolean是否記錄建構日誌。預設：啟用 (true)。

設定開始和停止點​

/build 端點接受 start_component_id 和 stop_component_id 的可選值，以控制FLOW執行開始和停止的位置。 為Components設定 stop_component_id 會觸發與在視覺編輯器中點擊該Components的 Run component 相同的行為：指定的Components和所有導致該Components的依賴Components將執行。

以下範例在 OpenAI Components停止FLOW執行：


_10
curl -X POST \
_10
"$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
_10
-H "accept: application/json" \
_10
-H "Content-Type: application/json" \
_10
-H "x-api-key: $LANGFLOW_API_KEY" \
_10
-d '{"stop_component_id": "OpenAIModel-Uksag"}'

覆蓋FLOW參數​

/build 端點也直接接受 data 的輸入，而不是使用儲存在 AgentBuilder 資料庫中的值。 這對於執行FLOW而不必通過視覺編輯器傳遞自訂值很有用。


_15
curl -X POST \
_15
"$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
_15
-H "accept: application/json" \
_15
-H "Content-Type: application/json" \
_15
-H "x-api-key: $LANGFLOW_API_KEY" \
_15
-d '{
_15
"data": {
_15
"nodes": [],
_15
"edges": []
_15
},
_15
"inputs": {
_15
"input_value": "Your custom input here",
_15
"session": "session_id"
_15
}
_15
}'

Result

_10
{ "job_id": "0bcc7f23-40b4-4bfa-9b8a-a44181fd1175" }

另請參閱​

Search