Files
langflow/api-openai-responses.html
github-merge-queue[bot] d60d0d4ec2 deploy: f1e45c6e9c
2025-11-24 22:32:29 +00:00

144 lines
98 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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/api-openai-responses" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.8.1">
<title data-rh="true">OpenAI Responses API | 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-openai-responses"><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="OpenAI Responses API | Langflow Documentation"><meta data-rh="true" name="description" content="Langflow includes an endpoint that is compatible with the OpenAI Responses API."><meta data-rh="true" property="og:description" content="Langflow includes an endpoint that is compatible with the OpenAI Responses API."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.langflow.org/api-openai-responses"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/api-openai-responses" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/api-openai-responses" 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":"OpenAI Responses endpoints","item":"https://docs.langflow.org/api-openai-responses"}]}</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&amp;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.242bb6bd.js" defer="defer"></script>
<script src="/assets/js/main.32dcbb69.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" 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 menu__link--active" aria-current="page" 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">OpenAI Responses endpoints</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>OpenAI Responses API</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>Langflow includes an endpoint that is compatible with the <a href="https://platform.openai.com/docs/api-reference/responses" target="_blank" rel="noopener noreferrer">OpenAI Responses API</a>.
It is available at <code>POST /api/v1/responses</code>.</p>
<p>This endpoint allows you to use existing OpenAI client libraries with minimal code changes.
You only need to replace the <code>model</code> name, such as <code>gpt-4</code>, with your <code>flow_id</code>.
You can find Flow IDs in the code snippets on the <a href="/concepts-publish#api-access"><strong>API access</strong> pane</a> or in a flow&#x27;s URL.</p>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="prerequisites">Prerequisites<a href="#prerequisites" class="hash-link" aria-label="Direct link to Prerequisites" title="Direct link to Prerequisites"></a></h2>
<p>To be compatible with Langflow&#x27;s OpenAI Responses API endpoint, your flow and request must adhere to the following requirements:</p>
<ul>
<li><strong>Chat Input</strong>: Your flow must contain a <strong>Chat Input</strong> component.
Flows without this component return an error when passed to this endpoint.
The component types <code>ChatInput</code> and <code>Chat Input</code> are recognized as chat inputs.</li>
<li><strong>Tools</strong>: The <code>tools</code> parameter isn&#x27;t supported, and returns an error if provided.</li>
<li><strong>Model Names</strong>: In your request, the <code>model</code> field must contain a valid flow ID or endpoint name.</li>
<li><strong>Authentication</strong>: All requests require an API key passed in the <code>x-api-key</code> header.
For more information, see <a href="/api-keys-and-authentication">API keys and authentication</a>.</li>
</ul>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="additional-configuration-for-openai-client-libraries">Additional configuration for OpenAI client libraries<a href="#additional-configuration-for-openai-client-libraries" class="hash-link" aria-label="Direct link to Additional configuration for OpenAI client libraries" title="Direct link to Additional configuration for OpenAI client libraries"></a></h3>
<p>This endpoint is compatible with OpenAI&#x27;s API, but requires special configuration when using OpenAI client libraries.
Langflow uses <code>x-api-key</code> headers for authentication, while OpenAI uses <code>Authorization: Bearer</code> headers.
When sending requests to Langflow with OpenAI client libraries, you must configure custom headers and include an <code>api_key</code> configuration.
The <code>api_key</code> parameter can have any value, such as <code>&quot;dummy-api-key&quot;</code> in the client examples, as the actual authentication is handled through the <code>default_headers</code> configuration.</p>
<p>In the following examples, replace the values for <code>LANGFLOW_SERVER_URL</code>, <code>LANGFLOW_API_KEY</code>, and <code>FLOW_ID</code> with values from your deployment.</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">OpenAI Python Client</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">OpenAI TypeScript Client</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">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>from openai import OpenAI</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>client = OpenAI(</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> base_url=&quot;LANGFLOW_SERVER_URL/api/v1/&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> default_headers={&quot;x-api-key&quot;: &quot;LANGFLOW_API_KEY&quot;},</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> api_key=&quot;dummy-api-key&quot; # Required by OpenAI SDK but not used by Langflow</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>)</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>response = client.responses.create(</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> model=&quot;FLOW_ID&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> input=&quot;There is an event that happens on the second wednesday of every month. What are the event dates in 2026?&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>)</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>print(response.output_text)</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">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span>import OpenAI from &quot;openai&quot;;</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span>const client = new OpenAI({</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span> baseURL: &quot;LANGFLOW_SERVER_URL/api/v1/&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span> defaultHeaders: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span> &quot;x-api-key&quot;: &quot;LANGFLOW_API_KEY&quot;</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span> },</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span> apiKey: &quot;dummy-api-key&quot; // Required by OpenAI SDK but not used by Langflow</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span>});</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span>const response = await client.responses.create({</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span> model: &quot;FLOW_ID&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span> input: &quot;There is an event that happens on the second wednesday of every month. What are the event dates in 2026?&quot;</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span>});</span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->16</span><div style="display:inline-block;margin-left:16px"><span>console.log(response.output_text);</span></div></div><br></code></div></div></div></div></div>
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Response</summary><div><div class="collapsibleContent_i85q"><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">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>Here are the event dates for the second Wednesday of each month in 2026:</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- January 14, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- February 11, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- March 11, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- April 8, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- May 13, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- June 10, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- July 8, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- August 12, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- September 9, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- October 14, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- November 11, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>- December 9, 2026</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>If you need these in a different format or want a downloadable calendar, let me know!</span></div></div><br></code></div></div></div></div></details>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="example-request">Example request<a href="#example-request" class="hash-link" aria-label="Direct link to Example request" title="Direct link to Example request"></a></h2>
<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>curl -X POST \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;$LANGFLOW_SERVER_URL/api/v1/responses&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;x-api-key: $LANGFLOW_API_KEY&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;Content-Type: application/json&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -d &#x27;{</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;$YOUR_FLOW_ID&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;input&quot;: &quot;Hello, how are you?&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;stream&quot;: false</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> }&#x27;</span></div></div><br></code></div></div>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="headers">Headers<a href="#headers" class="hash-link" aria-label="Direct link to Headers" title="Direct link to Headers"></a></h3>
<table><thead><tr><th>Header</th><th>Required</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>x-api-key</code></td><td>Yes</td><td>Your Langflow API key for authentication</td><td><code>&quot;sk-...&quot;</code></td></tr><tr><td><code>Content-Type</code></td><td>Yes</td><td>Specifies the JSON format</td><td><code>&quot;application/json&quot;</code></td></tr><tr><td><code>X-LANGFLOW-GLOBAL-VAR-*</code></td><td>No</td><td>Global variables for the flow</td><td><code>&quot;X-LANGFLOW-GLOBAL-VAR-API_KEY: sk-...&quot;</code> For more, see <a href="#global-var">Pass global variables to your flows in headers</a>.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="request-body">Request body<a href="#request-body" class="hash-link" aria-label="Direct link to Request body" title="Direct link to Request body"></a></h3>
<table><thead><tr><th>Field</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>model</code></td><td><code>string</code></td><td>Yes</td><td>-</td><td>The flow ID or endpoint name to execute.</td></tr><tr><td><code>input</code></td><td><code>string</code></td><td>Yes</td><td>-</td><td>The input text to process.</td></tr><tr><td><code>stream</code></td><td><code>boolean</code></td><td>No</td><td><code>false</code></td><td>Whether to stream the response.</td></tr><tr><td><code>background</code></td><td><code>boolean</code></td><td>No</td><td><code>false</code></td><td>Whether to process in background.</td></tr><tr><td><code>tools</code></td><td><code>list[Any]</code></td><td>No</td><td><code>null</code></td><td>Tools are not supported yet.</td></tr><tr><td><code>previous_response_id</code></td><td><code>string</code></td><td>No</td><td><code>null</code></td><td>ID of previous response to continue conversation. For more, see <a href="#response-id">Continue conversations with response and session IDs</a>.</td></tr><tr><td><code>include</code></td><td><code>list[string]</code></td><td>No</td><td><code>null</code></td><td>Additional response data to include, such as <code>[&#x27;tool_call.results&#x27;]</code>. For more, see <a href="#tool-call-results">Retrieve tool call results</a>.</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="example-response">Example response<a href="#example-response" class="hash-link" aria-label="Direct link to Example response" title="Direct link to Example response"></a></h2>
<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">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;e5e8ef8a-7efd-4090-a110-6aca082bceb7&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;object&quot;: &quot;response&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;created_at&quot;: 1756837941,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;ced2ec91-f325-4bf0-8754-f3198c2b1563&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;output&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;message&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;msg_e5e8ef8a-7efd-4090-a110-6aca082bceb7&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;role&quot;: &quot;assistant&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;content&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;output_text&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;text&quot;: &quot;Hello! I&#x27;m here and ready to help. How can I assist you today?&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;annotations&quot;: []</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> ]</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> ],</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;parallel_tool_calls&quot;: true,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;previous_response_id&quot;: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;reasoning&quot;: {&quot;effort&quot;: null, &quot;summary&quot;: null},</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;store&quot;: true,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;temperature&quot;: 1.0,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;text&quot;: {&quot;format&quot;: {&quot;type&quot;: &quot;text&quot;}},</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;tool_choice&quot;: &quot;auto&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;tools&quot;: [],</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;top_p&quot;: 1.0,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;truncation&quot;: &quot;disabled&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;usage&quot;: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;user&quot;: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span> &quot;metadata&quot;: {}</span></div></div><div><span class="ch-code-line-number">_<!-- -->35</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><br></code></div></div>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="response-body">Response body<a href="#response-body" class="hash-link" aria-label="Direct link to Response body" title="Direct link to Response body"></a></h3>
<p>The response contains fields that Langflow sets dynamically and fields that use OpenAI-compatible defaults.</p>
<p>The OpenAI-compatible default values shown above are currently fixed and cannot be modified via the request.
They are included to maintain API compatibility and provide a consistent response format.</p>
<p>For your requests, you will only be setting the dynamic fields.
The default values are documented here for completeness and to show the full response structure.</p>
<p>Fields set dynamically by Langflow:</p>
<table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td><code>string</code></td><td>Unique response identifier.</td></tr><tr><td><code>created_at</code></td><td><code>int</code></td><td>Unix timestamp of response creation.</td></tr><tr><td><code>model</code></td><td><code>string</code></td><td>The flow ID that was executed.</td></tr><tr><td><code>output</code></td><td><code>list[dict]</code></td><td>Array of output items (messages, tool calls, etc.).</td></tr><tr><td><code>previous_response_id</code></td><td><code>string</code></td><td>ID of previous response if continuing conversation.</td></tr></tbody></table>
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Fields with OpenAI-compatible default values</summary><div><div class="collapsibleContent_i85q"><table><thead><tr><th>Field</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td><code>object</code></td><td><code>string</code></td><td><code>&quot;response&quot;</code></td><td>Always <code>&quot;response&quot;</code>.</td></tr><tr><td><code>status</code></td><td><code>string</code></td><td><code>&quot;completed&quot;</code></td><td>Response status: <code>&quot;completed&quot;</code>, <code>&quot;in_progress&quot;</code>, or <code>&quot;failed&quot;</code>.</td></tr><tr><td><code>error</code></td><td><code>dict</code></td><td><code>null</code></td><td>Error details (if any).</td></tr><tr><td><code>incomplete_details</code></td><td><code>dict</code></td><td><code>null</code></td><td>Incomplete response details (if any).</td></tr><tr><td><code>instructions</code></td><td><code>string</code></td><td><code>null</code></td><td>Response instructions (if any).</td></tr><tr><td><code>max_output_tokens</code></td><td><code>int</code></td><td><code>null</code></td><td>Maximum output tokens (if any).</td></tr><tr><td><code>parallel_tool_calls</code></td><td><code>boolean</code></td><td><code>true</code></td><td>Whether parallel tool calls are enabled.</td></tr><tr><td><code>reasoning</code></td><td><code>dict</code></td><td><code>{&quot;effort&quot;: null, &quot;summary&quot;: null}</code></td><td>Reasoning information with effort and summary.</td></tr><tr><td><code>store</code></td><td><code>boolean</code></td><td><code>true</code></td><td>Whether response is stored.</td></tr><tr><td><code>temperature</code></td><td><code>float</code></td><td><code>1.0</code></td><td>Temperature setting.</td></tr><tr><td><code>text</code></td><td><code>dict</code></td><td><code>{&quot;format&quot;: {&quot;type&quot;: &quot;text&quot;}}</code></td><td>Text format configuration.</td></tr><tr><td><code>tool_choice</code></td><td><code>string</code></td><td><code>&quot;auto&quot;</code></td><td>Tool choice setting.</td></tr><tr><td><code>tools</code></td><td><code>list[dict]</code></td><td><code>[]</code></td><td>Available tools.</td></tr><tr><td><code>top_p</code></td><td><code>float</code></td><td><code>1.0</code></td><td>Top-p setting.</td></tr><tr><td><code>truncation</code></td><td><code>string</code></td><td><code>&quot;disabled&quot;</code></td><td>Truncation setting.</td></tr><tr><td><code>usage</code></td><td><code>dict</code></td><td><code>null</code></td><td>Usage statistics (if any).</td></tr><tr><td><code>user</code></td><td><code>string</code></td><td><code>null</code></td><td>User identifier (if any).</td></tr><tr><td><code>metadata</code></td><td><code>dict</code></td><td><code>{}</code></td><td>Additional metadata.</td></tr></tbody></table></div></div></details>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="example-streaming-request">Example streaming request<a href="#example-streaming-request" class="hash-link" aria-label="Direct link to Example streaming request" title="Direct link to Example streaming request"></a></h2>
<p>When you set <code>&quot;stream&quot;: true</code> with your request, the API returns a stream where each chunk contains a small piece of the response as it&#x27;s generated. This provides a real-time experience where users can see the AI&#x27;s output appear word by word, similar to ChatGPT&#x27;s typing effect.</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>curl -X POST \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;$LANGFLOW_SERVER_URL/api/v1/responses&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;x-api-key: $LANGFLOW_API_KEY&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;Content-Type: application/json&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -d &#x27;{</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;$FLOW_ID&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;input&quot;: &quot;Tell me a story about a robot&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;stream&quot;: true</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> }&#x27;</span></div></div><br></code></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 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>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;f7fcea36-f128-41c4-9ac1-e683137375d5&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;object&quot;: &quot;response.chunk&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;created&quot;: 1756838094,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;ced2ec91-f325-4bf0-8754-f3198c2b1563&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;delta&quot;: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;content&quot;: &quot;Once&quot;</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> &quot;status&quot;: null</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></div></div></details>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="streaming-response-body">Streaming response body<a href="#streaming-response-body" class="hash-link" aria-label="Direct link to Streaming response body" title="Direct link to Streaming response body"></a></h3>
<table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td><code>string</code></td><td>Unique response identifier.</td></tr><tr><td><code>object</code></td><td><code>string</code></td><td>Always <code>&quot;response.chunk&quot;</code>.</td></tr><tr><td><code>created</code></td><td><code>int</code></td><td>Unix timestamp of chunk creation.</td></tr><tr><td><code>model</code></td><td><code>string</code></td><td>The flow ID that was executed.</td></tr><tr><td><code>delta</code></td><td><code>dict</code></td><td>The new content chunk.</td></tr><tr><td><code>status</code></td><td><code>string</code></td><td>Response status: <code>&quot;completed&quot;</code>, <code>&quot;in_progress&quot;</code>, or <code>&quot;failed&quot;</code> (optional).</td></tr></tbody></table>
<p>The stream continues until a final chunk with <code>&quot;status&quot;: &quot;completed&quot;</code> indicates the response is finished.</p>
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Final completion chunk</summary><div><div class="collapsibleContent_i85q"><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>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;f7fcea36-f128-41c4-9ac1-e683137375d5&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;object&quot;: &quot;response.chunk&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;created&quot;: 1756838094,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;ced2ec91-f325-4bf0-8754-f3198c2b1563&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;delta&quot;: {},</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;</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></div></div></details>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="response-id">Continue conversations with response and session IDs<a href="#response-id" class="hash-link" aria-label="Direct link to Continue conversations with response and session IDs" title="Direct link to Continue conversations with response and session IDs"></a></h2>
<p>Conversation continuity allows you to maintain context across multiple API calls, enabling multi-turn conversations with your flows. This is essential for building chat applications where users can have ongoing conversations.</p>
<p>When you make a request, the API returns a response with an <code>id</code> field. You can use this <code>id</code> as the <code>previous_response_id</code> in your next request to continue the conversation from where it left off.</p>
<p>First Message:</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>curl -X POST \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;http://$LANGFLOW_SERVER_URL/api/v1/responses&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;x-api-key: $LANGFLOW_API_KEY&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;Content-Type: application/json&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -d &#x27;{</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;$FLOW_ID&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;input&quot;: &quot;Hello, my name is Alice&quot;</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> }&#x27;</span></div></div><br></code></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 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">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;c45f4ac8-772b-4675-8551-c560b1afd590&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;object&quot;: &quot;response&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;created_at&quot;: 1756839042,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;ced2ec91-f325-4bf0-8754-f3198c2b1563&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;output&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;message&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;msg_c45f4ac8-772b-4675-8551-c560b1afd590&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;role&quot;: &quot;assistant&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;content&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;output_text&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;text&quot;: &quot;Hello, Alice! How can I assist you today?&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;annotations&quot;: []</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> ]</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> ],</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;previous_response_id&quot;: null</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><br></code></div></div></div></div></details>
<p>Follow-up message:</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>curl -X POST \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;http://$LANGFLOW_SERVER_URL/api/v1/responses&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;x-api-key: $LANGFLOW_API_KEY&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;Content-Type: application/json&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -d &#x27;{</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;ced2ec91-f325-4bf0-8754-f3198c2b1563&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;input&quot;: &quot;What&#x27;s my name?&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;previous_response_id&quot;: &quot;c45f4ac8-772b-4675-8551-c560b1afd590&quot;</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> }&#x27;</span></div></div><br></code></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 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">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;c45f4ac8-772b-4675-8551-c560b1afd590&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;object&quot;: &quot;response&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;created_at&quot;: 1756839043,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;ced2ec91-f325-4bf0-8754-f3198c2b1563&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;output&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;message&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;msg_c45f4ac8-772b-4675-8551-c560b1afd590&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;role&quot;: &quot;assistant&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;content&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;output_text&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;text&quot;: &quot;Your name is Alice. How can I help you today?&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;annotations&quot;: []</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> ]</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> ],</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;previous_response_id&quot;: &quot;c45f4ac8-772b-4675-8551-c560b1afd590&quot;</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><br></code></div></div></div></div></details>
<p>Optionally, you can use your own session ID values for the <code>previous_response_id</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>curl -X POST \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;http://$LANGFLOW_SERVER_URL/api/v1/responses&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;x-api-key: $LANGFLOW_API_KEY&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;Content-Type: application/json&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -d &#x27;{</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;ced2ec91-f325-4bf0-8754-f3198c2b1563&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;input&quot;: &quot;What&#x27;s my name?&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;previous_response_id&quot;: &quot;session-alice-1756839048&quot;</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> }&#x27;</span></div></div><br></code></div></div>
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Result</summary><div><div class="collapsibleContent_i85q"><p>This example uses the same flow as the other <code>previous_response_id</code> examples, but the LLM had not yet been introduced to Alice in the specified session:</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">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;session-alice-1756839048&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;object&quot;: &quot;response&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;created_at&quot;: 1756839048,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;ced2ec91-f325-4bf0-8754-f3198c2b1563&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;output&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;message&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;msg_session-alice-1756839048&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;role&quot;: &quot;assistant&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;content&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;output_text&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;text&quot;: &quot;I don&#x27;t have access to your name unless you tell me. If you&#x27;d like, you can share your name, and I&#x27;ll remember it for this conversation!&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;annotations&quot;: []</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> ]</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> ],</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;previous_response_id&quot;: &quot;session-alice-1756839048&quot;</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><br></code></div></div></div></div></details>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="tool-call-results">Retrieve tool call results<a href="#tool-call-results" class="hash-link" aria-label="Direct link to Retrieve tool call results" title="Direct link to Retrieve tool call results"></a></h2>
<p>When you send a request to the <code>/api/v1/responses</code> endpoint to run a flow that includes tools or function calls, you can retrieve the raw tool execution details by adding <code>&quot;include&quot;: [&quot;tool_call.results&quot;]</code> to the request payload.</p>
<p>Without the <code>include</code> parameter, tool calls return basic function call information, but not the raw tool results.
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">_<!-- -->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> &quot;id&quot;: &quot;fc_1&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;function_call&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;name&quot;: &quot;evaluate_expression&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;arguments&quot;: &quot;{\&quot;expression\&quot;: \&quot;15*23\&quot;}&quot;</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>To get the raw <code>results</code> of each tool execution, add <code>include: [&quot;tool_call.results&quot;]</code> to the request payload:</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>curl -X POST \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;http://$LANGFLOW_SERVER_URL/api/v1/responses&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;Content-Type: application/json&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;x-api-key: $LANGFLOW_API_KEY&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -d &#x27;{</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;FLOW_ID&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;input&quot;: &quot;Calculate 23 * 15 and show me the result&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;stream&quot;: false,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;include&quot;: [&quot;tool_call.results&quot;]</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> }&#x27;</span></div></div><br></code></div></div>
<p>The response now includes the tool call&#x27;s results.
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">_<!-- -->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> &quot;id&quot;: &quot;evaluate_expression_1&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;tool_call&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;tool_name&quot;: &quot;evaluate_expression&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;queries&quot;: [&quot;15*23&quot;],</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;results&quot;: {&quot;result&quot;: &quot;345&quot;}</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>
<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 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">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;a6e5511e-71f8-457a-88d2-7d8c6ea34e36&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;object&quot;: &quot;response&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;created_at&quot;: 1756835379,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;error&quot;: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;incomplete_details&quot;: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;instructions&quot;: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;max_output_tokens&quot;: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;ced2ec91-f325-4bf0-8754-f3198c2b1563&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;output&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;evaluate_expression_1&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;queries&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;15*23&quot;</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> ],</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;tool_name&quot;: &quot;evaluate_expression&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;tool_call&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;results&quot;: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;result&quot;: &quot;345&quot;</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> },</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;message&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;msg_a6e5511e-71f8-457a-88d2-7d8c6ea34e36&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;role&quot;: &quot;assistant&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;content&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;output_text&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;text&quot;: &quot;The result of 23 * 15 is 345.&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;annotations&quot;: []</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> ]</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> ],</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;parallel_tool_calls&quot;: true,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;previous_response_id&quot;: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;reasoning&quot;: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;effort&quot;: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;summary&quot;: null</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> },</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;store&quot;: true,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;temperature&quot;: 1.0,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;text&quot;: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;format&quot;: {</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;text&quot;</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> },</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;tool_choice&quot;: &quot;auto&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;tools&quot;: [],</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;top_p&quot;: 1.0,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;truncation&quot;: &quot;disabled&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;usage&quot;: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;user&quot;: null,</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span> &quot;metadata&quot;: {}</span></div></div><div><span class="ch-code-line-number">_<!-- -->58</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><br></code></div></div></div></div></details>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="global-var">Pass global variables to your flows in headers<a href="#global-var" class="hash-link" aria-label="Direct link to Pass global variables to your flows in headers" title="Direct link to Pass global variables to your flows in headers"></a></h2>
<p>Global variables allow you to pass dynamic values to your flows that can be used by components within that flow run.
This is useful for passing API keys, user IDs, or any other configuration that might change between requests.</p>
<p>The <code>/responses</code> endpoint accepts global variables as custom HTTP headers with the format <code>X-LANGFLOW-GLOBAL-VAR-{VARIABLE_NAME}</code>.
Variables are only available during this specific request execution and aren&#x27;t persisted.
Variable names are automatically converted to uppercase.</p>
<p>This example demonstrates passing an <code>OPENAI_API_KEY</code> variable, which is a variable Langflow automatically detects from environment variables, with two custom variables for <code>USER_ID</code> and <code>ENVIRONMENT</code>. The variables don&#x27;t have to be created in Langflow&#x27;s Global Variables section - you can pass any variable name in the <code>X-LANGFLOW-GLOBAL-VAR-{VARIABLE_NAME}</code> header format.</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">_<!-- -->11</span><div style="display:inline-block;margin-left:16px"><span>curl -X POST \</span></div></div><div><span class="ch-code-line-number">_<!-- -->11</span><div style="display:inline-block;margin-left:16px"><span> &quot;$LANGFLOW_SERVER_URL/api/v1/responses&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->11</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;x-api-key: $LANGFLOW_API_KEY&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->11</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;Content-Type: application/json&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->11</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;X-LANGFLOW-GLOBAL-VAR-OPENAI_API_KEY: sk-...&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->11</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;X-LANGFLOW-GLOBAL-VAR-USER_ID: user123&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->11</span><div style="display:inline-block;margin-left:16px"><span> -H &quot;X-LANGFLOW-GLOBAL-VAR-ENVIRONMENT: production&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->11</span><div style="display:inline-block;margin-left:16px"><span> -d &#x27;{</span></div></div><div><span class="ch-code-line-number">_<!-- -->11</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;your-flow-id&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->11</span><div style="display:inline-block;margin-left:16px"><span> &quot;input&quot;: &quot;Hello&quot;</span></div></div><div><span class="ch-code-line-number">_<!-- -->11</span><div style="display:inline-block;margin-left:16px"><span> }&#x27;</span></div></div><br></code></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 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">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span>{</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;4a4d2f24-bb45-4a55-a499-0191305264be&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;object&quot;: &quot;response&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;created_at&quot;: 1756839935,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;model&quot;: &quot;ced2ec91-f325-4bf0-8754-f3198c2b1563&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;output&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;message&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;id&quot;: &quot;msg_4a4d2f24-bb45-4a55-a499-0191305264be&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;status&quot;: &quot;completed&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;role&quot;: &quot;assistant&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;content&quot;: [</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> {</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;type&quot;: &quot;output_text&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;text&quot;: &quot;Hello! How can I assist you today?&quot;,</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;annotations&quot;: []</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> ]</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> ],</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span> &quot;previous_response_id&quot;: null</span></div></div><div><span class="ch-code-line-number">_<!-- -->23</span><div style="display:inline-block;margin-left:16px"><span>}</span></div></div><br></code></div></div></div></div></details>
<p>Variables passed with <code>X-LANGFLOW-GLOBAL-VAR-{VARIABLE_NAME}</code> are always available to your flow, regardless of whether they exist in the database.</p>
<p>If your flow components reference variables that aren&#x27;t provided in headers or your Langflow database, the flow fails by default.
To avoid this, you can set the <code>FALLBACK_TO_ENV_VARS</code> environment variable is <code>true</code>, which allows the flow to use values from the <code>.env</code> file if they aren&#x27;t otherwise specified.</p>
<p>In the above example, <code>OPENAI_API_KEY</code> will fall back to the database variable if not provided in the header.
<code>USER_ID</code> and <code>ENVIRONMENT</code> will fall back to environment variables if <code>FALLBACK_TO_ENV_VARS</code> is enabled.
Otherwise, the flow fails.</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-flows-run"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Flow trigger endpoints</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api-flows"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Flow management 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="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a><ul><li><a href="#additional-configuration-for-openai-client-libraries" class="table-of-contents__link toc-highlight">Additional configuration for OpenAI client libraries</a></li></ul></li><li><a href="#example-request" class="table-of-contents__link toc-highlight">Example request</a><ul><li><a href="#headers" class="table-of-contents__link toc-highlight">Headers</a></li><li><a href="#request-body" class="table-of-contents__link toc-highlight">Request body</a></li></ul></li><li><a href="#example-response" class="table-of-contents__link toc-highlight">Example response</a><ul><li><a href="#response-body" class="table-of-contents__link toc-highlight">Response body</a></li></ul></li><li><a href="#example-streaming-request" class="table-of-contents__link toc-highlight">Example streaming request</a><ul><li><a href="#streaming-response-body" class="table-of-contents__link toc-highlight">Streaming response body</a></li></ul></li><li><a href="#response-id" class="table-of-contents__link toc-highlight">Continue conversations with response and session IDs</a></li><li><a href="#tool-call-results" class="table-of-contents__link toc-highlight">Retrieve tool call results</a></li><li><a href="#global-var" class="table-of-contents__link toc-highlight">Pass global variables to your flows in headers</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"> ·&nbsp; <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>