mirror of
https://github.com/langflow-ai/langflow.git
synced 2026-07-26 03:55:40 +08:00
deploy: 343bdd0632
This commit is contained in:
github-merge-queue[bot]
@ -21,7 +21,7 @@
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Sora:wght@550;600&display=swap">
|
||||
<script>!function(){window.semaphore=window.semaphore||[],window.ketch=function(){window.semaphore.push(arguments)};var e=document.createElement("script");e.type="text/javascript",e.src="https://global.ketchcdn.com/web/v3/config/datastax/langflow_org_web/boot.js",e.defer=e.async=!0,document.getElementsByTagName("head")[0].appendChild(e)}()</script>
|
||||
<script defer="true">!function(){const e=e=>{if(window.gtag&&e.purposes&&"analytics"in e.purposes&&"targeted_advertising"in e.purposes){const n=!0===e.purposes.analytics?"granted":"denied",t=!0===e.purposes.targeted_advertising?"granted":"denied",a={analytics_storage:n,ad_personalization:t,ad_storage:t,ad_user_data:t};window.gtag("consent","update",a)}};window.ketch&&window.ketch("on","consent",e)}()</script><link rel="stylesheet" href="/assets/css/styles.530387df.css">
|
||||
<script src="/assets/js/runtime~main.abf88a8d.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.320a3b33.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.5efa91a8.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
@ -47,9 +47,11 @@
|
||||
<li>Contribute to the overall Langflow project.</li>
|
||||
</ul>
|
||||
<p>To view and test all available endpoints, you can access the Langflow API's OpenAPI specification at your Langflow deployment's <code>/docs</code> endpoint, such as <code>http://localhost:7860/docs</code>.</p>
|
||||
<div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_BuS1"><p>For an example of the Langflow API in a script, see the <a href="/get-started-quickstart">Langflow quickstart</a>.</p><p>The quickstart demonstrates how to get automatically generated code snippets for your flows, use a script to run a flow, and extract data from the Langfow API response.</p></div></div>
|
||||
<div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>Try it</div><div class="admonitionContent_BuS1"><p>For an example of the Langflow API in a script, see the <a href="/get-started-quickstart">Langflow quickstart</a>.</p><p>The quickstart demonstrates how to get automatically generated code snippets for your flows, use a script to run a flow, and extract data from the Langfow API response.</p></div></div>
|
||||
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="form-langflow-api-requests">Form Langflow API requests<a href="#form-langflow-api-requests" class="hash-link" aria-label="Direct link to Form Langflow API requests" title="Direct link to Form Langflow API requests"></a></h2>
|
||||
<p>While individual parameters vary by endpoint, all Langflow API requests share some commonalities.</p>
|
||||
<p>While individual options vary by endpoint, all Langflow API requests share some commonalities, like a URL, method, parameters, and authentication.</p>
|
||||
<p>As an example of a Langflow API request, the following curl command calls the <code>/v1/run</code> endpoint, and it passes a runtime override (<code>tweaks</code>) to the flow's Chat Output component:</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">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span>curl --request POST \</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> --url "$LANGFLOW_SERVER_URL/api/v1/run/$FLOW_ID?stream=false" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> --header "Content-Type: application/json" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> --header "x-api-key: $LANGFLOW_API_KEY" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> --data '{</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> "input_value": "hello world!",</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> "output_type": "chat",</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> "input_type": "chat",</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> "tweaks": {</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> "ChatOutput-6zcZt": {</span></div></div><div><span class="ch-code-line-number">_<!-- -->14</span><div style="display:inline-block;margin-left:16px"><span> "should_store_message": true</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>}'</span></div></div><br></code></div></div>
|
||||
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="base-url">Base URL<a href="#base-url" class="hash-link" aria-label="Direct link to Base URL" title="Direct link to Base URL"></a></h3>
|
||||
<p>Local deployments serve the Langflow API at <code>http://localhost:LANGFLOW_PORT/api</code>.
|
||||
The default port is 7868 or 7860:</p>
|
||||
@ -71,47 +73,46 @@ For example:</p>
|
||||
<p>If explicit authentication is required, you must provide a valid Langflow API key in either an <code>x-api-key</code> header or query parameter.
|
||||
For more information, see <a href="/configuration-api-keys">API keys</a>.</p>
|
||||
<p>Because authentication isn't always required, Langflow API examples in the Langflow documentation often omit authentication.</p>
|
||||
<p>As with any API, follow industry best practices for storing and referencing sensitive credentials.
|
||||
For example, you can <a href="#set-environment-variables">set environment variables</a> for your API keys, and then reference those environment variables in your API requests.</p>
|
||||
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="methods-paths-and-parameters">Methods, paths, and parameters<a href="#methods-paths-and-parameters" class="hash-link" aria-label="Direct link to Methods, paths, and parameters" title="Direct link to Methods, paths, and parameters"></a></h3>
|
||||
<p>Langflow API requests use a variety of methods, paths, path parameters, query parameters, and body parameters.
|
||||
<p>Langflow API requests use various methods, paths, path parameters, query parameters, and body parameters.
|
||||
The specific requirements and options depend on the endpoint that you want to call.</p>
|
||||
<p>For example, to create a flow, you pass a JSON-formatted flow definition to <code>POST /v1/flows</code>.
|
||||
Then, to run your flow, you call <code>POST /v1/run/$FLOW_ID</code> with optional run parameters in the request body.</p>
|
||||
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="versions">Versions<a href="#versions" class="hash-link" aria-label="Direct link to Versions" title="Direct link to Versions"></a></h3>
|
||||
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="api-versions">API versions<a href="#api-versions" class="hash-link" aria-label="Direct link to API versions" title="Direct link to API versions"></a></h3>
|
||||
<p>The Langflow API serves <code>/v1</code> and <code>/v2</code> endpoints.</p>
|
||||
<p>Some endpoints only exist under a single version and some exist under both the <code>/v1</code> and <code>/v2</code> versions.</p>
|
||||
<p>If a request fails or has an unexpected result, make sure your endpoint path has the correct version.</p>
|
||||
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="set-environment-variables">Set environment variables<a href="#set-environment-variables" class="hash-link" aria-label="Direct link to Set environment variables" title="Direct link to Set environment variables"></a></h2>
|
||||
<p>As a best practice with any API, store commonly used values in environment variables to facilitate reuse, simplify token rotation, and securely reference sensitive values.
|
||||
You can use any method you prefer to set environment variables, such as <code>export</code>, <code>.env</code>, <code>zshrc</code>, or <code>.curlrc</code>.
|
||||
Additionally, be sure to follow industry best practices when storing credentials and other sensitive values.</p>
|
||||
<p>You might find it helpful to set environment variables for values like your Langflow server URL, Langflow API keys, flow IDs, and project IDs.
|
||||
<p>You can store commonly used values in environment variables to facilitate reuse, simplify token rotation, and securely reference sensitive values.</p>
|
||||
<p>You can use any method you prefer to set environment variables, such as <code>export</code>, <code>.env</code>, <code>zshrc</code>, or <code>.curlrc</code>.
|
||||
Then, reference those environment variables in your API requests.
|
||||
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>export LANGFLOW_URL="http://localhost:7860"</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>export FLOW_ID="359cd752-07ea-46f2-9d3b-a4407ef618da"</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>export PROJECT_ID="1415de42-8f01-4f36-bf34-539f23e47466"</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>export API_KEY="sk-..."</span></div></div><br></code></div></div>
|
||||
<div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_BuS1"><ul>
|
||||
<li>You can find flow IDs on the <a href="/concepts-publish">Publish pane</a>, in a flow's URL, and with <a href="/api-flows#read-flows"><code>GET /flows</code></a>.</li>
|
||||
<li>You can retrieve project IDs with <code>GET /projects</code>(/api-projects#read-projects).</li>
|
||||
</ul></div></div>
|
||||
<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">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span># Set environment variables</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span>export LANGFLOW_API_KEY="sk..."</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span>export LANGFLOW_SERVER_URL="https://localhost:7860"</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span>export FLOW_ID="359cd752-07ea-46f2-9d3b-a4407ef618da"</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span></span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span># Use environment variables in API requests</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span>curl --request POST \</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> --url "$LANGFLOW_SERVER_URL/api/v1/run/$FLOW_ID$?stream=false" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> --header "Content-Type: application/json" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> --header "x-api-key: $LANGFLOW_API_KEY" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> --data '{</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> "input_value": "hello world!",</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> "output_type": "chat",</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> "input_type": "chat",</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> "tweaks": {</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> "ChatOutput-6zcZt": {</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> "should_store_message": true</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span> }</span></div></div><div><span class="ch-code-line-number">_<!-- -->20</span><div style="display:inline-block;margin-left:16px"><span>}'</span></div></div><br></code></div></div>
|
||||
<p>Commonly used values in Langflow API requests include your <a href="#base-url">Langflow server URL</a>, <a href="/configuration-api-keys">Langflow API keys</a>, flow IDs, and <a href="/api-projects#read-projects">project IDs</a>.</p>
|
||||
<p>You can retrieve flow IDs from the <a href="/concepts-publish#api-access"><strong>API access</strong> pane</a>, in a flow's URL, and with <a href="/api-flows#read-flows"><code>GET /flows</code></a>.</p>
|
||||
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="try-some-langflow-api-requests">Try some Langflow API requests<a href="#try-some-langflow-api-requests" class="hash-link" aria-label="Direct link to Try some Langflow API requests" title="Direct link to Try some Langflow API requests"></a></h2>
|
||||
<p>Once you have your Langflow server URL, try calling these endpoints that return Langflow metadata.</p>
|
||||
<p>If authentication is required, include an <code>x-api-key</code> header or query parameter with a valid <a href="/configuration-api-keys">Langflow API key</a>, such as <code>-H 'x-api-key: $API_KEY'</code>.</p>
|
||||
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="get-version">Get version<a href="#get-version" class="hash-link" aria-label="Direct link to Get version" title="Direct link to Get version"></a></h3>
|
||||
<p>Returns the current Langflow API version:</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 GET \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "$LANGFLOW_URL/api/v1/version" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H "accept: application/json"</span></div></div><br></code></div></div>
|
||||
<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 GET \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "$LANGFLOW_SERVER_URL/api/v1/version" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H "accept: application/json"</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> "version": "1.1.1",</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "main_version": "1.1.1",</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "package": "Langflow"</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="get-configuration">Get configuration<a href="#get-configuration" class="hash-link" aria-label="Direct link to Get configuration" title="Direct link to Get configuration"></a></h3>
|
||||
<p>Returns configuration details for your Langflow deployment:</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 GET \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "$LANGFLOW_URL/api/v1/config" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H "accept: application/json"</span></div></div><br></code></div></div>
|
||||
<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 GET \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "$LANGFLOW_SERVER_URL/api/v1/config" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H "accept: application/json"</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> "feature_flags": {</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "mvp_components": false</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> "frontend_timeout": 0,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "auto_saving": true,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "auto_saving_interval": 1000,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "health_check_max_retries": 5,</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "max_file_size_upload": 100</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="get-all-components">Get all components<a href="#get-all-components" class="hash-link" aria-label="Direct link to Get all components" title="Direct link to Get all components"></a></h3>
|
||||
<p>Returns a dictionary of all Langflow components:</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 GET \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "$LANGFLOW_URL/api/v1/all" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H "accept: application/json"</span></div></div><br></code></div></div>
|
||||
<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 GET \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> "$LANGFLOW_SERVER_URL/api/v1/all" \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H "accept: application/json"</span></div></div><br></code></div></div>
|
||||
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="next-steps">Next steps<a href="#next-steps" class="hash-link" aria-label="Direct link to Next steps" title="Direct link to Next steps"></a></h2>
|
||||
<ul>
|
||||
<li>Use the Langflow API to <a href="/api-flows-run">run a flow</a>.</li>
|
||||
<li>Use the Langflow API to <a href="/api-files">upload files</a>.</li>
|
||||
<li>Use the Langflow API to <a href="/api-logs">get flow logs</a>.</li>
|
||||
<li>Explore all endpoints in the <a href="/api">Langflow API specification</a>.</li>
|
||||
</ul></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/deployment-render"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Render</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api-flows-run"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Flow trigger endpoints</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#form-langflow-api-requests" class="table-of-contents__link toc-highlight">Form Langflow API requests</a><ul><li><a href="#base-url" class="table-of-contents__link toc-highlight">Base URL</a></li><li><a href="#authentication" class="table-of-contents__link toc-highlight">Authentication</a></li><li><a href="#methods-paths-and-parameters" class="table-of-contents__link toc-highlight">Methods, paths, and parameters</a></li><li><a href="#versions" class="table-of-contents__link toc-highlight">Versions</a></li></ul></li><li><a href="#set-environment-variables" class="table-of-contents__link toc-highlight">Set environment variables</a></li><li><a href="#try-some-langflow-api-requests" class="table-of-contents__link toc-highlight">Try some Langflow API requests</a><ul><li><a href="#get-version" class="table-of-contents__link toc-highlight">Get version</a></li><li><a href="#get-configuration" class="table-of-contents__link toc-highlight">Get configuration</a></li><li><a href="#get-all-components" class="table-of-contents__link toc-highlight">Get all components</a></li></ul></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</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">
|
||||
</ul></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/deployment-render"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Render</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api-flows-run"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Flow trigger endpoints</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#form-langflow-api-requests" class="table-of-contents__link toc-highlight">Form Langflow API requests</a><ul><li><a href="#base-url" class="table-of-contents__link toc-highlight">Base URL</a></li><li><a href="#authentication" class="table-of-contents__link toc-highlight">Authentication</a></li><li><a href="#methods-paths-and-parameters" class="table-of-contents__link toc-highlight">Methods, paths, and parameters</a></li><li><a href="#api-versions" class="table-of-contents__link toc-highlight">API versions</a></li></ul></li><li><a href="#set-environment-variables" class="table-of-contents__link toc-highlight">Set environment variables</a></li><li><a href="#try-some-langflow-api-requests" class="table-of-contents__link toc-highlight">Try some Langflow API requests</a><ul><li><a href="#get-version" class="table-of-contents__link toc-highlight">Get version</a></li><li><a href="#get-configuration" class="table-of-contents__link toc-highlight">Get configuration</a></li><li><a href="#get-all-components" class="table-of-contents__link toc-highlight">Get all components</a></li></ul></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
|
||||
<span>© 2025 Langflow</span>
|
||||
<span id="preferenceCenterContainer"> · <a href="https://langflow.org/preferences">Manage Privacy Choices</a></span>
|
||||
</div></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><img src="/img/lf-docs-light.svg" alt="Langflow" class="footer__logo themedComponent_mlkZ themedComponent--light_NVdE" width="160" height="40"><img src="/img/lf-docs-dark.svg" alt="Langflow" class="footer__logo themedComponent_mlkZ themedComponent--dark_xIcU" width="160" height="40"></div></div></div></footer><div style="position:fixed;right:20px;bottom:20px;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>
|
||||
|
||||
Reference in New Issue
Block a user