pengjunjie/langflow
1
0
Fork 1
mirror of https://github.com/langflow-ai/langflow.git synced 2026-07-25 14:43:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: 1.6 feature branch (#9521)

Browse Source 
* docs: update file size limit to 1024 mb (#9397)

* update-file-size-limit-to-1024-mb

* docs: clarify available API endpoints and their use cases (#9382)

* available-endpoints

* asterisk

* structure-into-tabs-and-confirm-login-endpoint

* reorg and clarify some usage

---------

Co-authored-by: April M <april.murphy@datastax.com>

---------

Co-authored-by: April M <april.murphy@datastax.com>

* add-lfx-kb-agent-struct-out

* update-release-notes

* docs: docling integration into file component (#9481)

* init

* ui-package-manager

* more-content

* components-page

* dependency-included-for-1.6

* remove-package-management-feature

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* clarify-file-extension-behavior

* config-dir-not-in-1.6

* clarify-outputs

* add-links-andupdate-parameters

* more-params

* clarify-supported-filetypes

* installation-in-bundle

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* Apply suggestions from code review

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* docs: Traceloop SDK integration documentation (#9514)

* Added documentation file for langflow-traceloop-instana integration

* updated sidebar.js

* Updated documentation with metrics integration instructions

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* update doc

* Format correction

* Formatting correction

* Updated Slug title

* style-edit

* Split configure environment variables into steps

* Formatted as per Google developer style guide

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: Edwin Jose <edwinjose900@gmail.com>

* More context added on OTLP security

* Added screenshots of Instana dashboards

* Updated as per the review comments

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

* updated refer documentation links

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
Co-authored-by: Edwin Jose <edwinjose900@gmail.com>

* docling-and-traceloop-links-for-release-notes-remove-duplicates

* traceloop-touchup

* add-component-release-notes

* docs: 1.6 knowledge base feature (#9381)

* sidebars-and-content

* add-kb-components

* completed-basic-outline

* updates-and-new-names

* kb-tutorial-content

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* move-component-docs-to-main-page

* code-review

* reorganize-content

* add-link-to-agents

* fix links, create components-kb

* move and revise kb content

* missing import

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: April M <april.murphy@datastax.com>

* docs: Component documentation updates for 1.6.0 (#9627)

* bundles icon

* component menu and bundle icons

* mcp icon extension

* more bundle icon

* workspace gestures and locking

* mcp server stuff

* fix typo and move serper component

* g-assist edit

* simplify hidden param text and update cohere

* amazon components

* nvidia system assist

* use partial for hidden param text

* fix import, add partial for agent summary

* style changes to prep for separating vector page

* rework llm and embedding model pages

* handle legacy components

* remove memories page

* tools page

* applied partials to vector stores before moving

* move redis and ds, fix links

* astra db component updates

* c vector stores

* traceloop copyedits

* advanced parsing

* elastic page and ocr engine edit

* q-w vector stores

* rest of vector stores

* fix build errors

* Revert "mcp icon extension"

This reverts commit 4d1582793a.

* unused imports and build errors

* build errors

* better icon reference

* tip edits

* fixing after preview

* more touchup

* small style edits for ts client page

* replicate pr 9676

* fix style

* KB comments

* Update docs/docs/Components/bundles-mongodb.mdx

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

---------

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

* add deprecated component to release notes

* knowledge and message history

* wording

* legacy components

* capitalization

* docs: OpenAI responses endpoint (#9539)

* init

* more-content-and-examples

* cleanup

* add-response-tabs-and-streaming-example

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* requires-agent-component-to-emit-message

* [autofix.ci] apply automated fixes

* test-and-explain-more

* global-var-and-fallback

* bash-not-curl-codeblock

* tighten-up-intro-para

* add-entry-to-concepts-publish-page

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* fix-merge-mistake

* flow-id-or-endpoint-name

* reformat

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* standardize-table-codefont

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

* fix build

* code rabbit comments

* docs: remove knowledge base content from 1.6 (#9784)

* remove-kb-content

* broken links

* random change to restart build

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: April M <april.murphy@datastax.com>

* docs: update composio bundle page (#9442)

* update-composio-integrations

* update-doc-to-be-general

* trailing-space

* add-tool-script

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* global-variable

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* reorder-steps-and-move-script

* clarify-connection

* [autofix.ci] apply automated fixes

* [autofix.ci] apply automated fixes (attempt 2/3)

* [autofix.ci] apply automated fixes (attempt 3/3)

* tools slug/name

* test composio steps

* remove unnecessary import

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: April M <april.murphy@datastax.com>

* chore: small misses and sync with 9-Sep-25 release build (#9792)

* io page

* fix slug

* custom models and canvas controls

* message history

* composio slack

* move a flow

* vlm option for docling

* docs: add oauth for mcp (#9626)

* oauth-and-none-options

* mcp-composer-for-server

* updates-from-testing

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* clarify-client-update

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* code-review

* clarify-oauth-values

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* code-review

* double-words

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* docs: include guidance for openai client dummy key (#9871)

* test-client-calls

* less-prose

* clearer-intro

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* remove-indentation-and-correct-example-key-value

* comment-syntax

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* docs: mcp tools troubleshooting (#9866)

* move-mcp-troubleshooting-from-server-page-and-add-issue

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Lucas Oliveira <62335616+lucaseduoli@users.noreply.github.com>

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: Lucas Oliveira <62335616+lucaseduoli@users.noreply.github.com>

* docs: auth changes (#9731)

* initial-content

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* code-review

* Apply suggestions from code review

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* docs: CORS configuration (#9773)

* initial-content

* title

* clarify-default

* cleanup

* cors-defaults-with-warning-for-1.7

* docs-and-code-review

* clarify-cors-in-future-release

* code-review

* developer mode for docling

* auto login

* cors

* auth variables

* environment variables pt 1

* env var pt 2

* env var pt 3

* env var pt 5

* align CLI page with env var

* autologin

* docs: clarify log format behavior (#9945)

clarify-log-format-behavior

* docling dependency exceptions

---------

Co-authored-by: April M <april.murphy@datastax.com>
Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: Sandesh R <115570766+2getsandesh@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Edwin Jose <edwinjose900@gmail.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Lucas Oliveira <62335616+lucaseduoli@users.noreply.github.com>
This commit is contained in:
Mendon Kissling
2025-09-26 10:05:06 -04:00
committed by GitHub
parent c0ac23a131
commit a7825e14c9
125 changed files with 4017 additions and 2498 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
docs/docs/API-Reference/api-reference-api-examples.mdx
View File

@ -169,7 +169,7 @@ curl -X GET \
"auto_saving": true,
"auto_saving_interval": 1000,
"health_check_max_retries": 5,
"max_file_size_upload": 100
"max_file_size_upload": 1024
}
```
@ -209,6 +209,9 @@ Other endpoints are helpful for specific use cases, such as administration and f
* POST `/v1/run/advanced/{flow_id}`: Advanced run with explicit `inputs`, `outputs`, `tweaks`, and optional `session_id`.
* POST `/v1/webhook/{flow_id_or_name}`: Trigger a flow via webhook payload.
* [OpenAI Responses API](/api-openai-responses):
* POST `/v1/responses`: Execute flows using an OpenAI-compatible request format.
* Deployment details:
* GET `/v1/version`: Return Langflow version. See [Get version](/api-reference-api-examples#get-version).
* GET `/v1/config`: Return deployment configuration. See [Get configuration](/api-reference-api-examples#get-configuration).
@ -269,47 +272,11 @@ Other endpoints are helpful for specific use cases, such as administration and f
* PATCH `/v1/users/{user_id}/reset-password`: Reset own password.
* DELETE `/v1/users/{user_id}`: Delete a user (cannot delete yourself).
</TabItem>
<TabItem value="Custom components" label="Custom components">
You might use these endpoints when developing custom Langflow components for your own use or to share with the Langflow community:
* Develop custom components:
* GET `/v1/all`: Return all available Langflow component types. See [Get all components](/api-reference-api-examples#get-all-components).
* POST `/v1/custom_component`: Build a custom component from code and return its node.
* POST `/v1/custom_component/update`: Update an existing custom component's build config and outputs.
* POST `/v1/validate/code`: Validate a Python code snippet for a custom component.
* Langflow Store:
* GET `/v1/store/check/`: Return whether the Store feature is enabled.
* GET `/v1/store/check/api_key`: Check if a Store API key exists and is valid.
* POST `/v1/store/components/`: Share a component to the Store.
* PATCH `/v1/store/components/{component_id}`: Update a shared component.
* GET `/v1/store/components/`: List available Store components (filters supported).
* GET `/v1/store/components/{component_id}`: Download a component from the Store.
* GET `/v1/store/tags`: List Store tags.
* GET `/v1/store/users/likes`: List components liked by the current user.
* POST `/v1/store/users/likes/{component_id}`: Like a component.
</TabItem>
<TabItem value="MCP" label="MCP servers and clients">
The following endpoints are for managing Langflow MCP servers, both Langflow-hosted MCP servers and external MCP server connections:
* **MCP (global)**:
* HEAD `/v1/mcp/sse`: Health check for MCP SSE.
* GET `/v1/mcp/sse`: Open SSE stream for MCP server events.
* POST `/v1/mcp/`: Post messages to the MCP server.
* **MCP (project-specific)**:
* GET `/v1/mcp/project/{project_id}`: List MCP-enabled tools and project auth settings.
* HEAD `/v1/mcp/project/{project_id}/sse`: Health check for project SSE.
* GET `/v1/mcp/project/{project_id}/sse`: Open project-scoped MCP SSE.
* POST `/v1/mcp/project/{project_id}`: Post messages to project MCP server.
* POST `/v1/mcp/project/{project_id}/` (trailing slash): Same as above.
* PATCH `/v1/mcp/project/{project_id}`: Update MCP settings for flows and project auth settings.
* POST `/v1/mcp/project/{project_id}/install`: Install MCP client config for Cursor/Windsurf/Claude (local only).
* GET `/v1/mcp/project/{project_id}/installed`: Check which clients have MCP config installed.
* Custom components: You might use these endpoints when developing custom Langflow components for your own use or to share with the Langflow community:
* GET `/v1/all`: Return all available Langflow component types. See [Get all components](/api-reference-api-examples#get-all-components).
* POST `/v1/custom_component`: Build a custom component from code and return its node.
* POST `/v1/custom_component/update`: Update an existing custom component's build config and outputs.
* POST `/v1/validate/code`: Validate a Python code snippet for a custom component.
</TabItem>
<TabItem value="Codebase contribution" label="Codebase development">
@ -359,6 +326,26 @@ The following endpoints are most often used when contributing to the Langflow co
* WS `/v1/voice/ws/flow_tts/{flow_id}/{session_id}`: Same as above with explicit session ID.
* GET `/v1/voice/elevenlabs/voice_ids`: List available ElevenLabs voice IDs for the user.
* MCP servers: The following endpoints are for managing Langflow MCP servers and MCP server connections.
They aren't typically called directly; instead, they are used to drive internal functionality in the Langflow frontend and when running flows that call MCP servers.
* HEAD `/v1/mcp/sse`: Health check for MCP SSE.
* GET `/v1/mcp/sse`: Open SSE stream for MCP server events.
* POST `/v1/mcp/`: Post messages to the MCP server.
* GET `/v1/mcp/project/{project_id}`: List MCP-enabled tools and project auth settings.
* HEAD `/v1/mcp/project/{project_id}/sse`: Health check for project SSE.
* GET `/v1/mcp/project/{project_id}/sse`: Open project-scoped MCP SSE.
* POST `/v1/mcp/project/{project_id}`: Post messages to project MCP server.
* POST `/v1/mcp/project/{project_id}/` (trailing slash): Same as above.
* PATCH `/v1/mcp/project/{project_id}`: Update MCP settings for flows and project auth settings.
* POST `/v1/mcp/project/{project_id}/install`: Install MCP client config for Cursor/Windsurf/Claude (local only).
* GET `/v1/mcp/project/{project_id}/installed`: Check which clients have MCP config installed.
* Custom components: You might use these endpoints when developing custom Langflow components for your own use or to share with the Langflow community:
* GET `/v1/all`: Return all available Langflow component types. See [Get all components](/api-reference-api-examples#get-all-components).
* POST `/v1/custom_component`: Build a custom component from code and return its node.
* POST `/v1/custom_component/update`: Update an existing custom component's build config and outputs.
* POST `/v1/validate/code`: Validate a Python code snippet for a custom component.
</TabItem>
<TabItem value="Deprecated" label="Deprecated">
@ -371,6 +358,15 @@ The following endpoints are deprecated:
* POST `/v1/build/{flow_id}/vertices`: Replaced by [`/monitor/builds`](/api-monitor).
* POST `/v1/build/{flow_id}/vertices/{vertex_id}`: Replaced by [`/monitor/builds`](/api-monitor).
* GET `/v1/build/{flow_id}/{vertex_id}/stream`: Replaced by [`/monitor/builds`](/api-monitor).
* GET `/v1/store/check/`: Return whether the Store feature is enabled.
* GET `/v1/store/check/api_key`: Check if a Store API key exists and is valid.
* POST `/v1/store/components/`: Share a component to the Store.
* PATCH `/v1/store/components/{component_id}`: Update a shared component.
* GET `/v1/store/components/`: List available Store components (filters supported).
* GET `/v1/store/components/{component_id}`: Download a component from the Store.
* GET `/v1/store/tags`: List Store tags.
* GET `/v1/store/users/likes`: List components liked by the current user.
* POST `/v1/store/users/likes/{component_id}`: Like a component.
</TabItem>
</Tabs>