diff --git a/404.html b/404.html index d4d726c9ef..111fc47e37 100644 --- a/404.html +++ b/404.html @@ -22,7 +22,7 @@ - +
diff --git a/agents-overview.html b/agents-overview.html index 2b1d4be769..0bde6b9078 100644 --- a/agents-overview.html +++ b/agents-overview.html @@ -22,7 +22,7 @@ - + diff --git a/agents-tool-calling-agent-component.html b/agents-tool-calling-agent-component.html index 9959adb5d2..95ccc779e7 100644 --- a/agents-tool-calling-agent-component.html +++ b/agents-tool-calling-agent-component.html @@ -22,7 +22,7 @@ - + diff --git a/api-reference-api-examples.html b/api-reference-api-examples.html index 2382d26e6e..59fbb6c131 100644 --- a/api-reference-api-examples.html +++ b/api-reference-api-examples.html @@ -22,7 +22,7 @@ - + diff --git a/api.html b/api.html index e9c8eb98e1..344b7a9c30 100644 --- a/api.html +++ b/api.html @@ -22,7 +22,7 @@ - + diff --git a/api/add-user.html b/api/add-user.html index c6ff91a7b9..bf45acd89b 100644 --- a/api/add-user.html +++ b/api/add-user.html @@ -22,7 +22,7 @@ - + diff --git a/api/auto-login.html b/api/auto-login.html index be8e35f601..7c61772655 100644 --- a/api/auto-login.html +++ b/api/auto-login.html @@ -22,7 +22,7 @@ - + diff --git a/api/build-flow.html b/api/build-flow.html index 3de7100c2c..68b3a861c0 100644 --- a/api/build-flow.html +++ b/api/build-flow.html @@ -22,7 +22,7 @@ - + diff --git a/api/build-vertex-stream.html b/api/build-vertex-stream.html index 4e50035e88..fef0f72969 100644 --- a/api/build-vertex-stream.html +++ b/api/build-vertex-stream.html @@ -22,7 +22,7 @@ - + diff --git a/api/build-vertex.html b/api/build-vertex.html index 3ab1139f70..862e6af2fc 100644 --- a/api/build-vertex.html +++ b/api/build-vertex.html @@ -22,7 +22,7 @@ - + diff --git a/api/cancel-build.html b/api/cancel-build.html index ef96e47448..cdfde26980 100644 --- a/api/cancel-build.html +++ b/api/cancel-build.html @@ -22,7 +22,7 @@ - + diff --git a/api/check-if-store-has-api-key.html b/api/check-if-store-has-api-key.html index 49c55acdd8..30ccfa5b54 100644 --- a/api/check-if-store-has-api-key.html +++ b/api/check-if-store-has-api-key.html @@ -22,7 +22,7 @@ - + diff --git a/api/check-if-store-is-enabled.html b/api/check-if-store-is-enabled.html index ff379fe8db..9b1ec8b05b 100644 --- a/api/check-if-store-is-enabled.html +++ b/api/check-if-store-is-enabled.html @@ -22,7 +22,7 @@ - + diff --git a/api/create-api-key-route.html b/api/create-api-key-route.html index 2c4df98f20..489238409e 100644 --- a/api/create-api-key-route.html +++ b/api/create-api-key-route.html @@ -22,7 +22,7 @@ - + diff --git a/api/create-flow.html b/api/create-flow.html index bef2723543..81c4c339ea 100644 --- a/api/create-flow.html +++ b/api/create-flow.html @@ -22,7 +22,7 @@ - + diff --git a/api/create-flows.html b/api/create-flows.html index a089a567d7..0a56afdecd 100644 --- a/api/create-flows.html +++ b/api/create-flows.html @@ -22,7 +22,7 @@ - + diff --git a/api/create-folder.html b/api/create-folder.html index c60a83d8e9..a94c7076ba 100644 --- a/api/create-folder.html +++ b/api/create-folder.html @@ -22,7 +22,7 @@ - + diff --git a/api/create-upload-file.html b/api/create-upload-file.html index 5bc5250c0b..42f0b71902 100644 --- a/api/create-upload-file.html +++ b/api/create-upload-file.html @@ -22,7 +22,7 @@ - + diff --git a/api/create-variable.html b/api/create-variable.html index a28103d8e5..4dcb4de66a 100644 --- a/api/create-variable.html +++ b/api/create-variable.html @@ -22,7 +22,7 @@ - + diff --git a/api/custom-component-update.html b/api/custom-component-update.html index 1f5c94ed53..75f9b62406 100644 --- a/api/custom-component-update.html +++ b/api/custom-component-update.html @@ -22,7 +22,7 @@ - + diff --git a/api/custom-component.html b/api/custom-component.html index e8cf07f447..f6a0849736 100644 --- a/api/custom-component.html +++ b/api/custom-component.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-all-files.html b/api/delete-all-files.html index e01616b74c..ddbadd85db 100644 --- a/api/delete-all-files.html +++ b/api/delete-all-files.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-api-key-route.html b/api/delete-api-key-route.html index 2027639648..e1c1c395c4 100644 --- a/api/delete-api-key-route.html +++ b/api/delete-api-key-route.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-file-1.html b/api/delete-file-1.html index 09222fb38d..e74cff354d 100644 --- a/api/delete-file-1.html +++ b/api/delete-file-1.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-file.html b/api/delete-file.html index 398bd8b350..7dd0eff120 100644 --- a/api/delete-file.html +++ b/api/delete-file.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-flow.html b/api/delete-flow.html index fc0ed0ea5f..adf9a61b73 100644 --- a/api/delete-flow.html +++ b/api/delete-flow.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-folder.html b/api/delete-folder.html index b6b20c4b4d..8de92fcb79 100644 --- a/api/delete-folder.html +++ b/api/delete-folder.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-messages-session.html b/api/delete-messages-session.html index 7dab7db8b3..9fab611b96 100644 --- a/api/delete-messages-session.html +++ b/api/delete-messages-session.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-messages.html b/api/delete-messages.html index 6ccb373ca5..11d687420f 100644 --- a/api/delete-messages.html +++ b/api/delete-messages.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-multiple-flows.html b/api/delete-multiple-flows.html index 86aabffd2d..4ecde07933 100644 --- a/api/delete-multiple-flows.html +++ b/api/delete-multiple-flows.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-user.html b/api/delete-user.html index ef5e56d061..7feeac1ef3 100644 --- a/api/delete-user.html +++ b/api/delete-user.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-variable.html b/api/delete-variable.html index bc00d355b9..12d300c16d 100644 --- a/api/delete-variable.html +++ b/api/delete-variable.html @@ -22,7 +22,7 @@ - + diff --git a/api/delete-vertex-builds.html b/api/delete-vertex-builds.html index c0b8cca085..e6b82c0cca 100644 --- a/api/delete-vertex-builds.html +++ b/api/delete-vertex-builds.html @@ -22,7 +22,7 @@ - + diff --git a/api/download-component.html b/api/download-component.html index 3a568d5cb2..49ab828f4a 100644 --- a/api/download-component.html +++ b/api/download-component.html @@ -22,7 +22,7 @@ - + diff --git a/api/download-file-1.html b/api/download-file-1.html index 0d92167075..493af611e7 100644 --- a/api/download-file-1.html +++ b/api/download-file-1.html @@ -22,7 +22,7 @@ - + diff --git a/api/download-file-2.html b/api/download-file-2.html index efbb36fdde..2ba00cc4bc 100644 --- a/api/download-file-2.html +++ b/api/download-file-2.html @@ -22,7 +22,7 @@ - + diff --git a/api/download-file.html b/api/download-file.html index ea68bfe66d..ba69bff570 100644 --- a/api/download-file.html +++ b/api/download-file.html @@ -22,7 +22,7 @@ - + diff --git a/api/download-image.html b/api/download-image.html index dcc9d6ee55..f506b981e0 100644 --- a/api/download-image.html +++ b/api/download-image.html @@ -22,7 +22,7 @@ - + diff --git a/api/download-multiple-file.html b/api/download-multiple-file.html index a0e27e6d93..cac0cc7227 100644 --- a/api/download-multiple-file.html +++ b/api/download-multiple-file.html @@ -22,7 +22,7 @@ - + diff --git a/api/download-profile-picture.html b/api/download-profile-picture.html index 572df536ae..df4dd574b8 100644 --- a/api/download-profile-picture.html +++ b/api/download-profile-picture.html @@ -22,7 +22,7 @@ - + diff --git a/api/edit-file-name.html b/api/edit-file-name.html index 841e73e0dc..afb18545c8 100644 --- a/api/edit-file-name.html +++ b/api/edit-file-name.html @@ -22,7 +22,7 @@ - + diff --git a/api/experimental-run-flow.html b/api/experimental-run-flow.html index b3f465f42e..ab3ca4aec1 100644 --- a/api/experimental-run-flow.html +++ b/api/experimental-run-flow.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-all.html b/api/get-all.html index e0873fade2..1532d9847c 100644 --- a/api/get-all.html +++ b/api/get-all.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-api-keys-route.html b/api/get-api-keys-route.html index 8d299bb26a..bbaa5340df 100644 --- a/api/get-api-keys-route.html +++ b/api/get-api-keys-route.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-build-events.html b/api/get-build-events.html index de7805b60a..83b3c6750a 100644 --- a/api/get-build-events.html +++ b/api/get-build-events.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-components.html b/api/get-components.html index 614c1f4324..e11000016e 100644 --- a/api/get-components.html +++ b/api/get-components.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-config.html b/api/get-config.html index 7a20253d2f..2b91119cd6 100644 --- a/api/get-config.html +++ b/api/get-config.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-list-of-components-liked-by-user.html b/api/get-list-of-components-liked-by-user.html index 5cfe4213b9..2b27611239 100644 --- a/api/get-list-of-components-liked-by-user.html +++ b/api/get-list-of-components-liked-by-user.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-messages.html b/api/get-messages.html index 34a00308b5..36fe8374df 100644 --- a/api/get-messages.html +++ b/api/get-messages.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-starter-projects.html b/api/get-starter-projects.html index b24d597ef2..0f614ced5d 100644 --- a/api/get-starter-projects.html +++ b/api/get-starter-projects.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-tags.html b/api/get-tags.html index 3e90ce92c8..04b331085c 100644 --- a/api/get-tags.html +++ b/api/get-tags.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-task-status.html b/api/get-task-status.html index 749ba412aa..ba07c18ed2 100644 --- a/api/get-task-status.html +++ b/api/get-task-status.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-transactions.html b/api/get-transactions.html index ad48b4a746..91511981e5 100644 --- a/api/get-transactions.html +++ b/api/get-transactions.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-version.html b/api/get-version.html index d6214c7a19..10baa81618 100644 --- a/api/get-version.html +++ b/api/get-version.html @@ -22,7 +22,7 @@ - + diff --git a/api/get-vertex-builds.html b/api/get-vertex-builds.html index f94ec59c39..bb5b375809 100644 --- a/api/get-vertex-builds.html +++ b/api/get-vertex-builds.html @@ -22,7 +22,7 @@ - + diff --git a/api/handle-messages.html b/api/handle-messages.html index d9936dd8f8..47f3f838f2 100644 --- a/api/handle-messages.html +++ b/api/handle-messages.html @@ -22,7 +22,7 @@ - + diff --git a/api/handle-sse.html b/api/handle-sse.html index 26173a0eab..0ffe1ed0b2 100644 --- a/api/handle-sse.html +++ b/api/handle-sse.html @@ -22,7 +22,7 @@ - + diff --git a/api/health-check.html b/api/health-check.html index bf15967777..100b9bd090 100644 --- a/api/health-check.html +++ b/api/health-check.html @@ -22,7 +22,7 @@ - + diff --git a/api/health.html b/api/health.html index 39a78c959b..93de703460 100644 --- a/api/health.html +++ b/api/health.html @@ -22,7 +22,7 @@ - + diff --git a/api/like-component.html b/api/like-component.html index 3e54044e4d..025ba9ca4b 100644 --- a/api/like-component.html +++ b/api/like-component.html @@ -22,7 +22,7 @@ - + diff --git a/api/list-files-1.html b/api/list-files-1.html index 05edba4ed7..7492b8a254 100644 --- a/api/list-files-1.html +++ b/api/list-files-1.html @@ -22,7 +22,7 @@ - + diff --git a/api/list-files.html b/api/list-files.html index 7e455e5cbd..6f8746ea79 100644 --- a/api/list-files.html +++ b/api/list-files.html @@ -22,7 +22,7 @@ - + diff --git a/api/list-profile-pictures.html b/api/list-profile-pictures.html index 92ff7f30cf..a92e16664a 100644 --- a/api/list-profile-pictures.html +++ b/api/list-profile-pictures.html @@ -22,7 +22,7 @@ - + diff --git a/api/login-to-get-access-token.html b/api/login-to-get-access-token.html index 394f461474..f4767655b9 100644 --- a/api/login-to-get-access-token.html +++ b/api/login-to-get-access-token.html @@ -22,7 +22,7 @@ - + diff --git a/api/logout.html b/api/logout.html index 96484701de..17394000db 100644 --- a/api/logout.html +++ b/api/logout.html @@ -22,7 +22,7 @@ - + diff --git a/api/logs.html b/api/logs.html index b90a1becc4..8c893684eb 100644 --- a/api/logs.html +++ b/api/logs.html @@ -22,7 +22,7 @@ - + diff --git a/api/patch-user.html b/api/patch-user.html index 6c1eecbe5e..e8b62a5220 100644 --- a/api/patch-user.html +++ b/api/patch-user.html @@ -22,7 +22,7 @@ - + diff --git a/api/post-validate-code.html b/api/post-validate-code.html index 01f01bb858..c83144d3bd 100644 --- a/api/post-validate-code.html +++ b/api/post-validate-code.html @@ -22,7 +22,7 @@ - + diff --git a/api/post-validate-prompt.html b/api/post-validate-prompt.html index f5926420a4..c854f49c62 100644 --- a/api/post-validate-prompt.html +++ b/api/post-validate-prompt.html @@ -22,7 +22,7 @@ - + diff --git a/api/process-1.html b/api/process-1.html index 0a6af016bb..5fe389706a 100644 --- a/api/process-1.html +++ b/api/process-1.html @@ -22,7 +22,7 @@ - + diff --git a/api/process.html b/api/process.html index 607680bbef..1fe83f0c6f 100644 --- a/api/process.html +++ b/api/process.html @@ -22,7 +22,7 @@ - + diff --git a/api/read-all-users.html b/api/read-all-users.html index 111fa1ac2c..4f9ff8cd16 100644 --- a/api/read-all-users.html +++ b/api/read-all-users.html @@ -22,7 +22,7 @@ - + diff --git a/api/read-basic-examples.html b/api/read-basic-examples.html index 03e1962c35..3514878c9c 100644 --- a/api/read-basic-examples.html +++ b/api/read-basic-examples.html @@ -22,7 +22,7 @@ - + diff --git a/api/read-current-user.html b/api/read-current-user.html index 1b026ca4e4..bb7abb098e 100644 --- a/api/read-current-user.html +++ b/api/read-current-user.html @@ -22,7 +22,7 @@ - + diff --git a/api/read-flow.html b/api/read-flow.html index bc09ee5feb..1b4ff4cb73 100644 --- a/api/read-flow.html +++ b/api/read-flow.html @@ -22,7 +22,7 @@ - + diff --git a/api/read-flows.html b/api/read-flows.html index dd36725997..bc152aaa91 100644 --- a/api/read-flows.html +++ b/api/read-flows.html @@ -22,7 +22,7 @@ - + diff --git a/api/read-folder.html b/api/read-folder.html index a4890ff130..6fdd2f5e6f 100644 --- a/api/read-folder.html +++ b/api/read-folder.html @@ -22,7 +22,7 @@ - + diff --git a/api/read-folders.html b/api/read-folders.html index f3dc00e4d2..86ba771fa7 100644 --- a/api/read-folders.html +++ b/api/read-folders.html @@ -22,7 +22,7 @@ - + diff --git a/api/read-variables.html b/api/read-variables.html index 7864738381..31228b2291 100644 --- a/api/read-variables.html +++ b/api/read-variables.html @@ -22,7 +22,7 @@ - + diff --git a/api/refresh-token.html b/api/refresh-token.html index eb32c190d3..549de32a43 100644 --- a/api/refresh-token.html +++ b/api/refresh-token.html @@ -22,7 +22,7 @@ - + diff --git a/api/reset-password.html b/api/reset-password.html index 5f93a90e77..d8d48beedc 100644 --- a/api/reset-password.html +++ b/api/reset-password.html @@ -22,7 +22,7 @@ - + diff --git a/api/retrieve-vertices-order.html b/api/retrieve-vertices-order.html index fc65932500..a5c1dae5d5 100644 --- a/api/retrieve-vertices-order.html +++ b/api/retrieve-vertices-order.html @@ -22,7 +22,7 @@ - + diff --git a/api/save-store-api-key.html b/api/save-store-api-key.html index a469985c99..a9ea7644a3 100644 --- a/api/save-store-api-key.html +++ b/api/save-store-api-key.html @@ -22,7 +22,7 @@ - + diff --git a/api/share-component.html b/api/share-component.html index 35a33acc8d..bd6de60fec 100644 --- a/api/share-component.html +++ b/api/share-component.html @@ -22,7 +22,7 @@ - + diff --git a/api/simplified-run-flow.html b/api/simplified-run-flow.html index 3ccde5dc50..5a1729672a 100644 --- a/api/simplified-run-flow.html +++ b/api/simplified-run-flow.html @@ -22,7 +22,7 @@ - + diff --git a/api/stream-logs.html b/api/stream-logs.html index 772c784054..178de1d4bf 100644 --- a/api/stream-logs.html +++ b/api/stream-logs.html @@ -22,7 +22,7 @@ - + diff --git a/api/update-flow.html b/api/update-flow.html index b9b156f233..14dcb523cb 100644 --- a/api/update-flow.html +++ b/api/update-flow.html @@ -22,7 +22,7 @@ - + diff --git a/api/update-folder.html b/api/update-folder.html index 4492decfc4..2b375882c2 100644 --- a/api/update-folder.html +++ b/api/update-folder.html @@ -22,7 +22,7 @@ - + diff --git a/api/update-message.html b/api/update-message.html index 4eedf2f8ef..45dd34722e 100644 --- a/api/update-message.html +++ b/api/update-message.html @@ -22,7 +22,7 @@ - + diff --git a/api/update-session-id.html b/api/update-session-id.html index ab825909d0..f7761dca1b 100644 --- a/api/update-session-id.html +++ b/api/update-session-id.html @@ -22,7 +22,7 @@ - + diff --git a/api/update-shared-component.html b/api/update-shared-component.html index c5dfe816c5..7bd6afe1a3 100644 --- a/api/update-shared-component.html +++ b/api/update-shared-component.html @@ -22,7 +22,7 @@ - + diff --git a/api/update-variable.html b/api/update-variable.html index cdd9d82f41..359743cfe0 100644 --- a/api/update-variable.html +++ b/api/update-variable.html @@ -22,7 +22,7 @@ - + diff --git a/api/upload-file-1.html b/api/upload-file-1.html index 8f1e39d88a..da2a30b078 100644 --- a/api/upload-file-1.html +++ b/api/upload-file-1.html @@ -22,7 +22,7 @@ - + diff --git a/api/upload-file-2.html b/api/upload-file-2.html index c56747f26f..ea2fe8f860 100644 --- a/api/upload-file-2.html +++ b/api/upload-file-2.html @@ -22,7 +22,7 @@ - + diff --git a/api/upload-file.html b/api/upload-file.html index 039427ba9d..68eb025fa7 100644 --- a/api/upload-file.html +++ b/api/upload-file.html @@ -22,7 +22,7 @@ - + diff --git a/api/upload-user-file.html b/api/upload-user-file.html index 5273947c88..0eac485aef 100644 --- a/api/upload-user-file.html +++ b/api/upload-user-file.html @@ -22,7 +22,7 @@ - + diff --git a/api/webhook-run-flow.html b/api/webhook-run-flow.html index caa22e1977..48c5f3f9c8 100644 --- a/api/webhook-run-flow.html +++ b/api/webhook-run-flow.html @@ -22,7 +22,7 @@ - + diff --git a/assets/js/2ab0d4f5.46105678.js b/assets/js/2ab0d4f5.46105678.js new file mode 100644 index 0000000000..08f6c0f64d --- /dev/null +++ b/assets/js/2ab0d4f5.46105678.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[1845],{28453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var i=t(96540);const s={},r=i.createContext(s);function a(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(r.Provider,{value:n},e.children)}},83640:(e,n,t)=>{t.r(n),t.d(n,{contentTitle:()=>o,default:()=>c,frontMatter:()=>a,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"type":"api","id":"simplified-run-flow","title":"Simplified Run Flow","description":"","slug":"/simplified-run-flow","frontMatter":{},"api":{"tags":["Base"],"description":"Executes a specified flow by ID with support for streaming and telemetry.\\n\\nThis endpoint executes a flow identified by ID or name, with options for streaming the response\\nand tracking execution metrics. It handles both streaming and non-streaming execution modes.\\n\\nArgs:\\n background_tasks (BackgroundTasks): FastAPI background task manager\\n flow (FlowRead | None): The flow to execute, loaded via dependency\\n input_request (SimplifiedAPIRequest | None): Input parameters for the flow\\n stream (bool): Whether to stream the response\\n api_key_user (UserRead): Authenticated user from API key\\n request (Request): The incoming HTTP request\\n\\nReturns:\\n Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results\\n or a RunResponse with the complete execution results\\n\\nRaises:\\n HTTPException: For flow not found (404) or invalid input (400)\\n APIException: For internal execution errors (500)\\n\\nNotes:\\n - Supports both streaming and non-streaming execution modes\\n - Tracks execution time and success/failure via telemetry\\n - Handles graceful client disconnection in streaming mode\\n - Provides detailed error handling with appropriate HTTP status codes\\n - In streaming mode, uses EventManager to handle events:\\n - \\"add_message\\": New messages during execution\\n - \\"token\\": Individual tokens during streaming\\n - \\"end\\": Final execution result","operationId":"simplified_run_flow_api_v1_run__flow_id_or_name__post","security":[{"API key query":[]},{"API key header":[]}],"parameters":[{"name":"flow_id_or_name","in":"path","required":true,"schema":{"type":"string","title":"Flow Id Or Name"}},{"name":"stream","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Stream"}},{"name":"user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"input_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Value","description":"The input value"},"input_type":{"anyOf":[{"type":"string","enum":["chat","text","any"]},{"type":"null"}],"title":"Input Type","description":"The input type","default":"chat"},"output_type":{"anyOf":[{"type":"string","enum":["chat","text","any","debug"]},{"type":"null"}],"title":"Output Type","description":"The output type","default":"chat"},"output_component":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output Component","description":"If there are multiple output components, you can specify the component to get the output from.","default":""},"tweaks":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"object"}]},"type":"object","title":"Tweaks","description":"A dictionary of tweaks to adjust the flow\'s execution. Allows customizing flow behavior dynamically. All tweaks are overridden by the input values.","examples":[{"Component Name":{"parameter_name":"value"},"component_id":{"parameter_name":"value"},"parameter_name":"value"}]},{"type":"null"}],"description":"The tweaks"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id","description":"The session id"}},"type":"object","title":"SimplifiedAPIRequest"},{"type":"null"}],"title":"Input Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}},"method":"post","path":"/api/v1/run/{flow_id_or_name}","securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"api/v1/login"}}},"API key query":{"type":"apiKey","in":"query","name":"x-api-key"},"API key header":{"type":"apiKey","in":"header","name":"x-api-key"}},"info":{"title":"Langflow","version":"1.2.0"},"postman":{"name":"Simplified Run Flow","description":{"content":"Executes a specified flow by ID with support for streaming and telemetry.\\n\\nThis endpoint executes a flow identified by ID or name, with options for streaming the response\\nand tracking execution metrics. It handles both streaming and non-streaming execution modes.\\n\\nArgs:\\n background_tasks (BackgroundTasks): FastAPI background task manager\\n flow (FlowRead | None): The flow to execute, loaded via dependency\\n input_request (SimplifiedAPIRequest | None): Input parameters for the flow\\n stream (bool): Whether to stream the response\\n api_key_user (UserRead): Authenticated user from API key\\n request (Request): The incoming HTTP request\\n\\nReturns:\\n Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results\\n or a RunResponse with the complete execution results\\n\\nRaises:\\n HTTPException: For flow not found (404) or invalid input (400)\\n APIException: For internal execution errors (500)\\n\\nNotes:\\n - Supports both streaming and non-streaming execution modes\\n - Tracks execution time and success/failure via telemetry\\n - Handles graceful client disconnection in streaming mode\\n - Provides detailed error handling with appropriate HTTP status codes\\n - In streaming mode, uses EventManager to handle events:\\n - \\"add_message\\": New messages during execution\\n - \\"token\\": Individual tokens during streaming\\n - \\"end\\": Final execution result","type":"text/plain"},"url":{"path":["api","v1","run",":flow_id_or_name"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"stream","value":"false"},{"disabled":false,"key":"user_id","value":"| Name | Type | Description |
|---|---|---|
| mongodb_atlas_cluster_uri | SecretString | MongoDB Atlas Cluster URI |
| db_name | String | Database name |
| collection_name | String | Collection name |
| index_name | String | Index name |
| search_query | String | Query for similarity search |
| ingest_data | Data | Data to be ingested into the vector store |
| embedding | Embeddings | Embedding function to use |
| number_of_results | Integer | Number of results to return in search |
| Name | Type | Description |
|---|---|---|
| mongodb_atlas_cluster_uri | SecretString | The connection URI for your MongoDB Atlas cluster (required) |
| enable_mtls | Boolean | Enable mutual TLS authentication (default: false) |
| mongodb_atlas_client_cert | SecretString | Client certificate combined with private key for mTLS authentication (required if mTLS is enabled) |
| db_name | String | The name of the database to use (required) |
| collection_name | String | The name of the collection to use (required) |
| index_name | String | The name of the Atlas Search index, it should be a Vector Search (required) |
| insert_mode | String | How to insert new documents into the collection (options: "append", "overwrite", default: "append") |
| embedding | Embeddings | The embedding model to use |
| number_of_results | Integer | Number of results to return in similarity search (default: 4) |
| index_field | String | The field to index (default: "embedding") |
| filter_field | String | The field to filter the index |
| number_dimensions | Integer | Embedding context length (default: 1536) |
| similarity | String | The method used to measure similarity between vectors (options: "cosine", "euclidean", "dotProduct", default: "cosine") |
| quantization | String | Quantization reduces memory costs by converting 32-bit floats to smaller data types (options: "scalar", "binary") |
| Name | Type | Description |
|---|---|---|
| vector_store | MongoDBAtlasVectorSearch | MongoDB Atlas vector store instance |
| search_results | List[Data] | Results of similarity search |