jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: Audit use of tabs and details (#9196)

Browse source 
* audit details

* tabs pt 1

* tabs pt 2

* tabs pt 3

* tabs to details
This commit is contained in:
April I. Murphy 2025-07-28 10:09:14 -07:00 • committed by GitHub
commit 7f04e15602
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
34 changed files with 1067 additions and 1195 deletions
Download patch file Download diff file Expand all files Collapse all files

70
docs/docs/API-Reference/api-build.mdx
View file

@ -22,13 +22,10 @@ You might need to use or understand these endpoints when contributing to the Lan
This endpoint builds and executes a flow, returning a job ID that can be used to stream execution events. This endpoint builds and executes a flow, returning a job ID that can be used to stream execution events.
1. Send a POST request to the `/build/$FLOW_ID/flow` endpoint. 1. Send a POST request to the `/build/$FLOW_ID/flow` endpoint:
<Tabs> ```shell
<TabItem value="curl" label="curl" default> curl -X POST \
```bash
curl -X POST \
"$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \ "$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
-H "accept: application/json" \ -H "accept: application/json" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
@ -38,52 +35,47 @@ curl -X POST \
"input_value": "Tell me a story" "input_value": "Tell me a story"
} }
}' }'
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
"job_id": "123e4567-e89b-12d3-a456-426614174000" "job_id": "123e4567-e89b-12d3-a456-426614174000"
} }
``` ```
</TabItem> </details>
</Tabs>
2. After receiving a job ID from the build endpoint, use the `/build/$JOB_ID/events` endpoint to stream the execution results: 2. After receiving a job ID from the build endpoint, use the `/build/$JOB_ID/events` endpoint to stream the execution results:
<Tabs> ```shell
<TabItem value="curl" label="curl" default> curl -X GET \
```text
curl -X GET \
"$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events" \ "$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events" \
-H "accept: application/json" \ -H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{"event": "vertices_sorted", "data": {"ids": ["ChatInput-XtBLx"], "to_run": ["Prompt-x74Ze", "ChatOutput-ylMzN", "ChatInput-XtBLx", "OpenAIModel-d1wOZ"]}} {"event": "vertices_sorted", "data": {"ids": ["ChatInput-XtBLx"], "to_run": ["Prompt-x74Ze", "ChatOutput-ylMzN", "ChatInput-XtBLx", "OpenAIModel-d1wOZ"]}}
{"event": "add_message", "data": {"timestamp": "2025-03-03T17:42:23", "sender": "User", "sender_name": "User", "session_id": "d2bbd92b-187e-4c84-b2d4-5df365704201", "text": "Tell me a story", "files": [], "error": false, "edit": false, "properties": {"text_color": "", "background_color": "", "edited": false, "source": {"id": null, "display_name": null, "source": null}, "icon": "", "allow_markdown": false, "positive_feedback": null, "state": "complete", "targets": []}, "category": "message", "content_blocks": [], "id": "28879bd8-6a68-4dd5-b658-74d643a4dd92", "flow_id": "d2bbd92b-187e-4c84-b2d4-5df365704201"}} {"event": "add_message", "data": {"timestamp": "2025-03-03T17:42:23", "sender": "User", "sender_name": "User", "session_id": "d2bbd92b-187e-4c84-b2d4-5df365704201", "text": "Tell me a story", "files": [], "error": false, "edit": false, "properties": {"text_color": "", "background_color": "", "edited": false, "source": {"id": null, "display_name": null, "source": null}, "icon": "", "allow_markdown": false, "positive_feedback": null, "state": "complete", "targets": []}, "category": "message", "content_blocks": [], "id": "28879bd8-6a68-4dd5-b658-74d643a4dd92", "flow_id": "d2bbd92b-187e-4c84-b2d4-5df365704201"}}
// ... Additional events as the flow executes ... // ... Additional events as the flow executes ...
{"event": "end", "data": {}} {"event": "end", "data": {}}
``` ```
</TabItem> </details>
</Tabs>
The `/build/$FLOW_ID/events` endpoint accepts an optional `stream` query parameter that defaults to `true`. The `/build/$FLOW_ID/events` endpoint accepts an optional `stream` query parameter that defaults to `true`.
To disable streaming and get all events at once, set `stream` to `false`. To disable streaming and get all events at once, set `stream` to `false`.
```text ```shell
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events?stream=false" \ "$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events?stream=false" \
-H "accept: application/json" \ -H "accept: application/json" \
@ -115,7 +107,7 @@ The `/build` endpoint accepts optional values for `start_component_id` and `stop
Setting `stop_component_id` for a component triggers the same behavior as clicking the **Play** button on that component, where all dependent components leading up to that component are also run. Setting `stop_component_id` for a component triggers the same behavior as clicking the **Play** button on that component, where all dependent components leading up to that component are also run.
For example, to stop flow execution at the OpenAI model component, run the following command: For example, to stop flow execution at the OpenAI model component, run the following command:
```bash ```shell
curl -X POST \ curl -X POST \
"$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \ "$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
-H "accept: application/json" \ -H "accept: application/json" \
@ -129,10 +121,7 @@ curl -X POST \
The `/build` endpoint also accepts inputs for `data` directly, instead of using the values stored in the Langflow database. The `/build` endpoint also accepts inputs for `data` directly, instead of using the values stored in the Langflow database.
This is useful for running flows without having to pass custom values through the UI. This is useful for running flows without having to pass custom values through the UI.
<Tabs> ```shell
<TabItem value="curl" label="curl" default>
```bash
curl -X POST \ curl -X POST \
"$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \ "$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
-H "accept: application/json" \ -H "accept: application/json" \
@ -150,15 +139,14 @@ curl -X POST \
}' }'
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ "job_id": "0bcc7f23-40b4-4bfa-9b8a-a44181fd1175" } { "job_id": "0bcc7f23-40b4-4bfa-9b8a-a44181fd1175" }
``` ```
</TabItem> </details>
</Tabs>
## See also ## See also

181
docs/docs/API-Reference/api-files.mdx
View file

@ -30,13 +30,9 @@ Use the `/files` endpoints to move files between your local machine and Langflow
### Upload file (v1) ### Upload file (v1)
Upload a file to the `v1/files/upload/<YOUR-FLOW-ID>` endpoint of your flow. Upload a file to the `v1/files/upload/$FLOW_ID` endpoint:
Replace **FILE_NAME** with the uploaded file name. Replace **FILE_NAME** with the uploaded file name.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X POST \ curl -X POST \
"$LANGFLOW_URL/api/v1/files/upload/$FLOW_ID" \ "$LANGFLOW_URL/api/v1/files/upload/$FLOW_ID" \
@ -46,8 +42,11 @@ curl -X POST \
-F "file=@FILE_NAME.txt" -F "file=@FILE_NAME.txt"
``` ```
</TabItem> Replace `FILE_NAME.txt` with the name and extension of the file you want to upload.
<TabItem value="result" label="Result"> Not all file types are supported.
<details>
<summary>Result</summary>
```json ```json
{ {
@ -56,8 +55,7 @@ curl -X POST \
} }
``` ```
</TabItem> </details>
</Tabs>
### Upload image files (v1) ### Upload image files (v1)
@ -116,9 +114,6 @@ To change this limit, set the `LANGFLOW_MAX_FILE_SIZE_UPLOAD` [environment varia
List all files associated with a specific flow. List all files associated with a specific flow.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/files/list/$FLOW_ID" \ "$LANGFLOW_URL/api/v1/files/list/$FLOW_ID" \
@ -126,8 +121,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -135,16 +130,12 @@ curl -X GET \
} }
``` ```
</TabItem> </details>
</Tabs>
### Download file (v1) ### Download file (v1)
Download a specific file from a flow. Download a specific file from a flow.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/files/download/$FLOW_ID/2024-12-30_15-19-43_your_file.txt" \ "$LANGFLOW_URL/api/v1/files/download/$FLOW_ID/2024-12-30_15-19-43_your_file.txt" \
@ -153,23 +144,19 @@ curl -X GET \
--output downloaded_file.txt --output downloaded_file.txt
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```text ```text
File contents downloaded to downloaded_file.txt File contents downloaded to downloaded_file.txt
``` ```
</TabItem> </details>
</Tabs>
### Delete file (v1) ### Delete file (v1)
Delete a specific file from a flow. Delete a specific file from a flow.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X DELETE \ curl -X DELETE \
"$LANGFLOW_URL/api/v1/files/delete/$FLOW_ID/2024-12-30_15-19-43_your_file.txt" \ "$LANGFLOW_URL/api/v1/files/delete/$FLOW_ID/2024-12-30_15-19-43_your_file.txt" \
@ -177,8 +164,8 @@ curl -X DELETE \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -186,8 +173,7 @@ curl -X DELETE \
} }
``` ```
</TabItem> </details>
</Tabs>
## Files/V2 endpoints ## Files/V2 endpoints
@ -202,42 +188,47 @@ Upload a file to your user account. The file can be used across multiple flows.
The file is uploaded in the format `USER_ID/FILE_ID.FILE_EXTENSION`, such as `07e5b864-e367-4f52-b647-a48035ae7e5e/d44dc2e1-9ae9-4cf6-9114-8d34a6126c94.pdf`. The file is uploaded in the format `USER_ID/FILE_ID.FILE_EXTENSION`, such as `07e5b864-e367-4f52-b647-a48035ae7e5e/d44dc2e1-9ae9-4cf6-9114-8d34a6126c94.pdf`.
To retrieve your current `user_id`, call the `/whoami` endpoint. 1. To retrieve your current `user_id`, call the `/whoami` endpoint:
```bash
curl -X GET \ ```bash
curl -X GET \
"$LANGFLOW_URL/api/v1/users/whoami" \ "$LANGFLOW_URL/api/v1/users/whoami" \
-H "accept: application/json" \ -H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
Result: <details>
``` <summary>Result</summary>
{"id":"07e5b864-e367-4f52-b647-a48035ae7e5e","username":"langflow","profile_image":null,"store_api_key":null,"is_active":true,"is_superuser":true,"create_at":"2025-05-08T17:59:07.855965","updated_at":"2025-05-28T19:00:42.556460","last_login_at":"2025-05-28T19:00:42.554338","optins":{"github_starred":false,"dialog_dismissed":true,"discord_clicked":false,"mcp_dialog_dismissed":true}}
```
In the POST request to `v2/files`, replace **@FILE_NAME.EXTENSION** with the uploaded file name and its extension. ```
{"id":"07e5b864-e367-4f52-b647-a48035ae7e5e","username":"langflow","profile_image":null,"store_api_key":null,"is_active":true,"is_superuser":true,"create_at":"2025-05-08T17:59:07.855965","updated_at":"2025-05-28T19:00:42.556460","last_login_at":"2025-05-28T19:00:42.554338","optins":{"github_starred":false,"dialog_dismissed":true,"discord_clicked":false,"mcp_dialog_dismissed":true}}
```
</details>
2. In the POST request to `v2/files`, replace **@FILE_NAME.EXTENSION** with the uploaded file name and its extension.
You must include the ampersand (`@`) in the request to instruct curl to upload the contents of the file, not the string `FILE_NAME.EXTENSION`. You must include the ampersand (`@`) in the request to instruct curl to upload the contents of the file, not the string `FILE_NAME.EXTENSION`.
```bash ```bash
curl -X POST \ curl -X POST \
"$LANGFLOW_URL/api/v2/files" \ "$LANGFLOW_URL/api/v2/files" \
-H "accept: application/json" \ -H "accept: application/json" \
-H "Content-Type: multipart/form-data" \ -H "Content-Type: multipart/form-data" \
-H "x-api-key: $LANGFLOW_API_KEY" \ -H "x-api-key: $LANGFLOW_API_KEY" \
-F "file=@FILE_NAME.EXTENSION" -F "file=@FILE_NAME.EXTENSION"
``` ```
The file is uploaded in the format `USER_ID/FILE_ID.FILE_EXTENSION`, and the API returns metadata about the uploaded file: The file is uploaded in the format `USER_ID/FILE_ID.FILE_EXTENSION`, and the API returns metadata about the uploaded file:
```json ```json
{ {
"id":"d44dc2e1-9ae9-4cf6-9114-8d34a6126c94", "id":"d44dc2e1-9ae9-4cf6-9114-8d34a6126c94",
"name":"engine_manual", "name":"engine_manual",
"path":"07e5b864-e367-4f52-b647-a48035ae7e5e/d44dc2e1-9ae9-4cf6-9114-8d34a6126c94.pdf", "path":"07e5b864-e367-4f52-b647-a48035ae7e5e/d44dc2e1-9ae9-4cf6-9114-8d34a6126c94.pdf",
"size":851160, "size":851160,
"provider":null "provider":null
} }
``` ```
### Send files to your flows (v2) ### Send files to your flows (v2)
@ -253,37 +244,39 @@ The default file limit is 100 MB. To configure this value, change the `LANGFLOW_
For more information, see [Supported environment variables](/environment-variables#supported-variables). For more information, see [Supported environment variables](/environment-variables#supported-variables).
1. To send a file to your flow with the API, POST the file to the `/api/v2/files` endpoint. 1. To send a file to your flow with the API, POST the file to the `/api/v2/files` endpoint.
Replace **FILE_NAME** with the uploaded file name.
Replace **FILE_NAME.EXTENSION** with the name and extension of the file you want to upload.
This is the same step described in [Upload file (v2)](#upload-file-v2), but since you need the filename to upload to your flow, it is included here. This is the same step described in [Upload file (v2)](#upload-file-v2), but since you need the filename to upload to your flow, it is included here.
```bash ```bash
curl -X POST \ curl -X POST \
"$LANGFLOW_URL/api/v2/files" \ "$LANGFLOW_URL/api/v2/files" \
-H "accept: application/json" \ -H "accept: application/json" \
-H "Content-Type: multipart/form-data" \ -H "Content-Type: multipart/form-data" \
-H "x-api-key: $LANGFLOW_API_KEY" \ -H "x-api-key: $LANGFLOW_API_KEY" \
-F "file=@FILE_NAME.EXTENSION" -F "file=@FILE_NAME.EXTENSION"
``` ```
The file is uploaded in the format `USER_ID/FILE_ID.FILE_EXTENSION`, and the API returns metadata about the uploaded file: The file is uploaded in the format `USER_ID/FILE_ID.FILE_EXTENSION`, and the API returns metadata about the uploaded file:
```json ```json
{ {
"id":"d44dc2e1-9ae9-4cf6-9114-8d34a6126c94", "id":"d44dc2e1-9ae9-4cf6-9114-8d34a6126c94",
"name":"engine_manual", "name":"engine_manual",
"path":"07e5b864-e367-4f52-b647-a48035ae7e5e/d44dc2e1-9ae9-4cf6-9114-8d34a6126c94.pdf", "path":"07e5b864-e367-4f52-b647-a48035ae7e5e/d44dc2e1-9ae9-4cf6-9114-8d34a6126c94.pdf",
"size":851160, "size":851160,
"provider": null "provider": null
} }
``` ```
2. To use this file in your flow, add a [File](/components-data#file) component to load a file into the flow. 2. To use this file in your flow, add a [File](/components-data#file) component to load a file into the flow.
3. To load the file into your flow, send it to the **File** component. 3. To load the file into your flow, send it to the **File** component.
To retrieve the **File** component's full name with the UUID attached, call the [Read flow](/api-flows#read-flow) endpoint, and then include your **File** component and the file path as a tweak with the `/v1/run` POST request.
In this example, the file uploaded to `/v2/files` is included with the `/v1/run` POST request.
```text To retrieve the **File** component's full name with the UUID attached, call the [Read flow](/api-flows#read-flow) endpoint, and then include your **File** component and the file path as a tweak with the `/v1/run` POST request.
curl --request POST \ In this example, the file uploaded to `/v2/files` is included with the `/v1/run` POST request.
```text
curl --request POST \
--url "$LANGFLOW_URL/api/v1/run/$FLOW_ID" \ --url "$LANGFLOW_URL/api/v1/run/$FLOW_ID" \
--header "Content-Type: application/json" \ --header "Content-Type: application/json" \
--header "x-api-key: $LANGFLOW_API_KEY" \ --header "x-api-key: $LANGFLOW_API_KEY" \
@ -298,21 +291,21 @@ curl --request POST \
] ]
} }
} }
}' }'
``` ```
Result: <details>
```text <summary>Result</summary>
"text":"This document provides important safety information and instructions for selecting, installing, and operating Briggs & Stratton engines. It includes warnings and guidelines to prevent injury, fire, or damage, such as choosing the correct engine model, proper installation procedures, safe fuel handling, and correct engine operation. The document emphasizes following all safety precautions and using authorized parts to ensure safe and effective engine use."
``` ```text
"text":"This document provides important safety information and instructions for selecting, installing, and operating Briggs & Stratton engines. It includes warnings and guidelines to prevent injury, fire, or damage, such as choosing the correct engine model, proper installation procedures, safe fuel handling, and correct engine operation. The document emphasizes following all safety precautions and using authorized parts to ensure safe and effective engine use."
```
</details>
### List files (v2) ### List files (v2)
List all files associated with your user account. List all files associated with your user account.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v2/files" \ "$LANGFLOW_URL/api/v2/files" \
@ -320,8 +313,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
[ [
@ -335,19 +328,13 @@ curl -X GET \
] ]
``` ```
</TabItem> </details>
</Tabs>
### Download file (v2) ### Download file (v2)
Download a specific file by its ID and file extension. Download a specific file by its ID and file extension.
:::tip
You must specify the file type you expect in the `--output` value. You must specify the file type you expect in the `--output` value.
:::
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
@ -357,23 +344,19 @@ curl -X GET \
--output downloaded_file.txt --output downloaded_file.txt
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```text ```text
File contents downloaded to downloaded_file.txt File contents downloaded to downloaded_file.txt
``` ```
</TabItem> </details>
</Tabs>
### Edit file name (v2) ### Edit file name (v2)
Change a file name. Change a file name.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X PUT \ curl -X PUT \
"$LANGFLOW_URL/api/v2/files/$FILE_ID?name=new_file_name" \ "$LANGFLOW_URL/api/v2/files/$FILE_ID?name=new_file_name" \
@ -381,8 +364,8 @@ curl -X PUT \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -394,15 +377,12 @@ curl -X PUT \
} }
``` ```
</TabItem> </details>
</Tabs>
### Delete file (v2) ### Delete file (v2)
Delete a specific file by its ID. Delete a specific file by its ID.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X DELETE \ curl -X DELETE \
"$LANGFLOW_URL/api/v2/files/$FILE_ID" \ "$LANGFLOW_URL/api/v2/files/$FILE_ID" \
@ -410,8 +390,8 @@ curl -X DELETE \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -419,16 +399,12 @@ curl -X DELETE \
} }
``` ```
</TabItem> </details>
</Tabs>
### Delete all files (v2) ### Delete all files (v2)
Delete all files associated with your user account. Delete all files associated with your user account.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X DELETE \ curl -X DELETE \
"$LANGFLOW_URL/api/v2/files" \ "$LANGFLOW_URL/api/v2/files" \
@ -436,8 +412,8 @@ curl -X DELETE \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -445,8 +421,7 @@ curl -X DELETE \
} }
``` ```
</TabItem> </details>
</Tabs>
## Create upload file (Deprecated) ## Create upload file (Deprecated)

7
docs/docs/API-Reference/api-flows-run.mdx
View file

@ -41,7 +41,7 @@ curl -X POST \
The response from `/v1/run/$FLOW_ID` includes metadata, inputs, and outputs for the run. The response from `/v1/run/$FLOW_ID` includes metadata, inputs, and outputs for the run.
<details> <details>
<summary>Result</summary> <summary>Result</summary>
The following example illustrates a response from a Basic Prompting flow: The following example illustrates a response from a Basic Prompting flow:
@ -102,7 +102,7 @@ curl -X POST \
LLM chat responses are streamed back as `token` events, culminating in a final `end` event that closes the connection. LLM chat responses are streamed back as `token` events, culminating in a final `end` event that closes the connection.
<details> <details>
<summary>Result</summary> <summary>Result</summary>
The following example is truncated to illustrate a series of `token` events as well as the final `end` event that closes the LLM's token streaming response: The following example is truncated to illustrate a series of `token` events as well as the final `end` event that closes the LLM's token streaming response:
@ -127,6 +127,7 @@ The following example is truncated to illustrate a series of `token` events as w
{"event": "end", "data": {"result": {"session_id": "chat-123", "message": "Sure! Have you ever heard of the phenomenon known as \"bioluminescence\"?..."}}} {"event": "end", "data": {"result": {"session_id": "chat-123", "message": "Sure! Have you ever heard of the phenomenon known as \"bioluminescence\"?..."}}}
``` ```
</details> </details>
### Run endpoint headers ### Run endpoint headers
@ -190,12 +191,14 @@ curl -X POST \
<details> <details>
<summary>Result</summary> <summary>Result</summary>
```json ```json
{ {
"message": "Task started in the background", "message": "Task started in the background",
"status": "in progress" "status": "in progress"
} }
``` ```
</details> </details>
For more information, see [Webhook component](/components-data#webhook) and [Trigger flows with webhooks](/webhook). For more information, see [Webhook component](/components-data#webhook) and [Trigger flows with webhooks](/webhook).

64
docs/docs/API-Reference/api-flows.mdx
View file

@ -14,9 +14,6 @@ If you want to use the Langflow API to run a flow, see [Flow trigger endpoints](
Creates a new flow. Creates a new flow.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X POST \ curl -X POST \
"$LANGFLOW_URL/api/v1/flows/" \ "$LANGFLOW_URL/api/v1/flows/" \
@ -40,8 +37,8 @@ curl -X POST \
}' }'
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -63,8 +60,7 @@ curl -X POST \
} }
``` ```
</TabItem> </details>
</Tabs>
## Create flows ## Create flows
@ -122,9 +118,6 @@ curl -X POST \
Retrieves a specific flow by its ID. Retrieves a specific flow by its ID.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \ "$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \
@ -132,9 +125,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<summary>Result</summary>
<TabItem value="result" label="Result">
```json ```json
{ {
@ -151,8 +143,7 @@ curl -X GET \
} }
``` ```
</TabItem> </details>
</Tabs>
## Read flows ## Read flows
@ -193,9 +184,6 @@ Updates an existing flow by its ID.
This example changes the value for `endpoint_name` from a random UUID to `my_new_endpoint_name`. This example changes the value for `endpoint_name` from a random UUID to `my_new_endpoint_name`.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X PATCH \ curl -X PATCH \
"$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \ "$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \
@ -212,8 +200,8 @@ curl -X PATCH \
}' }'
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -235,16 +223,12 @@ curl -X PATCH \
} }
``` ```
</TabItem> </details>
</Tabs>
## Delete flow ## Delete flow
Deletes a specific flow by its ID. Deletes a specific flow by its ID.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X DELETE \ curl -X DELETE \
"$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \ "$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \
@ -252,9 +236,8 @@ curl -X DELETE \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<summary>Result</summary>
<TabItem value="result" label="Result">
```json ```json
{ {
@ -262,8 +245,7 @@ curl -X DELETE \
} }
``` ```
</TabItem> </details>
</Tabs>
## Export flows ## Export flows
@ -271,9 +253,6 @@ Exports specified flows to a ZIP file.
This endpoint downloads a ZIP file containing [Langflow JSON files](/concepts-flows-import#langflow-json-file-contents) for each flow ID listed in the request body. This endpoint downloads a ZIP file containing [Langflow JSON files](/concepts-flows-import#langflow-json-file-contents) for each flow ID listed in the request body.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X POST \ curl -X POST \
"$LANGFLOW_URL/api/v1/flows/download/" \ "$LANGFLOW_URL/api/v1/flows/download/" \
@ -287,8 +266,8 @@ curl -X POST \
--output langflow-flows.zip --output langflow-flows.zip
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```text ```text
% Total % Received % Xferd Average Speed Time Time Time Current % Total % Received % Xferd Average Speed Time Time Time Current
@ -296,8 +275,7 @@ curl -X POST \
100 76437 0 76353 100 84 4516k 5088 --:--:-- --:--:-- --:--:-- 4665k 100 76437 0 76353 100 84 4516k 5088 --:--:-- --:--:-- --:--:-- 4665k
``` ```
</TabItem> </details>
</Tabs>
## Import flows ## Import flows
@ -306,10 +284,7 @@ Imports flows by uploading a [Langflow-compatible JSON file](/concepts-flows-imp
To specify a target project for the flow, include the query parameter `project_id`. To specify a target project for the flow, include the query parameter `project_id`.
The target `project_id` must already exist before uploading a flow. Call the [/api/v1/projects/](/api-projects#read-projects) endpoint for a list of available projects. The target `project_id` must already exist before uploading a flow. Call the [/api/v1/projects/](/api-projects#read-projects) endpoint for a list of available projects.
This example uploads a local file named `agent-with-astra-db-tool.json` to a project specified by a `PROJECT_ID` variable. This example uploads a local file named `agent-with-astra-db-tool.json` to a project specified by a `PROJECT_ID` variable:
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X POST \ curl -X POST \
@ -320,8 +295,8 @@ curl -X POST \
-F "file=@agent-with-astra-db-tool.json;type=application/json" -F "file=@agent-with-astra-db-tool.json;type=application/json"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
[ [
@ -337,5 +312,4 @@ curl -X POST \
] ]
``` ```
</TabItem> </details>
</Tabs>

22
docs/docs/API-Reference/api-logs.mdx
View file

@ -32,9 +32,6 @@ The `/logs` endpoint requires log retrieval to be enabled in your Langflow insta
Stream logs in real-time using Server Sent Events (SSE). Stream logs in real-time using Server Sent Events (SSE).
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/logs-stream" \ "$LANGFLOW_URL/logs-stream" \
@ -42,8 +39,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```text ```text
keepalive keepalive
@ -65,8 +62,7 @@ keepalive
keepalive keepalive
``` ```
</TabItem> </details>
</Tabs>
## Retrieve logs with optional parameters ## Retrieve logs with optional parameters
@ -79,9 +75,6 @@ Retrieve logs with optional query parameters:
The default values for all three parameters is `0`. The default values for all three parameters is `0`.
With default values, the endpoint returns the last 10 lines of logs. With default values, the endpoint returns the last 10 lines of logs.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/logs?lines_before=0&lines_after=0&timestamp=0" \ "$LANGFLOW_URL/logs?lines_before=0&lines_after=0&timestamp=0" \
@ -89,8 +82,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```text ```text
{ {
@ -103,9 +96,8 @@ curl -X GET \
"1736354770588": "2025-01-08T11:46:10.588105-0500 DEBUG Create service ServiceType.CHAT_SERVICE\n", "1736354770588": "2025-01-08T11:46:10.588105-0500 DEBUG Create service ServiceType.CHAT_SERVICE\n",
"1736354771021": "2025-01-08T11:46:11.021817-0500 DEBUG Telemetry data sent successfully.\n", "1736354771021": "2025-01-08T11:46:11.021817-0500 DEBUG Telemetry data sent successfully.\n",
"1736354775619": "2025-01-08T11:46:15.619545-0500 DEBUG Create service ServiceType.STORE_SERVICE\n", "1736354775619": "2025-01-08T11:46:15.619545-0500 DEBUG Create service ServiceType.STORE_SERVICE\n",
"1736354775699": "2025-01-08T11:46:15.699661-0500 DEBUG File 046-rocket.svg retrieved successfully from flow /Users/mendon.kissling/Library/Caches/langflow/profile_pictures/Space.\n" "1736354775699": "2025-01-08T11:46:15.699661-0500 DEBUG File 046-rocket.svg retrieved successfully from flow /Users/USER/Library/Caches/langflow/profile_pictures/Space.\n"
} }
``` ```
</TabItem> </details>
</Tabs>

82
docs/docs/API-Reference/api-monitor.mdx
View file

@ -12,9 +12,6 @@ Use the `/monitor` endpoint to monitor and modify messages passed between Langfl
Retrieve Vertex builds for a specific flow. Retrieve Vertex builds for a specific flow.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/monitor/builds?flow_id=$FLOW_ID" \ "$LANGFLOW_URL/api/v1/monitor/builds?flow_id=$FLOW_ID" \
@ -22,8 +19,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -385,16 +382,12 @@ curl -X GET \
} }
``` ```
</TabItem> </details>
</Tabs>
## Delete Vertex builds ## Delete Vertex builds
Delete Vertex builds for a specific flow. Delete Vertex builds for a specific flow.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X DELETE \ curl -X DELETE \
"$LANGFLOW_URL/api/v1/monitor/builds?flow_id=$FLOW_ID" \ "$LANGFLOW_URL/api/v1/monitor/builds?flow_id=$FLOW_ID" \
@ -402,15 +395,14 @@ curl -X DELETE \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```text ```text
204 No Content 204 No Content
``` ```
</TabItem> </details>
</Tabs>
## Get messages ## Get messages
@ -429,9 +421,6 @@ To sort the results, use the `order_by` query parameter.
This example retrieves messages sent by `Machine` and `AI` in a given chat session (`session_id`) and orders the messages by timestamp. This example retrieves messages sent by `Machine` and `AI` in a given chat session (`session_id`) and orders the messages by timestamp.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/monitor/messages?flow_id=$FLOW_ID&session_id=01ce083d-748b-4b8d-97b6-33adbb6a528a&sender=Machine&sender_name=AI&order_by=timestamp" \ "$LANGFLOW_URL/api/v1/monitor/messages?flow_id=$FLOW_ID&session_id=01ce083d-748b-4b8d-97b6-33adbb6a528a&sender=Machine&sender_name=AI&order_by=timestamp" \
@ -439,8 +428,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
[ [
@ -475,17 +464,13 @@ curl -X GET \
] ]
``` ```
</TabItem> </details>
</Tabs>
## Delete messages ## Delete messages
Delete specific messages by their IDs. Delete specific messages by their IDs.
This example deletes the message retrieved in the previous Get messages example. This example deletes the message retrieved in the previous `GET /messages` example.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -v -X DELETE \ curl -v -X DELETE \
@ -496,15 +481,14 @@ curl -v -X DELETE \
-d '["MESSAGE_ID_1", "MESSAGE_ID_2"]' -d '["MESSAGE_ID_1", "MESSAGE_ID_2"]'
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```text ```text
204 No Content 204 No Content
``` ```
</TabItem> </details>
</Tabs>
## Update message ## Update message
@ -512,9 +496,6 @@ Update a specific message by its ID.
This example updates the `text` value of message `3ab66cc6-c048-48f8-ab07-570f5af7b160`. This example updates the `text` value of message `3ab66cc6-c048-48f8-ab07-570f5af7b160`.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X PUT \ curl -X PUT \
"$LANGFLOW_URL/api/v1/monitor/messages/3ab66cc6-c048-48f8-ab07-570f5af7b160" \ "$LANGFLOW_URL/api/v1/monitor/messages/3ab66cc6-c048-48f8-ab07-570f5af7b160" \
@ -526,8 +507,8 @@ curl -X PUT \
}' }'
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -557,8 +538,7 @@ curl -X PUT \
} }
``` ```
</TabItem> </details>
</Tabs>
## Update session ID ## Update session ID
@ -566,9 +546,6 @@ Update the session ID for messages.
This example updates the `session_ID` value `01ce083d-748b-4b8d-97b6-33adbb6a528a` to `different_session_id`. This example updates the `session_ID` value `01ce083d-748b-4b8d-97b6-33adbb6a528a` to `different_session_id`.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X PATCH \ curl -X PATCH \
"$LANGFLOW_URL/api/v1/monitor/messages/session/01ce083d-748b-4b8d-97b6-33adbb6a528a?new_session_id=different_session_id" \ "$LANGFLOW_URL/api/v1/monitor/messages/session/01ce083d-748b-4b8d-97b6-33adbb6a528a?new_session_id=different_session_id" \
@ -576,8 +553,8 @@ curl -X PATCH \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
[ [
@ -612,16 +589,12 @@ curl -X PATCH \
] ]
``` ```
</TabItem> </details>
</Tabs>
## Delete messages by session ## Delete messages by session
Delete all messages for a specific session. Delete all messages for a specific session.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X DELETE \ curl -X DELETE \
"$LANGFLOW_URL/api/v1/monitor/messages/session/different_session_id_2" \ "$LANGFLOW_URL/api/v1/monitor/messages/session/different_session_id_2" \
@ -629,23 +602,19 @@ curl -X DELETE \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```text ```text
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
``` ```
</TabItem> </details>
</Tabs>
## Get transactions ## Get transactions
Retrieve all transactions, which are interactions between components, for a specific flow. Retrieve all transactions, which are interactions between components, for a specific flow.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/monitor/transactions?flow_id=$FLOW_ID&page=1&size=50" \ "$LANGFLOW_URL/api/v1/monitor/transactions?flow_id=$FLOW_ID&page=1&size=50" \
@ -653,8 +622,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -678,8 +647,7 @@ curl -X GET \
} }
``` ```
</TabItem> </details>
</Tabs>
## See also ## See also

52
docs/docs/API-Reference/api-projects.mdx
View file

@ -14,9 +14,6 @@ Projects store your flows and components.
Get a list of Langflow projects, including project IDs, names, and descriptions. Get a list of Langflow projects, including project IDs, names, and descriptions.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/projects/" \ "$LANGFLOW_URL/api/v1/projects/" \
@ -24,8 +21,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
[ [
@ -38,16 +35,12 @@ curl -X GET \
] ]
``` ```
</TabItem> </details>
</Tabs>
## Create project ## Create project
Create a new project. Create a new project.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X POST \ curl -X POST \
"$LANGFLOW_URL/api/v1/projects/" \ "$LANGFLOW_URL/api/v1/projects/" \
@ -61,8 +54,8 @@ curl -X POST \
}' }'
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -73,8 +66,7 @@ curl -X POST \
} }
``` ```
</TabItem> </details>
</Tabs>
To add flows and components at project creation, retrieve the `components_list` and `flows_list` values from the [`/all`](/api-reference-api-examples#get-all-components) and [/flows/read](/api-flows#read-flows) endpoints and add them to the request body. To add flows and components at project creation, retrieve the `components_list` and `flows_list` values from the [`/all`](/api-reference-api-examples#get-all-components) and [/flows/read](/api-flows#read-flows) endpoints and add them to the request body.
@ -104,9 +96,6 @@ Retrieve details of a specific project.
To find the UUID of your project, call the [read projects](#read-projects) endpoint. To find the UUID of your project, call the [read projects](#read-projects) endpoint.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/projects/$PROJECT_ID" \ "$LANGFLOW_URL/api/v1/projects/$PROJECT_ID" \
@ -114,8 +103,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
[ [
@ -128,8 +117,7 @@ curl -X GET \
] ]
``` ```
</TabItem> </details>
</Tabs>
## Update project ## Update project
@ -139,9 +127,6 @@ Each PATCH request updates the project with the values you send.
Only the fields you include in your request are updated. Only the fields you include in your request are updated.
If you send the same values multiple times, the update is still processed, even if the values are unchanged. If you send the same values multiple times, the update is still processed, even if the values are unchanged.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X PATCH \ curl -X PATCH \
"$LANGFLOW_URL/api/v1/projects/b408ddb9-6266-4431-9be8-e04a62758331" \ "$LANGFLOW_URL/api/v1/projects/b408ddb9-6266-4431-9be8-e04a62758331" \
@ -160,8 +145,8 @@ curl -X PATCH \
}' }'
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -172,16 +157,12 @@ curl -X PATCH \
} }
``` ```
</TabItem> </details>
</Tabs>
## Delete project ## Delete project
Delete a specific project. Delete a specific project.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X DELETE \ curl -X DELETE \
"$LANGFLOW_URL/api/v1/projects/$PROJECT_ID" \ "$LANGFLOW_URL/api/v1/projects/$PROJECT_ID" \
@ -189,15 +170,14 @@ curl -X DELETE \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```text ```text
204 No Content 204 No Content
``` ```
</TabItem> </details>
</Tabs>
## Export a project ## Export a project
@ -207,7 +187,7 @@ The `--output` flag is optional.
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/projects/download/b408ddb9-6266-4431-9be8-e04a62758331" \ "$LANGFLOW_URL/api/v1/projects/download/$PROJECT_ID" \
-H "accept: application/json" \ -H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \ -H "x-api-key: $LANGFLOW_API_KEY" \
--output langflow-project.zip --output langflow-project.zip

4
docs/docs/API-Reference/api-reference-api-examples.mdx
View file

@ -138,6 +138,7 @@ curl -X GET \
<details> <details>
<summary>Result</summary> <summary>Result</summary>
```text ```text
{ {
"version": "1.1.1", "version": "1.1.1",
@ -145,6 +146,7 @@ curl -X GET \
"package": "Langflow" "package": "Langflow"
} }
``` ```
</details> </details>
### Get configuration ### Get configuration
@ -160,6 +162,7 @@ curl -X GET \
<details> <details>
<summary>Result</summary> <summary>Result</summary>
```json ```json
{ {
"feature_flags": { "feature_flags": {
@ -172,6 +175,7 @@ curl -X GET \
"max_file_size_upload": 100 "max_file_size_upload": 100
} }
``` ```
</details> </details>
### Get all components ### Get all components

60
docs/docs/API-Reference/api-users.mdx
View file

@ -17,9 +17,6 @@ Create a new user account with a username and password.
This creates a new UUID for the user's `id`, which is mapped to `user_id` in the Langflow database. This creates a new UUID for the user's `id`, which is mapped to `user_id` in the Langflow database.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X POST \ curl -X POST \
"$LANGFLOW_URL/api/v1/users/" \ "$LANGFLOW_URL/api/v1/users/" \
@ -31,8 +28,8 @@ curl -X POST \
}' }'
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -53,16 +50,12 @@ curl -X POST \
} }
``` ```
</TabItem> </details>
</Tabs>
## Get current user ## Get current user
Retrieve information about the currently authenticated user. Retrieve information about the currently authenticated user.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/users/whoami" \ "$LANGFLOW_URL/api/v1/users/whoami" \
@ -70,8 +63,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -87,17 +80,13 @@ curl -X GET \
} }
``` ```
</TabItem> </details>
</Tabs>
## List all users ## List all users
Get a paginated list of all users in the system. Get a paginated list of all users in the system.
Only superusers can use this endpoint (`is_superuser: true`). Only superusers can use this endpoint (`is_superuser: true`).
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X GET \ curl -X GET \
"$LANGFLOW_URL/api/v1/users/?skip=0&limit=10" \ "$LANGFLOW_URL/api/v1/users/?skip=0&limit=10" \
@ -105,8 +94,8 @@ curl -X GET \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -165,8 +154,7 @@ curl -X GET \
} }
``` ```
</TabItem> </details>
</Tabs>
## Update user ## Update user
@ -174,9 +162,6 @@ Modify an existing user's information with a PATCH request.
This example makes the user `10c1c6a2-ab8a-4748-8700-0e4832fd5ce8` an active superuser. This example makes the user `10c1c6a2-ab8a-4748-8700-0e4832fd5ce8` an active superuser.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X PATCH \ curl -X PATCH \
"$LANGFLOW_URL/api/v1/users/10c1c6a2-ab8a-4748-8700-0e4832fd5ce8" \ "$LANGFLOW_URL/api/v1/users/10c1c6a2-ab8a-4748-8700-0e4832fd5ce8" \
@ -188,8 +173,8 @@ curl -X PATCH \
}' }'
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -210,8 +195,7 @@ curl -X PATCH \
} }
``` ```
</TabItem> </details>
</Tabs>
## Reset password ## Reset password
@ -219,9 +203,6 @@ Change a user's password to a new secure value.
You can't change another user's password. You can't change another user's password.
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X PATCH \ curl -X PATCH \
"$LANGFLOW_URL/api/v1/users/10c1c6a2-ab8a-4748-8700-0e4832fd5ce8/reset-password" \ "$LANGFLOW_URL/api/v1/users/10c1c6a2-ab8a-4748-8700-0e4832fd5ce8/reset-password" \
@ -232,8 +213,8 @@ curl -X PATCH \
}' }'
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -254,8 +235,7 @@ curl -X PATCH \
} }
``` ```
</TabItem> </details>
</Tabs>
## Delete user ## Delete user
@ -263,9 +243,6 @@ Remove a user account from the system.
Only superusers can use this endpoint (`is_superuser: true`). Only superusers can use this endpoint (`is_superuser: true`).
<Tabs>
<TabItem value="curl" label="curl" default>
```bash ```bash
curl -X DELETE \ curl -X DELETE \
"$LANGFLOW_URL/api/v1/users/10c1c6a2-ab8a-4748-8700-0e4832fd5ce8" \ "$LANGFLOW_URL/api/v1/users/10c1c6a2-ab8a-4748-8700-0e4832fd5ce8" \
@ -273,8 +250,8 @@ curl -X DELETE \
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```json ```json
{ {
@ -282,5 +259,4 @@ curl -X DELETE \
} }
``` ```
</TabItem> </details>
</Tabs>

60
docs/docs/Agents/agents-tools.mdx
View file

@ -46,23 +46,26 @@ For example, the default tool name is `Agent`. Edit the name to `Agent-gpt-41`,
## Add custom components as tools {#components-as-tools} ## Add custom components as tools {#components-as-tools}
An agent can use custom components as tools. An agent can use [custom components](/components-custom-components) as tools.
1. To add a custom component to the agent flow, click **New Custom Component**. 1. To add a custom component to the agent flow, click **New Custom Component**.
2. Add custom Python code to the custom component. 2. Enter Python code into the **Code** pane to create the custom component.
For example, to create a text analyzer component, paste the below code into the custom component's **Code** pane.
<details open> If you don't already have code for a custom component, you can use the following code snippet as an example before creating your own.
<summary>Python</summary>
```python <details>
from langflow.custom import Component <summary>Text Analyzer custom component</summary>
from langflow.io import MessageTextInput, Output
from langflow.schema import Data
import re
class TextAnalyzerComponent(Component): This code creates a text analyzer component.
```python
from langflow.custom import Component
from langflow.io import MessageTextInput, Output
from langflow.schema import Data
import re
class TextAnalyzerComponent(Component):
display_name = "Text Analyzer" display_name = "Text Analyzer"
description = "Analyzes and transforms input text." description = "Analyzes and transforms input text."
documentation: str = "http://docs.langflow.org/components/custom" documentation: str = "http://docs.langflow.org/components/custom"
@ -107,31 +110,28 @@ class TextAnalyzerComponent(Component):
data = Data(value=analysis_result) data = Data(value=analysis_result)
self.status = data self.status = data
return data return data
``` ```
</details> </details>
3. To use the custom component as a tool, click **Tool Mode**. 3. To use the custom component as a tool, click **Tool Mode**.
4. Connect the custom component's tool output to the agent's tools input. 4. Connect the custom component's tool output to the agent's tools input.
5. Open the <Icon name="Play" aria-hidden="true" /> **Playground** and instruct the agent, `Use the text analyzer on this text: "Agents really are thinking machines!"` 5. Open the <Icon name="Play" aria-hidden="true" /> **Playground** and instruct the agent, `Use the text analyzer on this text: "Agents really are thinking machines!"`
<details open> Based on your instruction, the agent should call the `analyze_text` action and return the result.
<summary>Response</summary> For example:
```
AI
gpt-4o
Finished
0.6s
Here is the analysis of the text "Agents really are thinking machines!":
Original Text: Agents really are thinking machines!
Word Count: 5
Character Count: 36
Sentence Count: 1
Reversed Text: !senihcam gnikniht era yllaer stnegA
Uppercase Text: AGENTS REALLY ARE THINKING MACHINES!
```
</details>
The agent correctly calls the `analyze_text` action and returns the result to the Playground. ```
gpt-4o
Finished
0.6s
Here is the analysis of the text "Agents really are thinking machines!":
Original Text: Agents really are thinking machines!
Word Count: 5
Character Count: 36
Sentence Count: 1
Reversed Text: !senihcam gnikniht era yllaer stnegA
Uppercase Text: AGENTS REALLY ARE THINKING MACHINES!
```
## Make any component a tool ## Make any component a tool

6
docs/docs/Components/components-vector-stores.mdx
View file

@ -576,12 +576,6 @@ For more information, see the [Chroma documentation](https://docs.trychroma.com/
</details> </details>
## Milvus ## Milvus
This component creates a Milvus vector store with search capabilities. This component creates a Milvus vector store with search capabilities.

2
docs/docs/Concepts/concepts-file-management.mdx
View file

@ -18,7 +18,7 @@ You can also manage all files that have been uploaded to your Langflow server.
1. Navigate to Langflow file management: 1. Navigate to Langflow file management:
* In the Langflow UI, on the [**Projects** page](#projects) page, click **My Files** below the list of projects. * In the Langflow UI, on the [**Projects** page](/concepts-flows#projects) page, click **My Files** below the list of projects.
* From a browser, navigate to your Langflow server's `/files` endpoint, such as `http://localhost:7860/files`. Modify the base URL as needed for your Langflow server. * From a browser, navigate to your Langflow server's `/files` endpoint, such as `http://localhost:7860/files`. Modify the base URL as needed for your Langflow server.
* For programmatic file management, use the [Langflow API files endpoints](/api-files). However, the following steps assume you're using the file management UI. * For programmatic file management, use the [Langflow API files endpoints](/api-files). However, the following steps assume you're using the file management UI.

2
docs/docs/Concepts/concepts-overview.mdx
View file

@ -22,7 +22,7 @@ This is where you add [components](/concepts-components), configure them, and at
![Empty Langflow workspace](/img/workspace.png) ![Empty Langflow workspace](/img/workspace.png)
From the **Workspace**, you can also access the [**Playground**](#playground), [**Share** menu](#share-menu), and [**Logs**](/concepts-flows#flow-logs). From the **Workspace**, you can also access the [**Playground**](#playground), [**Share** menu](#share-menu), and [**Logs**](/concepts-flows#flow-storage-and-logs).
### Workspace gestures and interactions ### Workspace gestures and interactions

8
docs/docs/Concepts/concepts-playground.mdx
View file

@ -87,7 +87,7 @@ Custom session IDs are helpful for multiple reasons:
You can set custom session IDs in the visual editor and programmatically. You can set custom session IDs in the visual editor and programmatically.
<Tabs> <Tabs>
<TabItem value="visual" label="Visual editor" default> <TabItem value="visual" label="Visual editor" default>
In your [input and output components](/components-io), use the **Session ID** field: In your [input and output components](/components-io), use the **Session ID** field:
@ -101,8 +101,8 @@ If the field is empty, the flow uses the default session ID.
Make sure to change the **Session ID** when you want to start a new chat session or continue an earlier chat session with a different session ID. Make sure to change the **Session ID** when you want to start a new chat session or continue an earlier chat session with a different session ID.
</TabItem> </TabItem>
<TabItem value="api" label="Langflow API"> <TabItem value="api" label="Langflow API">
When you trigger a flow with the Langflow API, include the `session_id` parameter in the request payload. When you trigger a flow with the Langflow API, include the `session_id` parameter in the request payload.
For example: For example:
@ -121,7 +121,7 @@ curl -X POST "http://$LANGFLOW_SERVER_ADDRESS/api/v1/run/$FLOW_ID" \
This command starts a new chat sessions with the specified `session_id` or it retrieves an existing session with that ID, if one exists. This command starts a new chat sessions with the specified `session_id` or it retrieves an existing session with that ID, if one exists.
</TabItem> </TabItem>
</Tabs> </Tabs>
:::tip :::tip

12
docs/docs/Concepts/concepts-publish.mdx
View file

@ -169,7 +169,7 @@ For more information, see the [langflow-embedded-chat README](https://github.com
The following examples show how to use embedded chat widget in React, Angular, and plain HTML. The following examples show how to use embedded chat widget in React, Angular, and plain HTML.
<Tabs> <Tabs>
<TabItem value="react" label="React" default> <TabItem value="react" label="React" default>
To use the chat widget in your React application, create a component that loads the widget script and renders the chat interface: To use the chat widget in your React application, create a component that loads the widget script and renders the chat interface:
@ -258,8 +258,8 @@ Modify the following reference for your React component's name and the desired `
<ChatWidget className="my-chat-widget" /> <ChatWidget className="my-chat-widget" />
``` ```
</TabItem> </TabItem>
<TabItem value="angular" label="Angular"> <TabItem value="angular" label="Angular">
To use the chat widget in your Angular application, create a component that loads the widget script and renders the chat interface. To use the chat widget in your Angular application, create a component that loads the widget script and renders the chat interface.
@ -330,8 +330,8 @@ You must add `CUSTOM_ELEMENTS_SCHEMA` to your module's configuration to enable t
} }
``` ```
</TabItem> </TabItem>
<TabItem value="html" label="HTML"> <TabItem value="html" label="HTML">
```html ```html
<html lang="en"> <html lang="en">
@ -348,7 +348,7 @@ You must add `CUSTOM_ELEMENTS_SCHEMA` to your module's configuration to enable t
</html> </html>
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
### Configure the langflow-chat web component {#configure-the-langflow-chat-web-component} ### Configure the langflow-chat web component {#configure-the-langflow-chat-web-component}

2
docs/docs/Concepts/data-types.mdx
View file

@ -274,7 +274,7 @@ The following example shows how to inspect the output of a **Type Convert** comp
The default output is `Message` data, which is the same as the input coming from the **Chat Input** component. The default output is `Message` data, which is the same as the input coming from the **Chat Input** component.
To see the `Message` data converted to `Data` or `DataFrame`, change the **Output Type** on the **Type Convert** component, and then rerun the component. To see the `Message` data converted to `Data` or `DataFrame`, change the **Output Type** on the **Type Convert** component, and then rerun the component.
<Tabs groupId="Data type"> <Tabs>
<TabItem value="Message" label="Message" default> <TabItem value="Message" label="Message" default>
```text ```text

46
docs/docs/Concepts/mcp-server.mdx
View file

@ -101,19 +101,21 @@ The following procedure describes how to connect [Cursor](https://www.cursor.com
However, you can connect any [MCP-compatible client](https://modelcontextprotocol.io/clients) following similar steps. However, you can connect any [MCP-compatible client](https://modelcontextprotocol.io/clients) following similar steps.
<Tabs> <Tabs>
<TabItem value="Auto install" label="Auto install" default> <TabItem value="auto" label="Auto install" default>
:::important
Auto installation only works if your HTTP client and Langflow server are on the same local machine.
In this is not the case, configure the client with the code in the **JSON** tab.
:::
1. Install [Cursor](https://docs.cursor.com/get-started/installation). 1. Install [Cursor](https://docs.cursor.com/get-started/installation).
2. In the Langflow dashboard, select the project that contains the flows you want to serve, and then click the **MCP Server** tab. 2. In the Langflow dashboard, select the project that contains the flows you want to serve, and then click the **MCP Server** tab.
3. To auto install your current Langflow project as an MCP server, click <Icon name="Plus" aria-hidden="True"/> **Add**. 3. To auto install your current Langflow project as an MCP server, click <Icon name="Plus" aria-hidden="True"/> **Add**.
The installation adds the server's configuration file to Cursor's `mcp.json` configuration file.
:::important The installation adds the server's configuration file to Cursor's `mcp.json` configuration file.
Auto installation only works if your HTTP client and Langflow server are on the same local machine.
In this is not the case, configure the client with the code in the **JSON** tab. </TabItem>
::: <TabItem value="JSON" label="JSON">
</TabItem>
<TabItem value="JSON" label="JSON">
1. Install [Cursor](https://docs.cursor.com/get-started/installation). 1. Install [Cursor](https://docs.cursor.com/get-started/installation).
2. In Cursor, go to **Cursor Settings > MCP**, and then click **Add New Global MCP Server**. 2. In Cursor, go to **Cursor Settings > MCP**, and then click **Add New Global MCP Server**.
@ -149,7 +151,7 @@ For example:
5. Save and close the `mcp.json` file in Cursor. 5. Save and close the `mcp.json` file in Cursor.
The newly added MCP server will appear in the **MCP Servers** section. The newly added MCP server will appear in the **MCP Servers** section.
</TabItem> </TabItem>
</Tabs> </Tabs>
Cursor is now connected to your project's MCP server and your flows are registered as tools. Cursor is now connected to your project's MCP server and your flows are registered as tools.
@ -250,15 +252,16 @@ The default address is `http://localhost:6274`.
If Claude for Desktop is not using your server's tools correctly, you may need to explicitly define the path to your local `uvx` or `npx` executable file in the `claude_desktop_config.json` configuration file. If Claude for Desktop is not using your server's tools correctly, you may need to explicitly define the path to your local `uvx` or `npx` executable file in the `claude_desktop_config.json` configuration file.
1. To find your UVX path, run `which uvx`. 1. To find your UVX path, run `which uvx`.
To find your NPX path, run `which npx`.
To find your NPX path, run `which npx`.
2. Copy the path, and then replace `PATH_TO_UVX` or `PATH_TO_NPX` in your `claude_desktop_config.json` file. 2. Copy the path, and then replace `PATH_TO_UVX` or `PATH_TO_NPX` in your `claude_desktop_config.json` file.
<Tabs> <Tabs>
<TabItem value="uvx" label="uvx" default> <TabItem value="uvx" label="uvx" default>
```json ```json
{ {
"mcpServers": { "mcpServers": {
"PROJECT_NAME": { "PROJECT_NAME": {
"command": "PATH_TO_UVX", "command": "PATH_TO_UVX",
@ -268,14 +271,14 @@ To find your NPX path, run `which npx`.
] ]
} }
} }
} }
``` ```
</TabItem>
</TabItem>
<TabItem value="npx" label="npx"> <TabItem value="npx" label="npx">
```json ```json
{ {
"mcpServers": { "mcpServers": {
"PROJECT_NAME": { "PROJECT_NAME": {
"command": "PATH_TO_NPX", "command": "PATH_TO_NPX",
@ -287,10 +290,11 @@ To find your NPX path, run `which npx`.
] ]
} }
} }
} }
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
## See also ## See also

20
docs/docs/Configuration/configuration-api-keys.mdx
View file

@ -33,15 +33,15 @@ You can generate a Langflow API key with the UI or the CLI.
The UI-generated key is appropriate for most cases. The CLI-generated key is needed when your Langflow server is running in `--backend-only` mode. The UI-generated key is appropriate for most cases. The CLI-generated key is needed when your Langflow server is running in `--backend-only` mode.
<Tabs> <Tabs>
<TabItem value="Langflow UI" label="Langflow UI" default> <TabItem value="Langflow UI" label="Langflow UI" default>
1. In the Langflow UI header, click your profile icon, and then select **Settings**. 1. In the Langflow UI header, click your profile icon, and then select **Settings**.
2. Click **Langflow API Keys**, and then click **Add New**. 2. Click **Langflow API Keys**, and then click **Add New**.
3. Name your key, and then click **Create API Key**. 3. Name your key, and then click **Create API Key**.
4. Copy the API key and store it securely. 4. Copy the API key and store it securely.
</TabItem> </TabItem>
<TabItem value="Langflow CLI" label="Langflow CLI"> <TabItem value="Langflow CLI" label="Langflow CLI">
If you're serving your flow with `--backend-only=true`, you can't create API keys in the UI, because the frontend is not running. If you're serving your flow with `--backend-only=true`, you can't create API keys in the UI, because the frontend is not running.
@ -69,7 +69,7 @@ To create an API key for a user from the CLI, do the following:
-H "x-api-key: $LANGFLOW_API_KEY" -H "x-api-key: $LANGFLOW_API_KEY"
``` ```
<details closed> <details>
<summary>Result</summary> <summary>Result</summary>
```json ```json
@ -93,7 +93,8 @@ To create an API key for a user from the CLI, do the following:
```shell ```shell
uv run langflow api-key uv run langflow api-key
``` ```
</TabItem>
</TabItem>
</Tabs> </Tabs>
## Authenticate requests with the Langflow API key ## Authenticate requests with the Langflow API key
@ -103,7 +104,7 @@ Include your API key in API requests to authenticate requests to Langflow.
API keys allow access only to the flows and components of the specific user who created the key. API keys allow access only to the flows and components of the specific user who created the key.
<Tabs> <Tabs>
<TabItem value="HTTP header" label="HTTP header" default> <TabItem value="header" label="HTTP header" default>
To use the API key when making API requests, include the API key in the HTTP header: To use the API key when making API requests, include the API key in the HTTP header:
@ -115,8 +116,8 @@ curl -X POST \
-d '{"inputs": {"text":""}, "tweaks": {}}' -d '{"inputs": {"text":""}, "tweaks": {}}'
``` ```
</TabItem> </TabItem>
<TabItem value="Query parameter" label="Query parameter"> <TabItem value="query" label="Query parameter">
To pass the API key as a query parameter: To pass the API key as a query parameter:
@ -126,7 +127,8 @@ curl -X POST \
-H 'Content-Type: application/json' \ -H 'Content-Type: application/json' \
-d '{"inputs": {"text":""}, "tweaks": {}}' -d '{"inputs": {"text":""}, "tweaks": {}}'
``` ```
</TabItem>
</TabItem>
</Tabs> </Tabs>
## Generate a Langflow secret key ## Generate a Langflow secret key

123
docs/docs/Configuration/configuration-authentication.mdx
View file

@ -70,38 +70,39 @@ To generate a `LANGFLOW_SECRET_KEY`, follow these steps:
1. Run the command to generate and copy a secret to the clipboard. 1. Run the command to generate and copy a secret to the clipboard.
<Tabs> <Tabs>
<TabItem value="unix" label="macOS/Linux"> <TabItem value="linux-macos" label="Linux or macOS">
```bash ```bash
# Copy to clipboard (macOS) # Copy to clipboard (macOS)
python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | pbcopy python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | pbcopy
# Copy to clipboard (Linux) # Copy to clipboard (Linux)
python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | xclip -selection clipboard python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | xclip -selection clipboard
# Or just print # Or just print
python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')"
``` ```
</TabItem>
<TabItem value="windows" label="Windows"> </TabItem>
<TabItem value="Windows" label="Windows">
```bash ```bash
# Copy to clipboard # Copy to clipboard
python -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | clip python -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | clip
# Or just print # Or just print
python -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" python -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')"
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
2. Paste the value into your `.env` file: 2. Paste the value into your `.env` file:
```text
LANGFLOW_SECRET_KEY=dBuuuB_FHLvU8T9eUNlxQF9ppqRxwWpXXQ42kM2_fb ```text
``` LANGFLOW_SECRET_KEY=dBuuuB_FHLvU8T9eUNlxQF9ppqRxwWpXXQ42kM2_fb
```
### LANGFLOW_NEW_USER_IS_ACTIVE ### LANGFLOW_NEW_USER_IS_ACTIVE
@ -134,71 +135,73 @@ LANGFLOW_NEW_USER_IS_ACTIVE=False
2. Generate a secret key for encrypting sensitive data. 2. Generate a secret key for encrypting sensitive data.
Generate your secret key using one of the following commands: Generate your secret key using one of the following commands:
<Tabs> <Tabs>
<TabItem value="unix" label="macOS/Linux"> <TabItem value="linux-macos" label="Linux or macOS">
```bash ```bash
# Copy to clipboard (macOS) # Copy to clipboard (macOS)
python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | pbcopy python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | pbcopy
# Copy to clipboard (Linux) # Copy to clipboard (Linux)
python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | xclip -selection clipboard python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | xclip -selection clipboard
# Or just print # Or just print
python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" python3 -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')"
``` ```
</TabItem>
<TabItem value="windows" label="Windows"> </TabItem>
<TabItem value="Windows" label="Windows">
```bash ```bash
# Copy to clipboard # Copy to clipboard
python -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | clip python -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" | clip
# Or just print # Or just print
python -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')" python -c "from secrets import token_urlsafe; print(f'LANGFLOW_SECRET_KEY={token_urlsafe(32)}')"
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
3. Paste your `LANGFLOW_SECRET_KEY` into the `.env` file. 3. Paste your `LANGFLOW_SECRET_KEY` into the `.env` file.
4. Start Langflow with the configuration from your `.env` file. 4. Start Langflow with the configuration from your `.env` file.
```text ```text
uv run langflow run --env-file .env uv run langflow run --env-file .env
``` ```
5. Verify the server is running. The default location is `http://localhost:7860`. 5. Verify the server is running. The default location is `http://localhost:7860`.
### Manage users as an administrator ### Manage users as an administrator
1. To complete your first-time login as a superuser, go to `http://localhost:7860/login`. 1. To complete your first-time login as a superuser, go to `http://localhost:7860/login`.
2. Log in with your superuser credentials: 2. Log in with your superuser credentials.
* Username: Value of `LANGFLOW_SUPERUSER` (for example, `administrator`)
* Password: Value of `LANGFLOW_SUPERUSER_PASSWORD` (for example, `securepassword`)
:::info * Username: Value of `LANGFLOW_SUPERUSER` (for example, `administrator`)
The default values are `langflow` and `langflow`. * Password: Value of `LANGFLOW_SUPERUSER_PASSWORD` (for example, `securepassword`)
:::
The default values are both `langflow`.
3. To manage users on your server, navigate to the `/admin` page at `http://localhost:7860/admin`. 3. To manage users on your server, navigate to the `/admin` page at `http://localhost:7860/admin`.
Click your user profile image, and then click **Admin Page**.
As a superuser, you can create users, set permissions, reset passwords, and delete accounts. Click your user profile image, and then click **Admin Page**.
As a superuser, you can create users, set permissions, reset passwords, and delete accounts.
4. To create a user, in the Langflow UI, click **New User**, and then complete the following fields: 4. To create a user, in the Langflow UI, click **New User**, and then complete the following fields:
* **Username**
* **Password** and **Confirm Password** * **Username**
* Select **Active** and deselect **Superuser** for the new user. * **Password** and **Confirm Password**
**Active** users can log into the system and access their flows. **Inactive** users cannot log in or see their flows. * Select **Active** and deselect **Superuser** for the new user.
A **Superuser** has full administrative privileges. **Active** users can log into the system and access their flows. **Inactive** users cannot log in or see their flows.
A **Superuser** has full administrative privileges.
5. To complete user creation, click **Save**. 5. To complete user creation, click **Save**.
Your new user appears in the **Admin Page**. Your new user appears in the **Admin Page**.
6. To confirm your new user's functionality, log out of Langflow, and log back in with your new user's credentials. 6. To confirm your new user's functionality, log out of Langflow, and log back in with your new user's credentials.
Attempt to access the `/admin` page. You should be redirected to the `/flows` page, because the new user is not a superuser. Attempt to access the `/admin` page. You should be redirected to the `/flows` page, because the new user is not a superuser.

7
docs/docs/Configuration/configuration-global-variables.mdx
View file

@ -77,7 +77,6 @@ Langflow's [default global variables](#default-environment-variables) are alread
You can extend this list by setting `LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT` with your additional variables. You can extend this list by setting `LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT` with your additional variables.
<Tabs> <Tabs>
<TabItem value="local" label="Local" default> <TabItem value="local" label="Local" default>
If you installed Langflow locally, you must define the `LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT` environment variable in a `.env` file. If you installed Langflow locally, you must define the `LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT` environment variable in a `.env` file.
@ -107,11 +106,9 @@ If you installed Langflow locally, you must define the `LANGFLOW_VARIABLES_TO_GE
VARIABLE1="VALUE1" VARIABLE2="VALUE2" python -m langflow run --env-file .env VARIABLE1="VALUE1" VARIABLE2="VALUE2" python -m langflow run --env-file .env
``` ```
:::note
In this example, the environment variables (`VARIABLE1="VALUE1"` and `VARIABLE2="VALUE2"`) are prefixed to the startup command. In this example, the environment variables (`VARIABLE1="VALUE1"` and `VARIABLE2="VALUE2"`) are prefixed to the startup command.
This is a rudimentary method for exposing environment variables to Python on the command line, and is meant for illustrative purposes. This is a rudimentary method for exposing environment variables to Python on the command line, and is meant for illustrative purposes.
Make sure to expose your environment variables to Langflow in a manner that best suits your own environment. Make sure to expose your environment variables to Langflow in a manner that best suits your own environment.
:::
5. Confirm that Langflow successfully sourced the global variables from the environment: 5. Confirm that Langflow successfully sourced the global variables from the environment:
@ -120,7 +117,6 @@ If you installed Langflow locally, you must define the `LANGFLOW_VARIABLES_TO_GE
2. Click **Global Variables**, and then make sure that your environment variables appear in the **Global Variables** list. 2. Click **Global Variables**, and then make sure that your environment variables appear in the **Global Variables** list.
</TabItem> </TabItem>
<TabItem value="docker" label="Docker"> <TabItem value="docker" label="Docker">
If you're using Docker, you can pass `LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT` directly from the command line or from a `.env` file. If you're using Docker, you can pass `LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT` directly from the command line or from a `.env` file.
@ -148,7 +144,6 @@ docker run -it --rm \
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
:::info :::info
@ -160,7 +155,6 @@ When adding global variables from the environment, the following limitations app
- Global variables that you add from the environment always have the **Credential** type. - Global variables that you add from the environment always have the **Credential** type.
::: :::
If you want to explicitly prevent Langflow from sourcing global variables from the environment, set `LANGFLOW_STORE_ENVIRONMENT_VARIABLES` to `false` in your `.env` file: If you want to explicitly prevent Langflow from sourcing global variables from the environment, set `LANGFLOW_STORE_ENVIRONMENT_VARIABLES` to `false` in your `.env` file:
```text ```text
@ -205,5 +199,4 @@ Langflow automatically detects and converts some environment variables into glob
- `VECTARA_CORPUS_ID` - `VECTARA_CORPUS_ID`
- `VECTARA_CUSTOMER_ID` - `VECTARA_CUSTOMER_ID`
For information about other environment variables and their usage, see [Environment Variables](/environment-variables). For information about other environment variables and their usage, see [Environment Variables](/environment-variables).

65
docs/docs/Configuration/environment-variables.mdx
View file

@ -25,28 +25,30 @@ If you choose to use both sources together, be aware that environment variables
Run the following commands to set environment variables for your current terminal session: Run the following commands to set environment variables for your current terminal session:
<Tabs> <Tabs>
<TabItem value="linux-macos" label="Linux or macOS" default> <TabItem value="linux-macos" label="Linux or macOS" default>
```bash ```bash
export VARIABLE_NAME='VALUE' export VARIABLE_NAME='VALUE'
``` ```
</TabItem>
</TabItem>
<TabItem value="windows" label="Windows"> <TabItem value="windows" label="Windows">
``` ```
set VARIABLE_NAME='VALUE' set VARIABLE_NAME='VALUE'
``` ```
</TabItem>
</TabItem>
<TabItem value="docker" label="Docker"> <TabItem value="docker" label="Docker">
```bash ```bash
docker run -it --rm \ docker run -it --rm \
-p 7860:7860 \ -p 7860:7860 \
-e VARIABLE_NAME='VALUE' \ -e VARIABLE_NAME='VALUE' \
langflowai/langflow:latest langflowai/langflow:latest
``` ```
</TabItem>
</TabItem>
</Tabs> </Tabs>
When you start Langflow, it looks for environment variables that you've set in your terminal. When you start Langflow, it looks for environment variables that you've set in your terminal.
@ -249,7 +251,7 @@ The following table lists the environment variables supported by Langflow.
The following examples show how to configure Langflow using environment variables in different scenarios. The following examples show how to configure Langflow using environment variables in different scenarios.
<Tabs> <Tabs>
<TabItem value="env" label=".env File" default> <TabItem value="env" label=".env file" default>
The `.env` file is a text file that contains key-value pairs of environment variables. The `.env` file is a text file that contains key-value pairs of environment variables.
@ -406,8 +408,8 @@ For macOS, this means any GUI-based app launched from Finder, Spotlight, Launchp
To set environment variables for Langflow Desktop, you need to use specific commands or files, depending on your OS. To set environment variables for Langflow Desktop, you need to use specific commands or files, depending on your OS.
<Tabs groupId=""> <Tabs>
<TabItem value="macOS" label="macOS" default> <TabItem value="macos" label="macOS" default>
Langflow Desktop for macOS cannot automatically use variables set in your terminal, such as those in`.zshrc` or `.bash_profile`, when launched from the macOS GUI. Langflow Desktop for macOS cannot automatically use variables set in your terminal, such as those in`.zshrc` or `.bash_profile`, when launched from the macOS GUI.
@ -415,20 +417,21 @@ To make environment variables available to GUI apps on macOS, you need to use `l
1. Create the `LaunchAgents` directory if it doesn't exist: 1. Create the `LaunchAgents` directory if it doesn't exist:
```bash ```bash
mkdir -p ~/Library/LaunchAgents mkdir -p ~/Library/LaunchAgents
``` ```
2. In the `LaunchAgents` directory, create a `.plist` file called `dev.langflow.env`. 2. In the `LaunchAgents` directory, create a `.plist` file called `dev.langflow.env`.
3. Add the following content to `dev.langflow.env.plist`, and then add, change, or remove Langflow environment variables as needed for your configuration. 3. Add the following content to `dev.langflow.env.plist`, and then add, change, or remove Langflow environment variables as needed for your configuration.
This example sets the `LANGFLOW_CONFIG_DIR` environment variable for all GUI apps launched from the macOS GUI.
```xml This example sets the `LANGFLOW_CONFIG_DIR` environment variable for all GUI apps launched from the macOS GUI.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" ```xml
"http://www.apple.com/DTDs/PropertyList-1.0.dtd"> <?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0"> <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict> <dict>
<key>Label</key> <key>Label</key>
<string>dev.langflow.env</string> <string>dev.langflow.env</string>
@ -442,16 +445,17 @@ This example sets the `LANGFLOW_CONFIG_DIR` environment variable for all GUI app
<key>RunAtLoad</key> <key>RunAtLoad</key>
<true/> <true/>
</dict> </dict>
</plist> </plist>
``` ```
4. Load the file with `launchctl`: 4. Load the file with `launchctl`:
```bash
launchctl load ~/Library/LaunchAgents/dev.langflow.env.plist
```
</TabItem> ```bash
<TabItem value="System Properties" label="System Properties"> launchctl load ~/Library/LaunchAgents/dev.langflow.env.plist
```
</TabItem>
<TabItem value="windows1" label="Window System Properties">
Langflow Desktop for Windows cannot automatically use variables set in your terminal, such as those defined with `set` in `cmd` or `$env:VAR=...` in PowerShell, when launched from the Windows GUI. Langflow Desktop for Windows cannot automatically use variables set in your terminal, such as those defined with `set` in `cmd` or `$env:VAR=...` in PowerShell, when launched from the Windows GUI.
@ -462,16 +466,18 @@ To set environment variables using the System Properties interface, do the follo
1. Press <kbd>Win + R</kbd>, enter `SystemPropertiesAdvanced`, and then press <kbd>Enter</kbd>. 1. Press <kbd>Win + R</kbd>, enter `SystemPropertiesAdvanced`, and then press <kbd>Enter</kbd>.
2. Click **Environment Variables**. 2. Click **Environment Variables**.
3. Under **User variables**, click **New**. 3. Under **User variables**, click **New**.
:::tip
To apply the setting to all users, select **System variables**. :::tip
::: To apply the setting to all users, select **System variables**.
:::
4. Enter the name of the Langflow variable you want to set, such as `LANGFLOW_CONFIG_DIR`, and the desired value, such as `C:\Users\your_user\.langflow_config`. 4. Enter the name of the Langflow variable you want to set, such as `LANGFLOW_CONFIG_DIR`, and the desired value, such as `C:\Users\your_user\.langflow_config`.
5. Click **OK** to save the variable. 5. Click **OK** to save the variable.
6. Repeat until you have set all necessary Langflow environment variables. 6. Repeat until you have set all necessary Langflow environment variables.
7. Launch or restart Langflow Desktop to apply the environment variables. 7. Launch or restart Langflow Desktop to apply the environment variables.
</TabItem> </TabItem>
<TabItem value="Powershell" label="Powershell"> <TabItem value="windows2" label="Powershell">
To define environment variables for Windows using PowerShell, do the following: To define environment variables for Windows using PowerShell, do the following:
@ -489,5 +495,6 @@ To define environment variables for Windows using PowerShell, do the following:
2. Repeat until you have set all necessary Langflow environment variables. 2. Repeat until you have set all necessary Langflow environment variables.
3. Launch or restart Langflow Desktop to apply the environment variables. 3. Launch or restart Langflow Desktop to apply the environment variables.
</TabItem>
</TabItem>
</Tabs> </Tabs>

186
docs/docs/Contributing/contributing-how-to-contribute.mdx
View file

@ -39,73 +39,65 @@ Replace the following:
### Run Langflow from source ### Run Langflow from source
If you're not developing, but want to run Langflow from source after cloning the repo, run the following commands. You can run Langflow from source after cloning the repository, even if you're not contributing to the codebase.
<Tabs groupId="os"> <details>
<TabItem value="macOS/Linux" label="macOS/Linux" default> <summary>Run from source on macOS/Linux</summary>
1. To run Langflow from source, run the following command: In your terminal, navigate to the root of the Langflow directory, and then run `make run_cli`.
```bash
make run_cli
```
This command does the following: This command does the following:
- Installs frontend and backend dependencies
- Builds the frontend static files
- Starts the application with default settings
The Langflow frontend is available at `http://localhost:7860/`. - Installs frontend and backend dependencies
- Builds the frontend static files
- Starts the application with default settings
</TabItem> The Langflow frontend is served at `http://localhost:7860`.
<TabItem value="Windows" label="Windows">
To run Langflow from source on Windows, you can use the Langflow project's included scripts, or run the commands in the terminal. </details>
1. To run Langflow with the included scripts, navigate to the `scripts/windows` directory. <details>
Two scripts are available to install and start Langflow. <summary>Run from source with Windows CMD</summary>
2. Run Langflow with one of the scripts. To run Langflow from source on Windows, you can use the Langflow project's included scripts, or run the commands in the terminal.
<Tabs groupId="windows-shell"> Do one of the following:
<TabItem value="Windows CMD" label="Windows CMD" default>
To install and start Langflow with a Windows Batch file, double-click `build_and_run.bat`. * To install and run Langflow with the included Windows Batch file, navigate to the `scripts/windows` directory, and then run the `build_and_run.bat` file.
</TabItem> * To run Langflow from the Windows Command Line:
<TabItem value="Powershell" label="Powershell">
To install and start Langflow with the Powershell script, run: 1. Build the Langflow frontend:
```ps
.\build_and_run.ps1
```
</TabItem>
</Tabs>
**Alternatively**, to run Langflow from source with the Windows Command Line or Powershell, do the following.
<Tabs groupId="windows-shell">
<TabItem value="Windows CMD" label="Windows CMD" default>
1. Run the following commands to build the Langflow frontend.
``` ```
cd src/frontend && npm install && npm run build && npm run start cd src/frontend && npm install && npm run build && npm run start
``` ```
2. Copy the contents of the built `src/frontend/build` directory to `src/backend/base/langflow/frontend`. 2. Copy the contents of the built `src/frontend/build` directory to `src/backend/base/langflow/frontend`.
3. To start Langflow, run the following command. 3. Start Langflow:
``` ```
uv run langflow run uv run langflow run
``` ```
The frontend is served at http://localhost:7860. The Langflow frontend is served at `http://localhost:7860`.
</TabItem> </details>
<TabItem value="Powershell" label="Powershell">
<details>
<summary>Run from source with Powershell</summary>
To run Langflow from source on Windows, you can use the Langflow project's included scripts, or run the commands in the terminal.
Do one of the following:
* To install and run Langflow with the included scripts, navigate to the `scripts/windows` directory, and then run the `build_and_run.ps1` file.
* To run Langflow from a Powershell terminal:
1. Run the following commands separately to build the Langflow frontend:
1. Run the following commands to build the Langflow frontend.
``` ```
cd src/frontend cd src/frontend
npm install npm install
@ -115,30 +107,29 @@ If you're not developing, but want to run Langflow from source after cloning the
2. Copy the contents of the built `src/frontend/build` directory to `src/backend/base/langflow/frontend`. 2. Copy the contents of the built `src/frontend/build` directory to `src/backend/base/langflow/frontend`.
3. To start Langflow, run the following command. 3. Start Langflow:
``` ```
uv run langflow run uv run langflow run
``` ```
The frontend is served at http://localhost:7860. The Langflow frontend is served at `http://localhost:7860`.
</TabItem> </details>
</Tabs>
</TabItem>
</Tabs>
### Set up your Langflow development environment ### Set up your Langflow development environment
<Tabs groupId="os"> <Tabs>
<TabItem value="macOS/Linux" label="macOS/Linux" default> <TabItem value="linux-macos" label="Linux or macOS" default>
1. Set up the Langflow development environment:
1. To set up the Langflow development environment, run the following command:
```bash ```bash
make init make init
``` ```
This command sets up the development environment by doing the following: This command sets up the development environment by doing the following:
- Checking for uv and npm. - Checking for uv and npm.
- Installing backend and frontend dependencies. - Installing backend and frontend dependencies.
- Installing pre-commit hooks. - Installing pre-commit hooks.
@ -148,37 +139,39 @@ If you're not developing, but want to run Langflow from source after cloning the
```bash ```bash
# Run backend in development mode (includes hot reload) # Run backend in development mode (includes hot reload)
make backend make backend
```
```bash
# In another terminal, run frontend in development mode (includes hot reload) # In another terminal, run frontend in development mode (includes hot reload)
make frontend make frontend
``` ```
The frontend is served at `http://localhost:7860`.
The `make backend` and `make frontend` commands automatically install dependencies, so you don't need to run install commands separately. The `make backend` and `make frontend` commands automatically install dependencies, so you don't need to run install commands separately.
3. Optional: Install pre-commit hooks to help keep your changes clean and well-formatted. `make init` installs pre-commit hooks automatically. The frontend is served at `http://localhost:7860`.
3. Optional: Install pre-commit hooks to help keep your changes clean and well-formatted.
With pre-commit hooks installed, you must use `uv run git commit` instead of `git commit` directly.
`make init` installs pre-commit hooks automatically, or you can run the following command to install them manually:
```bash ```bash
uv sync uv sync
uv run pre-commit install uv run pre-commit install
``` ```
:::note 4. To test your changes before pushing commits, run `make lint`, `make format`, and `make unit_tests`.
With pre-commit hooks installed, you need to use `uv run git commit` instead of `git commit` directly. To run all tests, including coverage, unit, and integration, tests, run `make tests`.
:::
4. To test your changes, run `make lint`, `make format`, and `make unit_tests` before pushing to the repository. </TabItem>
To run all tests, including unit tests, integration tests, and coverage, run `make tests`. <TabItem value="Windows" label="Windows">
</TabItem>
<TabItem value="Windows" label="Windows">
Since Windows does not include `make`, building and running Langflow from source uses `npm` and `uv`. Since Windows does not include `make`, building and running Langflow from source uses `npm` and `uv`.
To set up the Langflow development environment, run the frontend and backend in separate terminals. To set up the Langflow development environment, run the frontend and backend in separate terminals:
1. To run the frontend, run the following commands. 1. To run the frontend, run the following commands:
```bash ```bash
cd src/frontend cd src/frontend
@ -186,7 +179,7 @@ To set up the Langflow development environment, run the frontend and backend in
npm run start npm run start
``` ```
2. To run the backend, run the following command. 2. In a separate terminal, run the following command to run the backend:
```bash ```bash
uv run langflow run --backend-only uv run langflow run --backend-only
@ -194,7 +187,7 @@ To set up the Langflow development environment, run the frontend and backend in
The frontend is served at `http://localhost:7860`. The frontend is served at `http://localhost:7860`.
</TabItem> </TabItem>
</Tabs> </Tabs>
### Debug ### Debug
@ -213,40 +206,49 @@ For more information, see the [VSCode documentation](https://code.visualstudio.c
## Contribute documentation ## Contribute documentation
The documentation is built using [Docusaurus](https://docusaurus.io/) and written in [Markdown](https://docusaurus.io/docs/markdown-features). The documentation is built using [Docusaurus](https://docusaurus.io/) and written in [Markdown](https://docusaurus.io/docs/markdown-features).
Contributions should follow the [Google Developer Documentation Style Guide](https://developers.google.com/style). For style guidance, see the [Google Developer Documentation Style Guide](https://developers.google.com/style).
### Prerequisites 1. Install [Node.js](https://nodejs.org/en/download/package-manager) and [Yarn](https://yarnpkg.com/)
* [Node.js](https://nodejs.org/en/download/package-manager) 2. Fork the [Langflow GitHub repository](https://github.com/langflow-ai/langflow).
* [Yarn](https://yarnpkg.com/)
### Clone the Langflow repository 3. Add the new remote to your local repository on your local machine:
1. Fork the [Langflow GitHub repository](https://github.com/langflow-ai/langflow). ```bash
git remote add FORK_NAME https://github.com/GIT_USERNAME/langflow.git
```
2. Add the new remote to your local repository on your local machine: Replace the following:
```bash
git remote add FORK_NAME https://github.com/GIT_USERNAME/langflow.git
```
Replace the following:
* `FORK_NAME`: A name for your fork of the repository
* `GIT_USERNAME`: Your Git username
3. From your Langflow fork's root, change directory to the `langflow/docs` folder with the following command: * `FORK_NAME`: A name for your fork of the repository
```bash * `GIT_USERNAME`: Your Git username
cd docs
```
4. To install dependencies and start a local Docusaurus static site with hot reloading, run: 4. From the root of your local Langflow fork, change to the `/docs` directory:
```bash
yarn install
yarn start
```
The documentation is available at `localhost:3000`. ```bash
The Markdown content files are located in the `langflow/docs/docs` folder. cd docs
```
5. Optional: Run `yarn build` to build the site locally and ensure there are no broken links. 5. Install dependencies and start a local Docusaurus static site with hot reload:
```bash
yarn install
yarn start
```
The documentation is served at `localhost:3000`.
6. To edit and create content, work with the `.mdx` files in the `langflow/docs/docs` directory.
Create new files in `.mdx` format.
Navigation is defined in `langflow/docs/sidebars.js`.
Most pages use a `slug` for shorthand cross-referencing, rather than supplying the full or relative directory path.
For example, if a page has a `slug` of `/cool-page`, you can link to it with `[Cool page](/cool-page)` from any other `/docs` page.
7. Recommended: After making some changes, run `yarn build` to build the site locally with more robust logging.
This can help you find broken links before creating a PR.
## Open a pull request ## Open a pull request

4
docs/docs/Deployment/deployment-kubernetes-prod.mdx
View file

@ -111,7 +111,7 @@ For example, the [example flow JSON](https://raw.githubusercontent.com/langflow-
Instead, when importing the flow in the Langflow runtime, you can set the global variable in one of the following ways: Instead, when importing the flow in the Langflow runtime, you can set the global variable in one of the following ways:
<Tabs> <Tabs>
<TabItem value="values" label="Using values.yaml"> <TabItem value="values" label="values.yaml">
```yaml ```yaml
env: env:
@ -131,7 +131,7 @@ env:
``` ```
</TabItem> </TabItem>
<TabItem value="helm" label="Using Helm Commands"> <TabItem value="helm" label="Helm commands">
1. Create the secret: 1. Create the secret:
```shell ```shell

214
docs/docs/Develop/Clients/typescript-client.mdx
View file

@ -16,7 +16,7 @@ For the npm package, see [@datastax/langflow-client](https://www.npmjs.com/packa
To install the Langflow typescript client package, use one of the following commands: To install the Langflow typescript client package, use one of the following commands:
<Tabs groupId="package-manager"> <Tabs>
<TabItem value="npm" label="npm" default> <TabItem value="npm" label="npm" default>
```bash ```bash
@ -44,77 +44,79 @@ pnpm add @datastax/langflow-client
1. Import the client into your code. 1. Import the client into your code.
```tsx ```tsx
import { LangflowClient } from "@datastax/langflow-client"; import { LangflowClient } from "@datastax/langflow-client";
``` ```
2. Initialize a client object to interact with your server. 2. Initialize a `LangflowClient` object to interact with your server:
The `LangflowClient` object allows you to interact with the Langflow API.
Replace `BASE_URL` and `API_KEY` with values from your deployment. ```tsx
The default Langflow base URL is `http://localhost:7860`. const baseUrl = "BASE_URL";
To create an API key, see [API keys](/configuration-api-keys). const apiKey = "API_KEY";
const client = new LangflowClient({ baseUrl, apiKey });
```
```tsx Replace `BASE_URL` and `API_KEY` with values from your deployment.
const baseUrl = "BASE_URL"; The default Langflow base URL is `http://localhost:7860`.
const apiKey = "API_KEY"; To create an API key, see [API keys](/configuration-api-keys).
const client = new LangflowClient({ baseUrl, apiKey });
```
## Langflow TypeScript client quickstart ## Langflow TypeScript client quickstart
1. With your Langflow client initialized, submit a message to your Langflow server and receive a response. 1. With your Langflow client initialized, test the connection by calling your Langflow server.
This example uses the minimum values for sending a message and running your flow on a Langflow server, with no API keys.
Replace `baseUrl` and `flowId` with values from your deployment.
The `input` string is the message you're sending to your flow.
```tsx The following example runs a flow (`runFlow`) by sending the flow ID and a chat input string:
import { LangflowClient } from "@datastax/langflow-client";
const baseUrl = "http://localhost:7860"; ```tsx
const client = new LangflowClient({ baseUrl }); import { LangflowClient } from "@datastax/langflow-client";
async function runFlow() { const baseUrl = "http://localhost:7860";
const client = new LangflowClient({ baseUrl });
async function runFlow() {
const flowId = "aa5a238b-02c0-4f03-bc5c-cc3a83335cdf"; const flowId = "aa5a238b-02c0-4f03-bc5c-cc3a83335cdf";
const flow = client.flow(flowId); const flow = client.flow(flowId);
const input = "Is anyone there?"; const input = "Is anyone there?";
const response = await flow.run(input); const response = await flow.run(input);
console.log(response); console.log(response);
} }
runFlow().catch(console.error); runFlow().catch(console.error);
``` ```
<details open> Replace the following:
<summary>Response</summary>
``` * `baseUrl`: The URL of your Langflow server
FlowResponse { * `flowId`: The ID of the flow you want to run
* `input`: The chat input message you want to send to trigger the flow
2. Review the result to confirm that the client connected to your Langflow server.
The following example shows the response from a well-formed `runFlow` request that reached the Langflow server and successfully started the flow:
```
FlowResponse {
sessionId: 'aa5a238b-02c0-4f03-bc5c-cc3a83335cdf', sessionId: 'aa5a238b-02c0-4f03-bc5c-cc3a83335cdf',
outputs: [ { inputs: [Object], outputs: [Array] } ] outputs: [ { inputs: [Object], outputs: [Array] } ]
} }
``` ```
</details> In this case, the response includes a [`sessionID`](/session-id) that is a unique identifier for the client-server session and an `outputs` array that contains information about the flow run.
This confirms your client is connecting to Langflow. 3. If you want to get full response objects from the server, change `console.log` to stringify the returned JSON object:
* The `sessionID` value is a unique identifier for the client-server session. For more information, see [Session ID](/session-id).
* The `outputs` array contains the results of your flow execution.
2. To get the full response objects from your server, change the `console.log` code to stringify the returned JSON object: ```tsx
console.log(JSON.stringify(response, null, 2));
```
```tsx The exact structure of the returned `inputs` and `outputs` objects depends on the components and configuration of your flow.
console.log(JSON.stringify(response, null, 2));
```
The exact structure of the returned `inputs` and `outputs` depends on how your flow is configured in Langflow. 4. If you want the response to include only the chat message from the **Chat Output** component, change `console.log` to use the `chatOutputText` convenience function:
3. To get the first chat message returned from the chat output component, change `console.log` to use the `chatOutputText` convenience function. ```tsx
console.log(response.chatOutputText());
```tsx ```
console.log(response.chatOutputText());
```
## Use advanced TypeScript client features ## Use advanced TypeScript client features
@ -123,35 +125,45 @@ The TypeScript client can do more than just connect to your server and run a flo
This example builds on the quickstart with additional features for interacting with Langflow. This example builds on the quickstart with additional features for interacting with Langflow.
1. Pass tweaks to your code as an object with the request. 1. Pass tweaks to your code as an object with the request.
Tweaks change values within components for all calls to your flow.
This example tweaks the Open-AI model component to enforce using the `gpt-4o-mini` model.
```tsx
const tweaks = { model_name: "gpt-4o-mini" };
```
2. Pass a [session ID](/session-id) with the request to maintain the same conversation with the LLM from this application.
```tsx
const session_id = "aa5a238b-02c0-4f03-bc5c-cc3a83335cdf";
```
3. Instead of calling `run` on the Flow object, call `stream` with the same arguments.
The response is a [ReadableStream](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) of objects.
For more information on streaming Langflow responses, see the [/run endpoint](/api-flows-run#run-flow).
```tsx
const response = await client.flow(flowId).stream(input);
for await (const event of response) { Tweaks change values within components for all calls to your flow.
This example tweaks the Open-AI model component to enforce using the `gpt-4o-mini` model:
```tsx
const tweaks = { model_name: "gpt-4o-mini" };
```
2. Pass a [session ID](/session-id) with the request to separate the conversation from other flow runs, and to be able to continue this conversation by calling the same session ID in the future:
```tsx
const session_id = "aa5a238b-02c0-4f03-bc5c-cc3a83335cdf";
```
3. Instead of calling `run` on the Flow object, call `stream` with the same arguments:
```tsx
const response = await client.flow(flowId).stream(input);
for await (const event of response) {
console.log(event); console.log(event);
} }
``` ```
4. Run the completed TypeScript application to call your server with `tweaks` and `session_id`, and stream the response back.
The response is a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) of objects.
For more information on streaming Langflow responses, see the [`/run` endpoint](/api-flows-run#run-flow).
4. Run the modified TypeScript application to run the flow with `tweaks` and `session_id`, and then stream the response back.
Replace `baseUrl` and `flowId` with values from your deployment. Replace `baseUrl` and `flowId` with values from your deployment.
```tsx ```tsx
import { LangflowClient } from "@datastax/langflow-client"; import { LangflowClient } from "@datastax/langflow-client";
const baseUrl = "http://localhost:7860"; const baseUrl = "http://localhost:7860";
const client = new LangflowClient({ baseUrl }); const client = new LangflowClient({ baseUrl });
async function runFlow() { async function runFlow() {
const flowId = "aa5a238b-02c0-4f03-bc5c-cc3a83335cdf"; const flowId = "aa5a238b-02c0-4f03-bc5c-cc3a83335cdf";
const input = "Is anyone there?"; const input = "Is anyone there?";
const tweaks = { model_name: "gpt-4o-mini" }; const tweaks = { model_name: "gpt-4o-mini" };
@ -166,15 +178,20 @@ async function runFlow() {
console.log(event); console.log(event);
} }
} }
runFlow().catch(console.error); runFlow().catch(console.error);
``` ```
<details> Replace `baseUrl` and `flowId` with your server URL and flow ID, as you did in the previous run.
<summary>Response</summary>
```text <details>
{ <summary>Result</summary>
With streaming enabled, the response includes the flow metatadata and timestamped events for flow activity.
For example:
```text
{
event: 'add_message', event: 'add_message',
data: { data: {
timestamp: '2025-05-23 15:52:48 UTC', timestamp: '2025-05-23 15:52:48 UTC',
@ -202,53 +219,53 @@ runFlow().catch(console.error);
flow_id: 'aa5a238b-02c0-4f03-bc5c-cc3a83335cdf', flow_id: 'aa5a238b-02c0-4f03-bc5c-cc3a83335cdf',
duration: null duration: null
} }
} }
{ {
event: 'token', event: 'token',
data: { data: {
chunk: 'Absolutely', chunk: 'Absolutely',
id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5', id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5',
timestamp: '2025-05-23 15:52:48 UTC' timestamp: '2025-05-23 15:52:48 UTC'
} }
} }
{ {
event: 'token', event: 'token',
data: { data: {
chunk: ',', chunk: ',',
id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5', id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5',
timestamp: '2025-05-23 15:52:48 UTC' timestamp: '2025-05-23 15:52:48 UTC'
} }
} }
{ {
event: 'token', event: 'token',
data: { data: {
chunk: " I'm", chunk: " I'm",
id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5', id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5',
timestamp: '2025-05-23 15:52:48 UTC' timestamp: '2025-05-23 15:52:48 UTC'
} }
} }
{ {
event: 'token', event: 'token',
data: { data: {
chunk: ' here', chunk: ' here',
id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5', id: 'c5a99314-6b23-488b-84e2-038aa3e87fb5',
timestamp: '2025-05-23 15:52:48 UTC' timestamp: '2025-05-23 15:52:48 UTC'
} }
} }
// this response is abbreviated // this response is abbreviated
{ {
event: 'end', event: 'end',
data: { result: { session_id: 'test-session', outputs: [Array] } } data: { result: { session_id: 'test-session', outputs: [Array] } }
} }
``` ```
</details> </details>
## Retrieve Langflow logs with the TypeScript client ## Retrieve Langflow logs with the TypeScript client
To retrieve Langflow logs, you must enable log retrieval on your Langflow server by including the following values in your server's `.env` file: To retrieve [Langflow logs](/logging), you must enable log retrieval on your Langflow server by including the following values in your server's `.env` file:
```text ```text
LANGFLOW_ENABLE_LOG_RETRIEVAL=true LANGFLOW_ENABLE_LOG_RETRIEVAL=true
@ -256,10 +273,7 @@ LANGFLOW_LOG_RETRIEVER_BUFFER_SIZE=10000
LANGFLOW_LOG_LEVEL=DEBUG LANGFLOW_LOG_LEVEL=DEBUG
``` ```
For more information, see [Logs endpoints](/api-logs). The following example script starts streaming logs in the background, and then runs a flow so you can monitor the flow run:
This complete example starts streaming logs in the background, and then runs a flow so you can see how a flow executes.
Replace `baseUrl` and `flowId` with values from your deployment.
```tsx ```tsx
import { LangflowClient } from "@datastax/langflow-client"; import { LangflowClient } from "@datastax/langflow-client";
@ -290,12 +304,16 @@ async function main() {
main().catch(console.error); main().catch(console.error);
``` ```
Replace `baseUrl` and `flowId` with your server URL and flow ID, as you did in the previous run.
Logs begin streaming indefinitely, and the flow runs once. Logs begin streaming indefinitely, and the flow runs once.
The logs below are abbreviated, but you can monitor how the flow instantiates its components, configures its model, and processes the outputs. The following example result is truncated for readability, but you can follow the messages to see how the flow instantiates its components, configures its model, and processes the outputs.
The `FlowResponse` object, at the end of the stream, is returned to the client with the flow result in the `outputs` array.
<details> <details>
<summary>Response</summary> <summary>Result</summary>
```text ```text
Starting log stream... Starting log stream...
@ -359,4 +377,4 @@ Log: Log {
</details> </details>
The `FlowResponse` object is returned to the client, with the `outputs` array including your flow result. For more information, see [Logs endpoints](/api-logs).

1
docs/docs/Develop/develop-application.mdx
View file

@ -206,6 +206,7 @@ For information about publishing your image on Docker Hub and running a Langflow
"session_id": "charizard_test_request" "session_id": "charizard_test_request"
}' }'
``` ```
<details> <details>
<summary>About this example</summary> <summary>About this example</summary>

136
docs/docs/Get-Started/get-started-installation.mdx
View file

@ -23,29 +23,29 @@ This option offers more control over the environment, dependencies, and versioni
Langflow Desktop is a desktop version of Langflow that simplifies dependency management and upgrades. Langflow Desktop is a desktop version of Langflow that simplifies dependency management and upgrades.
However, some features aren't available for Langflow Desktop, such as the **Shareable Playground**. However, some features aren't available for Langflow Desktop, such as the **Shareable Playground**.
<Tabs groupId="os"> <Tabs>
<TabItem value="macOS" label="macOS"> <TabItem value="macos" label="macOS">
1. Navigate to [Langflow Desktop](https://www.langflow.org/desktop). 1. Navigate to [Langflow Desktop](https://www.langflow.org/desktop).
2. Click **Download Langflow**, enter your contact information, and then click **Download**. 2. Click **Download Langflow**, enter your contact information, and then click **Download**.
3. Mount and install the Langflow application. 3. Mount and install the Langflow application.
4. When the installation completes, open the Langflow application, and then create your first flow with the [Quickstart](/get-started-quickstart). 4. When the installation completes, open the Langflow application, and then create your first flow with the [Quickstart](/get-started-quickstart).
</TabItem> </TabItem>
<TabItem value="Windows" label="Windows"> <TabItem value="Windows" label="Windows">
1. Navigate to [Langflow Desktop](https://www.langflow.org/desktop). 1. Navigate to [Langflow Desktop](https://www.langflow.org/desktop).
2. Click **Download Langflow**, enter your contact information, and then click **Download**. 2. Click **Download Langflow**, enter your contact information, and then click **Download**.
3. Open the **File Explorer**, and then navigate to **Downloads**. 3. Open the **File Explorer**, and then navigate to **Downloads**.
4. Double-click the downloaded `.msi` file, and then use the install wizard to install Langflow Desktop. 4. Double-click the downloaded `.msi` file, and then use the install wizard to install Langflow Desktop.
:::important :::important
Windows installations of Langflow Desktop require a C++ compiler that may not be present on your system. If you receive a `C++ Build Tools Required!` error, follow the on-screen prompt to install Microsoft C++ Build Tools, or [install Microsoft Visual Studio](https://visualstudio.microsoft.com/downloads/). Windows installations of Langflow Desktop require a C++ compiler that may not be present on your system. If you receive a `C++ Build Tools Required!` error, follow the on-screen prompt to install Microsoft C++ Build Tools, or [install Microsoft Visual Studio](https://visualstudio.microsoft.com/downloads/).
::: :::
5. When the installation completes, open the Langflow application, and then create your first flow with the [Quickstart](/get-started-quickstart). 5. When the installation completes, open the Langflow application, and then create your first flow with the [Quickstart](/get-started-quickstart).
</TabItem> </TabItem>
</Tabs> </Tabs>
For upgrade information, see the [Release notes](/release-notes). For upgrade information, see the [Release notes](/release-notes).
@ -78,57 +78,83 @@ For more information, see [Deploy Langflow on Docker](/deployment-docker).
- Windows: Version 3.10 to 3.12 - Windows: Version 3.10 to 3.12
- [uv](https://docs.astral.sh/uv/getting-started/installation/) - [uv](https://docs.astral.sh/uv/getting-started/installation/)
- Sufficient infrastructure: - Sufficient infrastructure:
- Minimum: Dual-core CPU and 2 GB RAM - Minimum: Dual-core CPU and 2 GB RAM
- Recommended: Multi-core CPU and at least 4 GB RAM - Recommended: Multi-core CPU and at least 4 GB RAM
2. Create a virtual environment with [uv](https://docs.astral.sh/uv/pip/environments). 2. Create a virtual environment with [uv](https://docs.astral.sh/uv/pip/environments).
<details> <details>
<summary>Need help with virtual environments?</summary> <summary>Need help with virtual environments?</summary>
Virtual environments ensure Langflow is installed in an isolated, fresh environment. Virtual environments ensure Langflow is installed in an isolated, fresh environment.
To create a new virtual environment, do the following. To create a new virtual environment, do the following.
<Tabs>
<TabItem value="linux-macos" label="Linux or macOS" default>
1. Navigate to where you want your virtual environment to be created, and then create it with `uv`:
```shell
uv venv VENV_NAME
```
Replace `VENV_NAME` with a name for your virtual environment.
2. Start the virtual environment:
```shell
source VENV_NAME/bin/activate
```
Your shell's prompt changes to display that you're currently working in a virtual environment:
```text
(VENV_NAME) ➜ langflow git:(main) ✗
```
3. To deactivate the virtual environment and return to your regular shell, type `deactivate`.
When activated, the virtual environment temporarily modifies your `PATH` variable to prioritize packages installed within the virtual environment.
To avoid conflicts with other projects, it's a good idea to deactivate your virtual environment when you're done working in it.
To delete the virtual environment, type `rm -rf VENV_NAME`.
This completely removes the virtual environment directory and its contents.
<Tabs groupId="os">
<TabItem value="macOS/Linux" label="macOS/Linux" default>
1. Navigate to where you want your virtual environment to be created, and create it with `uv`.
Replace `VENV_NAME` with your preferred name for your virtual environment.
```
uv venv VENV_NAME
```
2. Start the virtual environment.
```
source VENV_NAME/bin/activate
```
Your shell's prompt changes to display that you're currently working in a virtual environment.
```
(VENV_NAME) ➜ langflow git:(main) ✗
```
3. To deactivate the virtual environment and return to your regular shell, type `deactivate`.
When activated, the virtual environment temporarily modifies your PATH variable to prioritize packages installed within the virtual environment, so always deactivate it when you're done to avoid conflicts with other projects.
To delete the virtual environment, type `rm -rf VENV_NAME`.
</TabItem> </TabItem>
<TabItem value="Windows" label="Windows"> <TabItem value="Windows" label="Windows">
1. Navigate to where you want your virtual environment to be created, and create it with `uv`.
Replace `VENV_NAME` with your preferred name for your virtual environment. 1. Navigate to where you want your virtual environment to be created, and create it with `uv`.
```
uv venv VENV_NAME ```shell
``` uv venv VENV_NAME
2. Start the virtual environment. ```
```shell
VENV_NAME\Scripts\activate Replace `VENV_NAME` with a name for your virtual environment.
```
Your shell's prompt changes to display that you're currently working in a virtual environment. 2. Start the virtual environment:
```
(VENV_NAME) PS C:/users/username/langflow-dir> ```shell
``` VENV_NAME\Scripts\activate
3. To deactivate the virtual environment and return to your regular shell, type `deactivate`. ```
When activated, the virtual environment temporarily modifies your PATH variable to prioritize packages installed within the virtual environment, so always deactivate it when you're done to avoid conflicts with other projects.
To delete the virtual environment, type `Remove-Item VENV_NAME`. Your shell's prompt changes to display that you're currently working in a virtual environment:
```text
(VENV_NAME) PS C:/users/username/langflow-dir>
```
3. To deactivate the virtual environment and return to your regular shell, type `deactivate`.
When activated, the virtual environment temporarily modifies your `PATH` variable to prioritize packages installed within the virtual environment.
To avoid conflicts with other projects, it's a good idea to deactivate your virtual environment when you're done working in it.
To delete the virtual environment, type `Remove-Item VENV_NAME`.
This completely removes the virtual environment directory and its contents.
</TabItem> </TabItem>
</Tabs> </Tabs>
</details> </details>
3. In your virtual environment, install Langflow: 3. In your virtual environment, install Langflow:

37
docs/docs/Get-Started/get-started-quickstart.mdx
View file

@ -12,22 +12,22 @@ Get started with Langflow by loading a template flow, running it, and then servi
## Prerequisites ## Prerequisites
- [Install and start Langflow](/get-started-installation) - [Install and start Langflow](/get-started-installation)
- [Create an OpenAI API key](https://platform.openai.com/api-keys) - Create an [OpenAI API key](https://platform.openai.com/api-keys)
- [Create a Langflow API key](/configuration-api-keys) - Create a [Langflow API key](/configuration-api-keys)
<details> <details>
<summary>Create a Langflow API key</summary> <summary>Create a Langflow API key</summary>
A Langflow API key is a user-specific token you can use with Langflow. A Langflow API key is a user-specific token you can use with Langflow.
To create a Langflow API key, do the following: To create a Langflow API key, do the following:
1. In Langflow, click your user icon, and then select **Settings**. 1. In Langflow, click your user icon, and then select **Settings**.
2. Click **Langflow API Keys**, and then click <Icon name="Plus" aria-hidden="true"/> **Add New**. 2. Click **Langflow API Keys**, and then click <Icon name="Plus" aria-hidden="true"/> **Add New**.
3. Name your key, and then click **Create API Key**. 3. Name your key, and then click **Create API Key**.
4. Copy the API key and store it securely. 4. Copy the API key and store it securely.
5. To use your Langflow API key in a request, set a `LANGFLOW_API_KEY` environment variable in your terminal, and then include an `x-api-key` header or query parameter with your request. 5. To use your Langflow API key in a request, set a `LANGFLOW_API_KEY` environment variable in your terminal, and then include an `x-api-key` header or query parameter with your request.
For example: For example:
```bash ```bash
# Set variable # Set variable
@ -44,7 +44,8 @@ For example:
"input_value": "Hello" "input_value": "Hello"
}' }'
``` ```
</details>
</details>
## Run the Simple Agent template flow ## Run the Simple Agent template flow
@ -99,7 +100,7 @@ Langflow provides code snippets to help you get started with the Langflow API.
Replace these values if you're using the code for a different server or flow. Replace these values if you're using the code for a different server or flow.
The default Langflow server address is `http://localhost:7860`. The default Langflow server address is `http://localhost:7860`.
<Tabs groupId="Language"> <Tabs>
<TabItem value="Python" label="Python" default> <TabItem value="Python" label="Python" default>
```python ```python
@ -161,7 +162,6 @@ Langflow provides code snippets to help you get started with the Langflow API.
``` ```
</TabItem> </TabItem>
<TabItem value="curl" label="curl"> <TabItem value="curl" label="curl">
```bash ```bash
@ -179,7 +179,6 @@ Langflow provides code snippets to help you get started with the Langflow API.
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
2. Copy the snippet, paste it in a script file, and then run the script to send the request. 2. Copy the snippet, paste it in a script file, and then run the script to send the request.
@ -188,8 +187,8 @@ If you are using the curl snippet, you can run the command directly in your term
If the request is successful, the response includes many details about the flow run, including the session ID, inputs, outputs, components, durations, and more. If the request is successful, the response includes many details about the flow run, including the session ID, inputs, outputs, components, durations, and more.
The following is an example of a response from running the **Simple Agent** template flow: The following is an example of a response from running the **Simple Agent** template flow:
<details closed> <details>
<summary>Response</summary> <summary>Result</summary>
```json ```json
{ {
@ -367,7 +366,7 @@ The following example builds on the API pane's example code to create a question
1. Incorporate your **Simple Agent** flow's `/run` snippet into the following script. 1. Incorporate your **Simple Agent** flow's `/run` snippet into the following script.
This script runs a question-and-answer chat in your terminal and stores the Agent's previous answer so you can compare them. This script runs a question-and-answer chat in your terminal and stores the Agent's previous answer so you can compare them.
<Tabs groupId="Languages"> <Tabs>
<TabItem value="Python" label="Python" default> <TabItem value="Python" label="Python" default>
```python ```python

8
docs/docs/Integrations/Arize/integrations-arize.mdx
View file

@ -26,7 +26,7 @@ Instructions for integrating Langflow and Arize are also available in the Arize
## Connect Arize to Langflow ## Connect Arize to Langflow
<Tabs> <Tabs>
<TabItem value="Arize Platform" label="Arize Platform" default> <TabItem value="platform" label="Arize Platform" default>
1. In your [Arize dashboard](https://app.arize.com/), copy your **Space ID** and [**API Key (Ingestion Service Account Key)**](https://arize.com/docs/ax/security-and-settings/api-keys). 1. In your [Arize dashboard](https://app.arize.com/), copy your **Space ID** and [**API Key (Ingestion Service Account Key)**](https://arize.com/docs/ax/security-and-settings/api-keys).
@ -49,8 +49,8 @@ Instructions for integrating Langflow and Arize are also available in the Arize
uv run langflow run --env-file .env uv run langflow run --env-file .env
``` ```
</TabItem> </TabItem>
<TabItem value="Arize Phoenix" label="Arize Phoenix"> <TabItem value="phoenix" label="Arize Phoenix">
1. In your [Arize Phoenix dashboard](https://app.phoenix.arize.com/), copy your **API Key**. 1. In your [Arize Phoenix dashboard](https://app.phoenix.arize.com/), copy your **API Key**.
@ -70,7 +70,7 @@ Instructions for integrating Langflow and Arize are also available in the Arize
uv run langflow run --env-file .env uv run langflow run --env-file .env
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
## Run a flow and view metrics in Arize ## Run a flow and view metrics in Arize

61
docs/docs/Integrations/Docling/integrations-docling.mdx
View file

@ -49,12 +49,11 @@ The following sections describe the purpose and configuration options for each c
### Docling ### Docling
This component uses Docling to process input documents running the Docling models locally. The **Docling** component ingest documents, and then uses Docling to process them by running the Docling models locally.
<details> It outputs `files`, which is the processed files with `DoclingDocument` data.
<summary>Parameters</summary>
**Inputs** #### Docling parameters
| Name | Type | Description | | Name | Type | Description |
|------|------|-------------| |------|------|-------------|
@ -62,22 +61,13 @@ This component uses Docling to process input documents running the Docling model
| pipeline | String | Docling pipeline to use (standard, vlm). | | pipeline | String | Docling pipeline to use (standard, vlm). |
| ocr_engine | String | OCR engine to use (easyocr, tesserocr, rapidocr, ocrmac). | | ocr_engine | String | OCR engine to use (easyocr, tesserocr, rapidocr, ocrmac). |
**Outputs**
| Name | Type | Description |
|------|------|-------------|
| files | File | The processed files with DoclingDocument data. |
</details>
### Docling Serve ### Docling Serve
This component uses Docling to process input documents connecting to your instance of Docling Serve. The **Docling Serve** component ingests documents, and then uses Docling to process them by connecting to your instance of Docling Serve.
<details> It outputs `files`, which is the processed files with `DoclingDocument` data.
<summary>Parameters</summary>
**Inputs** #### Docling Serve parameters
| Name | Type | Description | | Name | Type | Description |
|------|------|-------------| |------|------|-------------|
@ -88,22 +78,13 @@ This component uses Docling to process input documents connecting to your instan
| api_headers | Dict | Optional dictionary of additional headers required for connecting to Docling Serve. | | api_headers | Dict | Optional dictionary of additional headers required for connecting to Docling Serve. |
| docling_serve_opts | Dict | Optional dictionary of additional options for Docling Serve. | | docling_serve_opts | Dict | Optional dictionary of additional options for Docling Serve. |
**Outputs**
| Name | Type | Description |
|------|------|-------------|
| files | File | The processed files with DoclingDocument data. |
</details>
### Chunk DoclingDocument ### Chunk DoclingDocument
This component uses the DoclingDocument chunkers to split a document into chunks. The **Chunk DoclingDocument** component uses the `DoclingDocument` chunkers to split a document into chunks.
<details> It outputs the chunked documents as a [`DataFrame`](/data-types#dataframe).
<summary>Parameters</summary>
**Inputs** #### Chunk DoclingDocument parameters
| Name | Type | Description | | Name | Type | Description |
|------|------|-------------| |------|------|-------------|
@ -115,22 +96,13 @@ This component uses the DoclingDocument chunkers to split a document into chunks
| max_tokens | Integer | Maximum number of tokens for the HybridChunker. | | max_tokens | Integer | Maximum number of tokens for the HybridChunker. |
| doc_key | String | The key to use for the DoclingDocument column. | | doc_key | String | The key to use for the DoclingDocument column. |
**Outputs**
| Name | Type | Description |
|------|------|-------------|
| dataframe | DataFrame | The chunked documents as a DataFrame. |
</details>
### Export DoclingDocument ### Export DoclingDocument
This component exports DoclingDocument to Markdown, HTML, and other formats. The **Export DoclingDocument** component exports `DoclingDocument` to Markdown, HTML, and other formats.
<details> It can output the exported data as either [`Data`](/data-types#data) or [`DataFrame`](/data-types#dataframe).
<summary>Parameters</summary>
**Inputs** #### Export DoclingDocument parameters
| Name | Type | Description | | Name | Type | Description |
|------|------|-------------| |------|------|-------------|
@ -140,12 +112,3 @@ This component exports DoclingDocument to Markdown, HTML, and other formats.
| md_image_placeholder | String | Specify the image placeholder for markdown exports. | | md_image_placeholder | String | Specify the image placeholder for markdown exports. |
| md_page_break_placeholder | String | Add this placeholder between pages in the markdown output. | | md_page_break_placeholder | String | Add this placeholder between pages in the markdown output. |
| doc_key | String | The key to use for the DoclingDocument column. | | doc_key | String | The key to use for the DoclingDocument column. |
**Outputs**
| Name | Type | Description |
|------|------|-------------|
| data | Data | The exported data. |
| dataframe | DataFrame | The exported data as a DataFrame. |
</details>

18
docs/docs/Integrations/Google/integrations-google-big-query.mdx
View file

@ -48,12 +48,12 @@ The BigQuery component can now query your datasets and tables using your service
With your component credentials configured, query your BigQuery datasets and tables to confirm connectivity. With your component credentials configured, query your BigQuery datasets and tables to confirm connectivity.
1. Connect **Chat Input** and **Chat Output** components to the BigQuery component. 1. Connect **Chat Input** and **Chat Output** components to the BigQuery component.
The flow looks like this:
![BigQuery component connected to chat input and output](/img/google/integrations-bigquery.png) ![BigQuery component connected to chat input and output](/img/google/integrations-bigquery.png)
2. Open the **Playground**, and then submit a valid SQL query. 2. Open the **Playground**, and then submit a valid SQL query.
This example queries a table of Oscar winners stored within a BigQuery dataset called `the_oscar_award`.
<Tabs> This example queries a table of Oscar winners stored within a BigQuery dataset called `the_oscar_award`:
<TabItem value="sql query" label="SQL query" default>
```sql ```sql
SELECT film, category, year_film SELECT film, category, year_film
@ -62,8 +62,8 @@ This example queries a table of Oscar winners stored within a BigQuery dataset c
LIMIT 10 LIMIT 10
``` ```
</TabItem> <details>
<TabItem value="result" label="Result"> <summary>Result</summary>
```text ```text
film category year_film film category year_film
@ -78,7 +78,7 @@ This example queries a table of Oscar winners stored within a BigQuery dataset c
Wings OUTSTANDING PICTURE 1927 Wings OUTSTANDING PICTURE 1927
Sunrise UNIQUE AND ARTISTIC PICTURE 1927 Sunrise UNIQUE AND ARTISTIC PICTURE 1927
``` ```
</TabItem>
</Tabs> </details>
A successful chat confirms the component can access the BigQuery table. A successful chat confirms the component can access the BigQuery table.

12
docs/docs/Tutorials/agent.mdx
View file

@ -139,11 +139,13 @@ If not, modify the `const email = "isabella.rodriguez@example.com"` to search fo
``` ```
3. Save and run the script to send the request and test the flow. 3. Save and run the script to send the request and test the flow.
Your application receives three URLs for recommended used items based on a customer's previous orders in your local CSV, all without changing any code.
<details closed>
<summary>Response</summary>
The following is an example of a response returned from this tutorial's flow. Due to the nature of LLMs and variations in your inputs, your response might be different. Your application receives three URLs for recommended used items based on a customer's previous orders in your local CSV, all without changing any code.
<details>
<summary>Result</summary>
The following is an example response from this tutorial's flow. Due to the nature of LLMs and variations in your inputs, your response might be different.
``` ```
Starting Langflow Agent... Starting Langflow Agent...
@ -166,7 +168,7 @@ If not, modify the `const email = "isabella.rodriguez@example.com"` to search fo
</details> </details>
4. To quickly check traffic to your flow, open the **Playground**. 4. To quickly check traffic to your flow, open the **Playground**.
New sessions appear named after the user's email address. New sessions are named after the user's email address.
Keeping sessions distinct helps the agent maintain context. For more on session IDs, see [Session ID](/session-id). Keeping sessions distinct helps the agent maintain context. For more on session IDs, see [Session ID](/session-id).
## Next steps ## Next steps

13
docs/docs/Tutorials/chat-with-files.mdx
View file

@ -146,10 +146,13 @@ For help with constructing file upload requests in Python, JavaScript, and curl,
3. Save and run the script to send the requests and test the flow. 3. Save and run the script to send the requests and test the flow.
<details> The initial output contains the JSON response object from the file upload endpoint, including the internal path where Langflow stores the file.
<summary>Response</summary> Then, the LLM retrieves the file and evaluates its content, in this case the suitability of the resume for a job position.
The following is an example of a response returned from this tutorial's flow. Due to the nature of LLMs and variations in your inputs, your response might be different. <details>
<summary>Result</summary>
The following is an example response from this tutorial's flow. Due to the nature of LLMs and variations in your inputs, your response might be different.
``` ```
{"id":"793ba3d8-5e7a-4499-8b89-d9a7b6325fee","name":"fake-resume (1)","path":"02791d46-812f-4988-ab1c-7c430214f8d5/fake-resume.txt","size":1779,"provider":null} {"id":"793ba3d8-5e7a-4499-8b89-d9a7b6325fee","name":"fake-resume (1)","path":"02791d46-812f-4988-ab1c-7c430214f8d5/fake-resume.txt","size":1779,"provider":null}
@ -179,10 +182,6 @@ For help with constructing file upload requests in Python, JavaScript, and curl,
</details> </details>
The initial output contains the JSON response object from the file upload endpoint, including the internal path where Langflow stores the file.
The LLM then retrieves this file and evaluates its content, in this case the suitability of the resume for a job position.
## Next steps ## Next steps
To continue building on this tutorial, try these next steps. To continue building on this tutorial, try these next steps.

69
docs/docs/Tutorials/chat-with-rag.mdx
View file

@ -60,42 +60,42 @@ The Langflow UI option is simpler, but it is only recommended for scenarios wher
In situations where many users load data or you need to load data programmatically, use the Langflow API option. In situations where many users load data or you need to load data programmatically, use the Langflow API option.
<Tabs> <Tabs>
<TabItem value="UI" label="UI" default> <TabItem value="UI" label="Langflow UI" default>
1. In your RAG chatbot flow, click the **File component**, and then click **File**. 1. In your RAG chatbot flow, click the **File component**, and then click **File**.
2. Select the local file you want to upload, and then click **Open**. 2. Select the local file you want to upload, and then click **Open**.
The file is loaded to your Langflow server. The file is loaded to your Langflow server.
3. To load the data into your vector store, click the vector store component, and then click <Icon name="Play" aria-hidden="true" /> **Run component** to run the selected component and all prior dependent components. 3. To load the data into your vector store, click the vector store component, and then click <Icon name="Play" aria-hidden="true" /> **Run component** to run the selected component and all prior dependent components.
</TabItem> </TabItem>
<TabItem value="API" label="API"> <TabItem value="API" label="Langflow API">
To load data programmatically, use the `/v2/files/` and `/v1/run/$FLOW_ID` endpoints. The first endpoint loads a file to your Langflow server, and then returns an uploaded file path. The second endpoint runs the **Load Data Flow**, referencing the uploaded file path, to chunk, embed, and load the data into the vector store. To load data programmatically, use the `/v2/files/` and `/v1/run/$FLOW_ID` endpoints. The first endpoint loads a file to your Langflow server, and then returns an uploaded file path. The second endpoint runs the **Load Data Flow**, referencing the uploaded file path, to chunk, embed, and load the data into the vector store.
The following script demonstrates this process. The following script demonstrates this process.
For help with creating this script, use the [Langflow File Upload Utility](https://langflow-file-upload-examples.onrender.com/). For help with creating this script, use the [Langflow File Upload Utility](https://langflow-file-upload-examples.onrender.com/).
```js ```js
// Node 18+ example using global fetch, FormData, and Blob // Node 18+ example using global fetch, FormData, and Blob
import fs from 'fs/promises'; import fs from 'fs/promises';
// 1. Prepare the form data with the file to upload // 1. Prepare the form data with the file to upload
const fileBuffer = await fs.readFile('FILE_NAME'); const fileBuffer = await fs.readFile('FILE_NAME');
const data = new FormData(); const data = new FormData();
data.append('file', new Blob([fileBuffer]), 'FILE_NAME'); data.append('file', new Blob([fileBuffer]), 'FILE_NAME');
const headers = { 'x-api-key': 'LANGFLOW_API_KEY' }; const headers = { 'x-api-key': 'LANGFLOW_API_KEY' };
// 2. Upload the file to Langflow // 2. Upload the file to Langflow
const uploadRes = await fetch('LANGFLOW_SERVER_ADDRESS/api/v2/files/', { const uploadRes = await fetch('LANGFLOW_SERVER_ADDRESS/api/v2/files/', {
method: 'POST', method: 'POST',
headers, headers,
body: data body: data
}); });
const uploadData = await uploadRes.json(); const uploadData = await uploadRes.json();
const uploadedPath = uploadData.path; const uploadedPath = uploadData.path;
// 3. Call the Langflow run endpoint with the uploaded file path // 3. Call the Langflow run endpoint with the uploaded file path
const payload = { const payload = {
input_value: "Analyze this file", input_value: "Analyze this file",
output_type: "chat", output_type: "chat",
input_type: "text", input_type: "text",
@ -104,18 +104,18 @@ In situations where many users load data or you need to load data programmatical
path: uploadedPath path: uploadedPath
} }
} }
}; };
const runRes = await fetch('LANGFLOW_SERVER_ADDRESS/api/v1/run/FLOW_ID', { const runRes = await fetch('LANGFLOW_SERVER_ADDRESS/api/v1/run/FLOW_ID', {
method: 'POST', method: 'POST',
headers: { 'Content-Type': 'application/json', 'x-api-key': 'LANGFLOW_API_KEY' }, headers: { 'Content-Type': 'application/json', 'x-api-key': 'LANGFLOW_API_KEY' },
body: JSON.stringify(payload) body: JSON.stringify(payload)
}); });
const langflowData = await runRes.json(); const langflowData = await runRes.json();
// Output only the message // Output only the message
console.log(langflowData.outputs?.[0]?.outputs?.[0]?.results?.message?.data?.text); console.log(langflowData.outputs?.[0]?.outputs?.[0]?.results?.message?.data?.text);
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
When the flow runs, the flow ingests the selected file, chunks the data, loads the data into the vector store database, and then generates embeddings for the chunks, which are also stored in the vector store. When the flow runs, the flow ingests the selected file, chunks the data, loads the data into the vector store database, and then generates embeddings for the chunks, which are also stored in the vector store.
@ -199,9 +199,9 @@ This tutorial uses JavaScript for demonstration purposes.
3. Save and run the script to send the requests and test the flow. 3. Save and run the script to send the requests and test the flow.
<details> <details>
<summary>Response</summary> <summary>Result</summary>
The following is an example of a response returned from this tutorial's flow. Due to the nature of LLMs and variations in your inputs, your response might be different. The following is an example response from this tutorial's flow. Due to the nature of LLMs and variations in your inputs, your response might be different.
``` ```
👤 You: Do you have any documents about engines? 👤 You: Do you have any documents about engines?
@ -215,7 +215,6 @@ This tutorial uses JavaScript for demonstration purposes.
</details> </details>
## Next steps ## Next steps
For more information on building or extending this tutorial, see the following: For more information on building or extending this tutorial, see the following: