mirror of
https://github.com/langflow-ai/langflow.git
synced 2026-07-24 07:34:10 +08:00
158 lines
68 KiB
HTML
158 lines
68 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-API-Reference/typescript-client" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.8.1">
|
||
<title data-rh="true">Langflow TypeScript client | 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/typescript-client"><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="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Langflow TypeScript client | Langflow Documentation"><meta data-rh="true" name="description" content="The Langflow TypeScript client allows your TypeScript applications to programmatically interact with the Langflow API."><meta data-rh="true" property="og:description" content="The Langflow TypeScript client allows your TypeScript applications to programmatically interact with the Langflow API."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.langflow.org/typescript-client"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/typescript-client" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/typescript-client" 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":"Use the TypeScript client","item":"https://docs.langflow.org/typescript-client"}]}</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=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.5b49702d.css">
|
||
<script src="/assets/js/runtime~main.f495a36a.js" defer="defer"></script>
|
||
<script src="/assets/js/main.a09de144.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg xmlns="http://www.w3.org/2000/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 navbarHideable_m1mJ"><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><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" 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" 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" 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_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" 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" class="toggleIcon_g3eP lightToggleIcon_pyhR"><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" class="toggleIcon_g3eP darkToggleIcon_wfgR"><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" class="toggleIcon_g3eP systemToggleIcon_QzmC"><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 (Command+K)"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" 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 class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd sidebarWithHideableNavbar_wUlq"><a tabindex="-1" class="sidebarLogo_isFc" href="/"><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"></a><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-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/">Get started</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/concepts-overview">Flows</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/agents">Agents</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/mcp-client">Model Context Protocol (MCP)</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/api-keys-and-authentication">Develop</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/deployment-overview">Deploy</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/concepts-components">Components reference</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/api-reference-api-examples">API reference</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">Get started with the Langflow API</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="/typescript-client">Use the TypeScript client</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">Flow trigger endpoints</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-openai-responses">OpenAI Responses endpoints</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">Flow management endpoints</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">Files endpoints</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">Projects endpoints</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">Logs endpoints</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">Monitor endpoints</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-build">Build endpoints</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">Users endpoints</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">Langflow API specification</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/contributing-community">Contribute</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/release-notes">Release notes</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/troubleshoot">Support</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" class="menu__link">
|
||
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||
<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_VOVn"><div class="docItemContainer_Djhp"><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" class="breadcrumbHomeIcon_YNFT"><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">Use the TypeScript client</span></li></ul></nav><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>Langflow TypeScript client</h1></header><style>[data-ch-theme="github-dark"] { --ch-t-colorScheme: dark;--ch-t-foreground: #c9d1d9;--ch-t-background: #0d1117;--ch-t-lighter-inlineBackground: #0d1117e6;--ch-t-editor-background: #0d1117;--ch-t-editor-foreground: #c9d1d9;--ch-t-editor-lineHighlightBackground: #6e76811a;--ch-t-editor-rangeHighlightBackground: #ffffff0b;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #264F78;--ch-t-focusBorder: #1f6feb;--ch-t-tab-activeBackground: #0d1117;--ch-t-tab-activeForeground: #c9d1d9;--ch-t-tab-inactiveBackground: #010409;--ch-t-tab-inactiveForeground: #8b949e;--ch-t-tab-border: #30363d;--ch-t-tab-activeBorder: #0d1117;--ch-t-editorGroup-border: #30363d;--ch-t-editorGroupHeader-tabsBackground: #010409;--ch-t-editorLineNumber-foreground: #6e7681;--ch-t-input-background: #0d1117;--ch-t-input-foreground: #c9d1d9;--ch-t-input-border: #30363d;--ch-t-icon-foreground: #8b949e;--ch-t-sideBar-background: #010409;--ch-t-sideBar-foreground: #c9d1d9;--ch-t-sideBar-border: #30363d;--ch-t-list-activeSelectionBackground: #6e768166;--ch-t-list-activeSelectionForeground: #c9d1d9;--ch-t-list-hoverBackground: #6e76811a;--ch-t-list-hoverForeground: #c9d1d9; }</style>
|
||
<!-- -->
|
||
<p>The Langflow TypeScript client allows your TypeScript applications to programmatically interact with the Langflow API.</p>
|
||
<p>For the client code repository, see <a href="https://github.com/datastax/langflow-client-ts/" target="_blank" rel="noopener noreferrer">langflow-client-ts</a>.</p>
|
||
<p>For the npm package, see <a href="https://www.npmjs.com/package/@datastax/langflow-client" target="_blank" rel="noopener noreferrer">@datastax/langflow-client</a>.</p>
|
||
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="install-the-langflow-typescript-package">Install the Langflow TypeScript package<a href="#install-the-langflow-typescript-package" class="hash-link" aria-label="Direct link to Install the Langflow TypeScript package" title="Direct link to Install the Langflow TypeScript package"></a></h2>
|
||
<p>To install the Langflow typescript client package, use one of the following commands:</p>
|
||
<div class="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">npm</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">yarn</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">pnpm</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>npm install @datastax/langflow-client</span></div></div><br></code></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>yarn add @datastax/langflow-client</span></div></div><br></code></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>pnpm add @datastax/langflow-client</span></div></div><br></code></div></div></div></div></div>
|
||
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="initialize-the-langflow-typescript-client">Initialize the Langflow TypeScript client<a href="#initialize-the-langflow-typescript-client" class="hash-link" aria-label="Direct link to Initialize the Langflow TypeScript client" title="Direct link to Initialize the Langflow TypeScript client"></a></h2>
|
||
<ol>
|
||
<li>
|
||
<p>Import the client into your code.</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>import { LangflowClient } from "@datastax/langflow-client";</span></div></div><br></code></div></div>
|
||
</li>
|
||
<li>
|
||
<p>Initialize a <code>LangflowClient</code> object to interact with your server:</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>const baseUrl = "BASE_URL";</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>const apiKey = "API_KEY";</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>const client = new LangflowClient({ baseUrl, apiKey });</span></div></div><br></code></div></div>
|
||
<p>Replace <code>BASE_URL</code> and <code>API_KEY</code> with values from your deployment.
|
||
The default Langflow base URL is <code>http://localhost:7860</code>.
|
||
To create an API key, see <a href="/api-keys-and-authentication">API keys and authentication</a>.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="connect-to-your-server-and-get-responses">Connect to your server and get responses<a href="#connect-to-your-server-and-get-responses" class="hash-link" aria-label="Direct link to Connect to your server and get responses" title="Direct link to Connect to your server and get responses"></a></h2>
|
||
<ol>
|
||
<li>
|
||
<p>With your Langflow client initialized, test the connection by calling your Langflow server.</p>
|
||
<p>The following example runs a flow (<code>runFlow</code>) by sending the flow ID and a chat input string:</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span>import { LangflowClient } from "@datastax/langflow-client";</span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span>const baseUrl = "http://localhost:7860";</span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span>const client = new LangflowClient({ baseUrl });</span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span>async function runFlow() {</span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span> const flowId = "aa5a238b-02c0-4f03-bc5c-cc3a83335cdf";</span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span> const flow = client.flow(flowId);</span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span> const input = "Is anyone there?";</span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span> const response = await flow.run(input);</span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span> console.log(response);</span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->15</span><div style="display:inline-block;margin-left:16px"><span>runFlow().catch(console.error);</span></div></div><br></code></div></div>
|
||
<p>Replace the following:</p>
|
||
<ul>
|
||
<li><code>baseUrl</code>: The URL of your Langflow server.</li>
|
||
<li><code>flowId</code>: The ID of the flow you want to run.</li>
|
||
<li><code>input</code>: The chat input message you want to send to trigger the flow.
|
||
This is only valid for flows with a <strong>Chat Input</strong> component.</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Review the result to confirm that the client connected to your Langflow server.</p>
|
||
<p>The following example shows the response from a well-formed <code>runFlow</code> request that reached the Langflow server and successfully started the flow:</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>FlowResponse {</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> sessionId: 'aa5a238b-02c0-4f03-bc5c-cc3a83335cdf',</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> outputs: [ { inputs: [Object], outputs: [Array] } ]</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><br></code></div></div>
|
||
<p>In this case, the response includes a <a href="/session-id"><code>sessionID</code></a> that is a unique identifier for the client-server session and an <code>outputs</code> array that contains information about the flow run.</p>
|
||
</li>
|
||
<li>
|
||
<p>Optional: If you want to get full response objects from the server, change <code>console.log</code> to stringify the returned JSON object:</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>console.log(JSON.stringify(response, null, 2));</span></div></div><br></code></div></div>
|
||
<p>The exact structure of the returned <code>inputs</code> and <code>outputs</code> objects depends on the components and configuration of your flow.</p>
|
||
</li>
|
||
<li>
|
||
<p>Optional: If you want the response to include only the chat message from the <strong>Chat Output</strong> component, change <code>console.log</code> to use the <code>chatOutputText</code> convenience function:</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>console.log(response.chatOutputText());</span></div></div><br></code></div></div>
|
||
</li>
|
||
</ol>
|
||
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="use-advanced-typescript-client-features">Use advanced TypeScript client features<a href="#use-advanced-typescript-client-features" class="hash-link" aria-label="Direct link to Use advanced TypeScript client features" title="Direct link to Use advanced TypeScript client features"></a></h2>
|
||
<p>The TypeScript client can do more than just connect to your server and run a flow.</p>
|
||
<p>This example builds on the quickstart with additional features for interacting with Langflow:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Pass <a href="/concepts-publish#input-schema">tweaks</a> as an object with the request.
|
||
Tweaks are programmatic run-time overrides for component settings.</p>
|
||
<p>This example changes the LLM used by a language model component in a flow::</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>const tweaks = { model_name: "gpt-4o-mini" };</span></div></div><br></code></div></div>
|
||
</li>
|
||
<li>
|
||
<p>Pass a <a href="/session-id">session ID</a> with the request to separate the conversation from other flow runs, and to be able to continue this conversation by calling the same session ID in the future:</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>const session_id = "aa5a238b-02c0-4f03-bc5c-cc3a83335cdf";</span></div></div><br></code></div></div>
|
||
</li>
|
||
<li>
|
||
<p>Instead of calling <code>run</code> on the Flow object, call <code>stream</code> with the same arguments to get a streaming response:</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>const response = await client.flow(flowId).stream(input);</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>for await (const event of response) {</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> console.log(event);</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><br></code></div></div>
|
||
<p>The response is a <a href="https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream" target="_blank" rel="noopener noreferrer"><code>ReadableStream</code></a> of objects.
|
||
For more information on streaming Langflow responses, see the <a href="/api-flows-run#run-flow"><code>/run</code> endpoint</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p>Run the modified TypeScript application to run the flow with <code>tweaks</code>, <code>session_id</code>, and streaming:</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span>import { LangflowClient } from "@datastax/langflow-client";</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span>const baseUrl = "http://localhost:7860";</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span>const client = new LangflowClient({ baseUrl });</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span>async function runFlow() {</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span> const flowId = "aa5a238b-02c0-4f03-bc5c-cc3a83335cdf";</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span> const input = "Is anyone there?";</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span> const tweaks = { model_name: "gpt-4o-mini" };</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span> const session_id = "test-session";</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span> const response = await client.flow(flowId).stream(input, {</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span> session_id,</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span> tweaks,</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span> });</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span> for await (const event of response) {</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span> console.log(event);</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->22</span><div style="display:inline-block;margin-left:16px"><span>runFlow().catch(console.error);</span></div></div><br></code></div></div>
|
||
<p>Replace the following:</p>
|
||
<ul>
|
||
<li><code>baseUrl</code>: The URL of your Langflow server.</li>
|
||
<li><code>flowId</code>: The ID of the flow you want to run.</li>
|
||
<li><code>input</code>: The chat input message you want to send to trigger the flow, assuming the flow has a <strong>Chat Input</strong> component.</li>
|
||
<li><code>tweaks</code>: Any tweak modifiers to apply to the flow run.
|
||
This example changes the LLM used by a component in the flow.</li>
|
||
<li><code>session_id</code>: Pass a custom session ID.
|
||
If omitted or empty, the flow ID is the default session ID.</li>
|
||
</ul>
|
||
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Result</summary><div><div class="collapsibleContent_i85q"><p>With streaming enabled, the response includes the flow metatadata and timestamped events for flow activity.
|
||
For example:</p><div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> event: 'add_message',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> data: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> timestamp: '2025-05-23 15:52:48 UTC',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> sender: 'User',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> sender_name: 'User',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> session_id: 'test-session',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> text: 'Is anyone there?',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> files: [],</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> error: false,</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> edit: false,</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> properties: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> text_color: '',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> background_color: '',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> edited: false,</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> source: [Object],</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> icon: '',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> allow_markdown: false,</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> positive_feedback: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> state: 'complete',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> targets: []</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> },</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> category: 'message',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> content_blocks: [],</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> id: '7f096715-3f2d-4d84-88d6-5e2f76bf3fbe',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> flow_id: 'aa5a238b-02c0-4f03-bc5c-cc3a83335cdf',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> duration: null</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> event: 'token',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> data: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> chunk: 'Absolutely',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> timestamp: '2025-05-23 15:52:48 UTC'</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> event: 'token',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> data: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> chunk: ',',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> timestamp: '2025-05-23 15:52:48 UTC'</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> event: 'token',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> data: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> chunk: " I'm",</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> timestamp: '2025-05-23 15:52:48 UTC'</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> event: 'token',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> data: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> chunk: ' here',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> timestamp: '2025-05-23 15:52:48 UTC'</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>// this response is abbreviated</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> event: 'end',</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span> data: { result: { session_id: 'test-session', outputs: [Array] } }</span></div></div><div><span class="ch-code-line-number">_<!-- -->68</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><br></code></div></div></div></div></details>
|
||
</li>
|
||
</ol>
|
||
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="retrieve-langflow-logs-with-the-typescript-client">Retrieve Langflow logs with the TypeScript client<a href="#retrieve-langflow-logs-with-the-typescript-client" class="hash-link" aria-label="Direct link to Retrieve Langflow logs with the TypeScript client" title="Direct link to Retrieve Langflow logs with the TypeScript client"></a></h2>
|
||
<p>To retrieve <a href="/logging">Langflow logs</a>, you must enable log retrieval on your Langflow server by including the following values in your Langflow <code>.env</code> file:</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>LANGFLOW_ENABLE_LOG_RETRIEVAL=True</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>LANGFLOW_LOG_RETRIEVER_BUFFER_SIZE=10000</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>LANGFLOW_LOG_LEVEL=DEBUG</span></div></div><br></code></div></div>
|
||
<p>The following example script starts streaming logs in the background, and then runs a flow so you can monitor the flow run:</p>
|
||
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span>import { LangflowClient } from "@datastax/langflow-client";</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span>const baseUrl = "http://localhost:7863";</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span>const flowId = "86f0bf45-0544-4e88-b0b1-8e622da7a7f0";</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span>async function runFlow(client: LangflowClient) {</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span> const input = "Is anyone there?";</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span> const response = await client.flow(flowId).run(input);</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span> console.log('Flow response:', response);</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span>async function main() {</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span> const client = new LangflowClient({ baseUrl: baseUrl });</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span> // Start streaming logs</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span> console.log('Starting log stream...');</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span> for await (const log of await client.logs.stream()) {</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span> console.log('Log:', log);</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span> // Run the flow</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span> await runFlow(client);</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->26</span><div style="display:inline-block;margin-left:16px"><span>main().catch(console.error);</span></div></div><br></code></div></div>
|
||
<p>Replace the following:</p>
|
||
<ul>
|
||
<li><code>baseUrl</code>: The URL of your Langflow server.</li>
|
||
<li><code>flowId</code>: The ID of the flow you want to run.</li>
|
||
<li><code>input</code>: The chat input message you want to send to trigger the flow, assuming the flow has a <strong>Chat Input</strong> component.</li>
|
||
</ul>
|
||
<p>Logs begin streaming indefinitely, and the flow runs once.</p>
|
||
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Result</summary><div><div class="collapsibleContent_i85q"><p>The following example result is truncated for readability, but you can follow the messages to see how the flow instantiates its components, configures its model, and processes the outputs.</p><p>The <code>FlowResponse</code> object, at the end of the stream, is returned to the client with the flow result in the <code>outputs</code> array.</p><div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Starting log stream...</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.006Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: '2025-05-30T07:49:16.006127-0400 DEBUG Instantiating ChatInput of type component\n'</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.029Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: '2025-05-30T07:49:16.029957-0400 DEBUG Instantiating Prompt of type component\n'</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.049Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: '2025-05-30T07:49:16.049520-0400 DEBUG Instantiating ChatOutput of type component\n'</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.069Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: '2025-05-30T07:49:16.069359-0400 DEBUG Instantiating OpenAIModel of type component\n'</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.086Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: "2025-05-30T07:49:16.086426-0400 DEBUG Running layer 0 with 2 tasks, ['ChatInput-xjucM', 'Prompt-I3pxU']\n"</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.101Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: '2025-05-30T07:49:16.101766-0400 DEBUG Building Chat Input\n'</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.113Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: '2025-05-30T07:49:16.113343-0400 DEBUG Building Prompt\n'</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.131Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: '2025-05-30T07:49:16.131423-0400 DEBUG Logged vertex build: 6bd9fe9c-5eea-4f05-a96d-f6de9dc77e3c\n'</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.143Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: '2025-05-30T07:49:16.143295-0400 DEBUG Logged vertex build: 39c68ec9-3859-4fff-9b14-80b3271f8fbf\n'</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.188Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: "2025-05-30T07:49:16.188730-0400 DEBUG Running layer 1 with 1 tasks, ['OpenAIModel-RtlZm']\n"</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.201Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: '2025-05-30T07:49:16.201946-0400 DEBUG Building OpenAI\n'</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:16.216Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: '2025-05-30T07:49:16.216622-0400 INFO Model name: gpt-4.1-mini\n'</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Flow response: FlowResponse {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> sessionId: '86f0bf45-0544-4e88-b0b1-8e622da7a7f0',</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> outputs: [ { inputs: [Object], outputs: [Array] } ]</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>Log: Log {</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> timestamp: 2025-05-30T11:49:18.094Z,</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span> message: `2025-05-30T07:49:18.094364-0400 DEBUG Vertex OpenAIModel-RtlZm, result: <langflow.graph.utils.UnbuiltResult object at 0x364d24dd0>, object: {'text_output': "Hey there! I'm here and ready to help you build something awesome with AI. What are you thinking about creating today?"}\n`</span></div></div><div><span class="ch-code-line-number">_<!-- -->57</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><br></code></div></div></div></div></details>
|
||
<p>For more information, see <a href="/api-logs">Logs endpoints</a>.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api-reference-api-examples"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Get started with the Langflow API</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api-flows-run"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Flow trigger 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="#install-the-langflow-typescript-package" class="table-of-contents__link toc-highlight">Install the Langflow TypeScript package</a></li><li><a href="#initialize-the-langflow-typescript-client" class="table-of-contents__link toc-highlight">Initialize the Langflow TypeScript client</a></li><li><a href="#connect-to-your-server-and-get-responses" class="table-of-contents__link toc-highlight">Connect to your server and get responses</a></li><li><a href="#use-advanced-typescript-client-features" class="table-of-contents__link toc-highlight">Use advanced TypeScript client features</a></li><li><a href="#retrieve-langflow-logs-with-the-typescript-client" class="table-of-contents__link toc-highlight">Retrieve Langflow logs with the TypeScript client</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>© 2025 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> |