mirror of
https://github.com/langflow-ai/langflow.git
synced 2026-07-24 00:39:35 +08:00
373 lines
95 KiB
HTML
373 lines
95 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-1.9.0 docs-doc-page docs-doc-id-API-Reference/api-build" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">Build endpoints | Langflow Documentation</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.langflow.org/api-build"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="1.9.0"><meta data-rh="true" name="docusaurus_tag" content="docs-default-1.9.0"><meta data-rh="true" name="docsearch:version" content="1.9.0"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-1.9.0"><meta data-rh="true" property="og:title" content="Build endpoints | Langflow Documentation"><meta data-rh="true" name="description" content="The /build endpoints are used by Langflow's frontend visual editor code."><meta data-rh="true" property="og:description" content="The /build endpoints are used by Langflow's frontend visual editor code."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.langflow.org/api-build"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/api-build" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/api-build" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://UZK6BDPCVY-dsn.algolia.net" crossorigin="anonymous"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Build endpoints","item":"https://docs.langflow.org/api-build"}]}</script><link rel="preconnect" href="https://www.google-analytics.com">
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script async src="https://www.googletagmanager.com/gtag/js?id=G-SLQFLQ3KPT"></script>
|
||
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-SLQFLQ3KPT",{})</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="search" type="application/opensearchdescription+xml" title="Langflow Documentation" href="/opensearch.xml">
|
||
|
||
|
||
|
||
|
||
<script>window._ibmAnalytics={settings:{name:"DataStax",tealiumProfileName:"ibm-subsidiary"},trustarc:{privacyPolicyLink:"https://ibm.com/privacy"},"digitalData.page.services.google.enabled":!0},window.digitalData={page:{pageInfo:{ibm:{siteId:"IBM_"+_ibmAnalytics.settings.name},segment:{enabled:!0,env:"prod",key:"B04fNhD06DqDPuaRfQl5lZ2iQICdxxuh",coremetrics:!1,carbonComponentEvents:!1}},category:{primaryCategory:"PC230"}},commonProperties:{productTitle:"IBM Elite Support for Langflow",productCode:"5900BUB",productCodeType:"WWPC",UT30:"30AS5",instanceId:"docs-site",subscriptionId:"public-access",productPlanName:"Public",productPlanType:"freemium",userId:"IBMid-ANONYMOUS"}}</script>
|
||
<script src="//1.www.s81c.com/common/stats/ibm-common.js" async="true"></script>
|
||
|
||
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Geist:wght@300;400;500;600;700&family=Geist+Mono:wght@400;500&family=Sora:wght@550;600&display=swap">
|
||
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("consent","default",{ad_storage:"denied",ad_user_data:"denied",ad_personalization:"denied",analytics_storage:"denied"})</script>
|
||
<script>!function(){function e(){if(void 0!==window.truste&&window.truste.cma){var e=window.truste.cma.callApi("getConsent",window.location.href)||{},n=1===e[2],t=1===e[3];gtag("consent","update",{ad_storage:n?"granted":"denied",ad_user_data:n?"granted":"denied",ad_personalization:n?"granted":"denied",analytics_storage:t?"granted":"denied"})}}window.addEventListener&&(window.addEventListener("cm_data_subject_consent_changed",e),window.addEventListener("cm_consent_preferences_set",e)),"complete"===document.readyState?e():window.addEventListener("load",e)}()</script><link rel="stylesheet" href="/assets/css/styles.d29a2eb4.css">
|
||
<script src="/assets/js/runtime~main.6cbdbac2.js" defer="defer"></script>
|
||
<script src="/assets/js/main.18ca0898.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/lf-docs-light.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/lf-docs-dark.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a aria-current="page" class="navbar__link active" aria-haspopup="true" aria-expanded="false" role="button" href="/api-build">1.9.x</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/next/api-build">1.10.x (Next)</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/api-build">1.9.x</a></li><li><a class="dropdown__link" href="/1.8.0/api-build">1.8.x</a></li></ul></div></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/langflow-ai/langflow" target="_blank" class="navbar__item navbar__link header-github-link" aria-label="GitHub" data-event="UI Interaction" data-action="clicked" data-channel="docs" data-element-id="social-github" data-namespace="header" data-platform-title="Langflow"></a><a href="https://twitter.com/langflow_ai" target="_blank" class="navbar__item navbar__link header-twitter-link" aria-label="Twitter" data-event="UI Interaction" data-action="clicked" data-channel="docs" data-element-id="social-twitter" data-namespace="header" data-platform-title="Langflow"></a><a href="https://discord.gg/EqksyE2EX9" target="_blank" class="navbar__item navbar__link header-discord-link" aria-label="Discord" data-event="UI Interaction" data-action="clicked" data-channel="docs" data-element-id="social-discord" data-namespace="header" data-platform-title="Langflow"></a><div class="toggle_MW0i colorModeToggle_DEke"><button class="clean-btn toggleButton_yw5v toggleButtonDisabled_BJd7" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" focusable="false" role="presentation" class="toggleIcon_oIOL lightToggleIcon_SFTY"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" focusable="false" role="presentation" class="toggleIcon_oIOL darkToggleIcon_ekgs"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" focusable="false" role="presentation" class="toggleIcon_oIOL systemToggleIcon_yi_a"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Meta+k)" aria-keyshortcuts="Meta+k"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 24 24" aria-hidden="true"><circle cx="11" cy="11" r="8" stroke="currentColor" fill="none" stroke-width="1.4"></circle><path d="m21 21-4.3-4.3" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside aria-label="Documentation sidebar" class="theme-doc-sidebar-container docSidebarContainer_RSuS"><div class="sidebarViewport_pYEE"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 sidebar-group-divider"><div class="sidebar-group-label">Build</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed sidebar-category-with-icon sidebar-icon-rocket"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/"><span title="Get started" class="categoryLinkLabel_W154">Get started</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed sidebar-category-with-icon sidebar-icon-workflow"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/concepts-overview"><span title="Flows" class="categoryLinkLabel_W154">Flows</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed sidebar-category-with-icon sidebar-icon-bot"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/agents"><span title="Agents" class="categoryLinkLabel_W154">Agents</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed sidebar-category-with-icon sidebar-icon-plug"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/mcp-client"><span title="Model Context Protocol (MCP)" class="categoryLinkLabel_W154">Model Context Protocol (MCP)</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 sidebar-group-divider"><div class="sidebar-group-label">Develop & Deploy</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed sidebar-category-with-icon sidebar-icon-code"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/api-keys-and-authentication"><span title="Develop" class="categoryLinkLabel_W154">Develop</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed sidebar-category-with-icon sidebar-icon-cloud"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/deployment-overview"><span title="Deploy" class="categoryLinkLabel_W154">Deploy</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 sidebar-group-divider"><div class="sidebar-group-label">Reference</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed sidebar-category-with-icon sidebar-icon-blocks"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/concepts-components"><span title="Components reference" class="categoryLinkLabel_W154">Components reference</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item sidebar-category-with-icon sidebar-icon-fileCode"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/api-reference-api-examples"><span title="API reference" class="categoryLinkLabel_W154">API reference</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api-reference-api-examples"><span title="Get started with the Langflow API" class="linkLabel_WmDU">Get started with the Langflow API</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/typescript-client"><span title="Use the TypeScript client" class="linkLabel_WmDU">Use the TypeScript client</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/flow-devops-sdk"><span title="Flow DevOps Toolkit SDK" class="linkLabel_WmDU">Flow DevOps Toolkit SDK</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api-flows-run"><span title="Flow trigger endpoints" class="linkLabel_WmDU">Flow trigger endpoints</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/workflow-api"><span title="Developer API (Beta)" class="categoryLinkLabel_W154">Developer API (Beta)</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api-openai-responses"><span title="OpenAI Responses API" class="linkLabel_WmDU">OpenAI Responses API</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api-flows"><span title="Flow management endpoints" class="linkLabel_WmDU">Flow management endpoints</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api-files"><span title="Files endpoints" class="linkLabel_WmDU">Files endpoints</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api-projects"><span title="Projects endpoints" class="linkLabel_WmDU">Projects endpoints</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api-logs"><span title="Logs endpoints" class="linkLabel_WmDU">Logs endpoints</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api-monitor"><span title="Monitor endpoints" class="linkLabel_WmDU">Monitor endpoints</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/api-build"><span title="Build endpoints" class="linkLabel_WmDU">Build endpoints</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api-users"><span title="Users endpoints" class="linkLabel_WmDU">Users endpoints</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/api"><span title="Langflow API specification" class="linkLabel_WmDU">Langflow API specification</span></a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 sidebar-group-divider"><div class="sidebar-group-label">Community</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed sidebar-category-with-icon sidebar-icon-gitPR"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/contributing-community"><span title="Contribute" class="categoryLinkLabel_W154">Contribute</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed sidebar-category-with-icon sidebar-icon-helpCircle"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/troubleshoot"><span title="Support" class="categoryLinkLabel_W154">Support</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 sidebar-ad">
|
||
<a href="https://www.langflow.org/desktop" target="_blank" rel="noopener noreferrer" class="menu__link">
|
||
<svg width="18" height="18" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true">
|
||
<g clip-path="url(#clip0_1645_37)">
|
||
<path d="M12 17H20C21.1046 17 22 16.1046 22 15V13M12 17H4C2.89543 17 2 16.1046 2 15V5C2 3.89543 2.89543 3 4 3H10M12 17V21M8 21H12M12 21H16M11.75 10.2917H13.2083L16.125 7.375H17.5833L20.5 4.45833H21.9583M16.125 11.75H17.5833L20.5 8.83333H21.9583M11.75 5.91667H13.2083L16.125 3H17.5833" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/>
|
||
</g>
|
||
<defs>
|
||
<clipPath id="clip0_1645_37">
|
||
<rect width="24" height="24" fill="white"/>
|
||
</clipPath>
|
||
</defs>
|
||
</svg>
|
||
<div class="sidebar-ad-text-container">
|
||
<span class="sidebar-ad-text">Get started in minutes</span>
|
||
<span class="sidebar-ad-text sidebar-ad-text-gradient">Download Langflow Desktop</span>
|
||
</div>
|
||
</a>
|
||
</li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_z5aJ"><div class="docItemContainer_c0TR"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false" role="presentation" class="breadcrumbHomeIcon_xK9p"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">API reference</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Build endpoints</span></li></ul></nav><div class="docMetaRow_c2hx"><div class="root_Eutc"><button type="button" class="button_gpNY"><span aria-hidden="true" class="icon_Bm9L"><svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-copy"><rect width="14" height="14" x="8" y="8" rx="2" ry="2"></rect><path d="M4 16c-1.1 0-2-.9-2-2V4c0-1.1.9-2 2-2h10c1.1 0 2 .9 2 2"></path></svg></span><span class="label_LzDG">Copy page</span></button></div><span class="theme-doc-version-badge badge badge--secondary">Version: 1.9.x</span></div><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Build endpoints</h1></header><div class="theme-admonition theme-admonition-info admonition_xJq3 alert alert--info"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>info</div><div class="admonitionContent_BuS1"><p>The <code>/build</code> endpoints are used by Langflow's frontend visual editor code.
|
||
These endpoints are part of the internal Langflow codebase.</p><p>Don't use these endpoints to run flows in applications that use your Langflow flows.
|
||
To run flows in your apps, see <a class="" href="/api-flows-run">Flow trigger endpoints</a>.</p></div></div>
|
||
<p>The <code>/build</code> endpoints support Langflow's frontend code for building flows in the Langflow visual editor.
|
||
You can use these endpoints to build vertices and flows, as well as execute flows with streaming event responses.
|
||
You might need to use or understand these endpoints when contributing to the Langflow codebase.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="build-flow-and-stream-events">Build flow and stream events<a href="#build-flow-and-stream-events" class="hash-link" aria-label="Direct link to Build flow and stream events" title="Direct link to Build flow and stream events" translate="no"></a></h2>
|
||
<p>This endpoint builds and executes a flow, returning a job ID that can be used to stream execution events.</p>
|
||
<ol>
|
||
<li class="">
|
||
<p>Send a POST request to the <code>/build/$FLOW_ID/flow</code> endpoint:</p>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Python</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">JavaScript</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">curl</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="python" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>import os<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>import requests<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span>url = f"{os.getenv('LANGFLOW_URL', '')}/api/v1/build/{os.getenv('FLOW_ID', '')}/flow"<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span>headers = {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span> "accept": "application/json",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span> "Content-Type": "application/json",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span> "x-api-key": f"{os.getenv('LANGFLOW_API_KEY', '')}",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span>}<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">12</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">13</span>payload = {"inputs": {"input_value": "Tell me a story"}}<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">14</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">15</span>response = requests.request("POST", url, headers=headers, json=payload)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">16</span>response.raise_for_status()<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">17</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">18</span>print(response.text)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">19</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="javascript" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/build/${process.env.FLOW_ID ?? ""}/flow`;<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>const options = {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span> method: 'POST',<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span> headers: {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span> "accept": `application/json`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span> "Content-Type": `application/json`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span> "x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span> },<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span> body: JSON.stringify({<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span> "inputs": {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">12</span> "input_value": "Tell me a story"<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">13</span> }<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">14</span>}),<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">15</span>};<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">16</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">17</span>fetch(url, options)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">18</span> .then(async (response) => {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">19</span> if (!response.ok) {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">20</span> throw new Error(`HTTP ${response.status}`);<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">21</span> }<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">22</span> const text = await response.text();<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">23</span> console.log(text);<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">24</span> })<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">25</span> .catch((error) => console.error(error));<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">26</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="bash" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>curl -X POST \<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span> "$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span> -H "accept: application/json" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span> -H "Content-Type: application/json" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span> -H "x-api-key: $LANGFLOW_API_KEY" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span> -d '{<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span> "inputs": {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span> "input_value": "Tell me a story"<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span> }<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span> }'<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div></div></div>
|
||
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Result</summary><div><div class="collapsibleContent_i85q"><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="json" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>{<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span> "job_id": "123e4567-e89b-12d3-a456-426614174000"<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>}<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div></div></details>
|
||
</li>
|
||
<li class="">
|
||
<p>After receiving a job ID from the build endpoint, use the <code>/build/$JOB_ID/events</code> endpoint to stream the execution results:</p>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Python</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">JavaScript</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">curl</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="python" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>import os<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>import requests<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span>url = f"{os.getenv('LANGFLOW_URL', '')}/api/v1/build/{os.getenv('JOB_ID', '')}/events"<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span>headers = {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span> "accept": "application/json",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span> "x-api-key": f"{os.getenv('LANGFLOW_API_KEY', '')}",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span>}<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">12</span>response = requests.request("GET", url, headers=headers)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">13</span>response.raise_for_status()<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">14</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">15</span>print(response.text)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">16</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="javascript" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events`;<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>const options = {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span> method: 'GET',<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span> headers: {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span> "accept": `application/json`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span> "x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span> },<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span>};<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span>fetch(url, options)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">12</span> .then(async (response) => {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">13</span> if (!response.ok) {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">14</span> throw new Error(`HTTP ${response.status}`);<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">15</span> }<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">16</span> const text = await response.text();<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">17</span> console.log(text);<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">18</span> })<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">19</span> .catch((error) => console.error(error));<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">20</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="bash" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>curl -X GET \<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span> "$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span> -H "accept: application/json" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span> -H "x-api-key: $LANGFLOW_API_KEY"<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div></div></div>
|
||
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Result</summary><div><div class="collapsibleContent_i85q"><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="json" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>{"event": "vertices_sorted", "data": {"ids": ["ChatInput-XtBLx"], "to_run": ["Prompt-x74Ze", "ChatOutput-ylMzN", "ChatInput-XtBLx", "OpenAIModel-d1wOZ"]}}<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>{"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"}}<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span>
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span>// ... Additional events as the flow executes ...<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span>
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span>{"event": "end", "data": {}}<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div></div></details>
|
||
</li>
|
||
</ol>
|
||
<p>The <code>/build/$FLOW_ID/events</code> endpoint has a <code>stream</code> query parameter that defaults to <code>true</code>.
|
||
To disable streaming and get all events at once, set <code>?stream=false</code>.</p>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Python</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">JavaScript</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">curl</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="python" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>import os<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>import requests<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span>base = os.environ.get("LANGFLOW_URL") or os.environ.get("LANGFLOW_SERVER_URL", "")<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span>job_id = os.environ.get("JOB_ID", "")<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span>api_key = os.environ.get("LANGFLOW_API_KEY", "")<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span># Use the API's `event_delivery` query param to avoid keeping a streaming connection open.<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span># For local smoke tests, polling returns a finite JSON response.<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span>url = f"{base}/api/v1/build/{job_id}/events?event_delivery=polling"<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">12</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">13</span>headers = {"accept": "application/json", "x-api-key": api_key}<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">14</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">15</span>response = requests.get(url, headers=headers, timeout=60)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">16</span>response.raise_for_status()<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">17</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">18</span>print(response.text)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">19</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="javascript" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events?stream=false`;<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>const options = {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span> method: 'GET',<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span> headers: {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span> "accept": `application/json`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span> "x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span> },<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span>};<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span>fetch(url, options)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">12</span> .then(async (response) => {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">13</span> if (!response.ok) {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">14</span> throw new Error(`HTTP ${response.status}`);<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">15</span> }<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">16</span> const text = await response.text();<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">17</span> console.log(text);<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">18</span> })<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">19</span> .catch((error) => console.error(error));<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">20</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="bash" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>curl -X GET \<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span> "$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events?stream=false" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span> -H "accept: application/json" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span> -H "x-api-key: $LANGFLOW_API_KEY"<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="build-headers">Build headers<a href="#build-headers" class="hash-link" aria-label="Direct link to Build headers" title="Direct link to Build headers" translate="no"></a></h2>
|
||
<table><thead><tr><th>Header</th><th>Info</th><th>Example</th></tr></thead><tbody><tr><td>Content-Type</td><td>Required. Specifies the JSON format.</td><td>"application/json"</td></tr><tr><td>accept</td><td>Optional. Specifies the response format.</td><td>"application/json"</td></tr><tr><td>x-api-key</td><td>Optional. Required only if authentication is enabled.</td><td>"sk-..."</td></tr></tbody></table>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="build-parameters">Build parameters<a href="#build-parameters" class="hash-link" aria-label="Direct link to Build parameters" title="Direct link to Build parameters" translate="no"></a></h2>
|
||
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>inputs</td><td>object</td><td>Optional. Input values for flow components.</td></tr><tr><td>data</td><td>object</td><td>Optional. Flow data to override stored configuration.</td></tr><tr><td>files</td><td>array[string]</td><td>Optional. List of file paths to use.</td></tr><tr><td>start_component_id</td><td>string</td><td>Optional. ID of the component where the execution should start. Component <code>id</code> values can be found in <a class="" href="/concepts-flows-import#langflow-json-file-contents">Langflow JSON files</a></td></tr><tr><td>stop_component_id</td><td>string</td><td>Optional. ID of the component where the execution should stop. Component <code>id</code> values can be found in <a class="" href="/concepts-flows-import#langflow-json-file-contents">Langflow JSON files</a>.</td></tr><tr><td>log_builds</td><td>Boolean</td><td>Whether to record build logs. Default: Enabled (<code>true</code>).</td></tr></tbody></table>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="set-start-and-stop-points">Set start and stop points<a href="#set-start-and-stop-points" class="hash-link" aria-label="Direct link to Set start and stop points" title="Direct link to Set start and stop points" translate="no"></a></h3>
|
||
<p>The <code>/build</code> endpoint accepts optional values for <code>start_component_id</code> and <code>stop_component_id</code> to control where the flow run starts and stops.
|
||
Setting <code>stop_component_id</code> for a component triggers the same behavior as clicking <strong>Run component</strong> on that component in the visual editor: The specified component and all dependent components leading up to that component will run.</p>
|
||
<p>The following example stops flow execution at an <strong>OpenAI</strong> component:</p>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Python</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">JavaScript</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">curl</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="python" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>import os<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>import requests<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span>url = f"{os.getenv('LANGFLOW_URL', '')}/api/v1/build/{os.getenv('FLOW_ID', '')}/flow"<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span>headers = {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span> "accept": "application/json",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span> "Content-Type": "application/json",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span> "x-api-key": f"{os.getenv('LANGFLOW_API_KEY', '')}",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span>}<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">12</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">13</span>payload = {"stop_component_id": "OpenAIModel-Uksag"}<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">14</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">15</span>response = requests.request("POST", url, headers=headers, json=payload)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">16</span>response.raise_for_status()<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">17</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">18</span>print(response.text)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">19</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="javascript" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/build/${process.env.FLOW_ID ?? ""}/flow`;<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>const options = {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span> method: 'POST',<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span> headers: {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span> "accept": `application/json`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span> "Content-Type": `application/json`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span> "x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span> },<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span> body: JSON.stringify({<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span> "stop_component_id": "OpenAIModel-Uksag"<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">12</span>}),<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">13</span>};<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">14</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">15</span>fetch(url, options)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">16</span> .then(async (response) => {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">17</span> if (!response.ok) {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">18</span> throw new Error(`HTTP ${response.status}`);<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">19</span> }<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">20</span> const text = await response.text();<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">21</span> console.log(text);<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">22</span> })<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">23</span> .catch((error) => console.error(error));<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">24</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="bash" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>curl -X POST \<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span> "$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span> -H "accept: application/json" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span> -H "Content-Type: application/json" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span> -H "x-api-key: $LANGFLOW_API_KEY" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span> -d '{"stop_component_id": "OpenAIModel-Uksag"}'<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div></div></div>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="override-flow-parameters">Override flow parameters<a href="#override-flow-parameters" class="hash-link" aria-label="Direct link to Override flow parameters" title="Direct link to Override flow parameters" translate="no"></a></h3>
|
||
<p>The <code>/build</code> endpoint also accepts inputs for <code>data</code> directly, instead of using the values stored in the Langflow database.
|
||
This is useful for running flows without having to pass custom values through the visual editor.</p>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Python</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">JavaScript</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">curl</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="python" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>import os<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>import requests<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span>url = f"{os.getenv('LANGFLOW_URL', '')}/api/v1/build/{os.getenv('FLOW_ID', '')}/flow"<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span>headers = {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span> "accept": "application/json",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span> "Content-Type": "application/json",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span> "x-api-key": f"{os.getenv('LANGFLOW_API_KEY', '')}",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span>}<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">12</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">13</span>payload = {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">14</span> "data": {"nodes": [], "edges": []},<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">15</span> "inputs": {"input_value": "Your custom input here", "session": "session_id"},<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">16</span>}<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">17</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">18</span>response = requests.request("POST", url, headers=headers, json=payload)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">19</span>response.raise_for_status()<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">20</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">21</span>print(response.text)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">22</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="javascript" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>const url = `${process.env.LANGFLOW_URL ?? ""}/api/v1/build/${process.env.FLOW_ID ?? ""}/flow`;<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span>const options = {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span> method: 'POST',<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span> headers: {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span> "accept": `application/json`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span> "Content-Type": `application/json`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span> "x-api-key": `${process.env.LANGFLOW_API_KEY ?? ""}`,<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span> },<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span> body: JSON.stringify({<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span> "data": {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">12</span> "nodes": [],<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">13</span> "edges": []<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">14</span> },<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">15</span> "inputs": {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">16</span> "input_value": "Your custom input here",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">17</span> "session": "session_id"<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">18</span> }<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">19</span>}),<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">20</span>};<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">21</span>
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">22</span>fetch(url, options)<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">23</span> .then(async (response) => {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">24</span> if (!response.ok) {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">25</span> throw new Error(`HTTP ${response.status}`);<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">26</span> }<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">27</span> const text = await response.text();<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">28</span> console.log(text);<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">29</span> })<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">30</span> .catch((error) => console.error(error));<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">31</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="bash" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>curl -X POST \<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span> "$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">3</span> -H "accept: application/json" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">4</span> -H "Content-Type: application/json" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">5</span> -H "x-api-key: $LANGFLOW_API_KEY" \<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">6</span> -d '{<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">7</span> "data": {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">8</span> "nodes": [],<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">9</span> "edges": []<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">10</span> },<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">11</span> "inputs": {<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">12</span> "input_value": "Your custom input here",<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">13</span> "session": "session_id"<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">14</span> }<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">15</span> }'<!-- -->
|
||
<span class="ch-code-line-number" style="width:2ch;margin-right:1.5ch;display:inline-block;text-align:right">16</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div></div></div>
|
||
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Result</summary><div><div class="collapsibleContent_i85q"><div class="ch-codeblock" style="margin-top:1.25em;margin-bottom:1.25em;border-radius:6px;overflow:hidden;box-shadow:0 13px 27px -5px rgba(50,50,93,0.25), 0 8px 16px -8px rgba(0,0,0,0.3);--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><div class="ch-code-wrapper" data-ch-measured="true" style="--ch-t-background:#0d1117;--ch-t-foreground:#c9d1d9;--ch-t-colorScheme:dark;--ch-t-editorLineNumber-foreground:#8b949e;--ch-t-editor-selectionBackground:#264f78"><code class="ch-code-scroll-parent" data-ch-lang="json" style="display:block;padding:1rem"><span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">1</span>{ "job_id": "0bcc7f23-40b4-4bfa-9b8a-a44181fd1175" }<!-- -->
|
||
<span class="ch-code-line-number" style="width:1ch;margin-right:1.5ch;display:inline-block;text-align:right">2</span>
|
||
</code><button type="button" title="Copy code" class="ch-code-button"><svg fill="none" stroke="currentColor" viewBox="0 0 24 24" width="1.1em" height="1.1em"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.6" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg></button></div></div></div></div></details>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="see-also">See also<a href="#see-also" class="hash-link" aria-label="Direct link to See also" title="Direct link to See also" translate="no"></a></h2>
|
||
<ul>
|
||
<li class=""><a class="" href="/api-monitor#get-vertex-builds">Get Vertex builds</a></li>
|
||
<li class=""><a class="" href="/api-monitor#delete-vertex-builds">Delete Vertex builds</a></li>
|
||
<li class=""><a class="" href="/session-id">Session ID</a></li>
|
||
</ul></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api-monitor"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Monitor endpoints</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api-users"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Users endpoints</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#build-flow-and-stream-events" class="table-of-contents__link toc-highlight">Build flow and stream events</a></li><li><a href="#build-headers" class="table-of-contents__link toc-highlight">Build headers</a></li><li><a href="#build-parameters" class="table-of-contents__link toc-highlight">Build parameters</a><ul><li><a href="#set-start-and-stop-points" class="table-of-contents__link toc-highlight">Set start and stop points</a></li><li><a href="#override-flow-parameters" class="table-of-contents__link toc-highlight">Override flow parameters</a></li></ul></li><li><a href="#see-also" class="table-of-contents__link toc-highlight">See also</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
|
||
<span>© 2026 Langflow</span>
|
||
<span id="preferenceCenterContainer"> · <a href="#" onclick='return"undefined"!=typeof window&&window.truste&&window.truste.eu&&window.truste.eu.clickListener&&window.truste.eu.clickListener(),!1' style="cursor: pointer;">Manage Privacy Choices</a></span>
|
||
</div></li></ul></div></div></div></footer><div style="position:fixed;right:21px;bottom:21px;z-index:100;display:flex;align-items:center;gap:10px;cursor:pointer"><div style="background-color:#f6f6f6;border-radius:50%;width:48px;height:48px;display:flex;align-items:center;justify-content:center;box-shadow:0 2px 4px rgba(0,0,0,0.1)"><img src="/img/langflow-icon-black-transparent.svg" style="width:40px" alt="Search"></div></div></div>
|
||
</body>
|
||
</html> |