Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
aacc0e0
add-api-key-header-to-examples
mendonk Jun 24, 2025
07d073f
api-examples-add-keys
mendonk Jun 24, 2025
832409d
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jun 25, 2025
bc20ed6
auth-login-behavior-changes
mendonk Jun 25, 2025
0a83eb0
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jun 25, 2025
1437065
no-all-endpoint
mendonk Jun 25, 2025
1bf8157
syntax
mendonk Jun 25, 2025
b87389d
text
mendonk Jun 25, 2025
5c48098
cleanup
mendonk Jun 25, 2025
7b2c303
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jun 26, 2025
488b0ec
notice-for-mcp
mendonk Jun 26, 2025
1ad3b74
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jun 27, 2025
a3d0760
include-instructions-for-exporting-key
mendonk Jun 27, 2025
9b55d1e
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jul 1, 2025
4abc4b3
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jul 1, 2025
7cdfceb
Apply suggestions from code review
mendonk Jul 1, 2025
d68a0e1
chat-io-double-quotes
mendonk Jul 1, 2025
85d4074
auth-page-docs-review
mendonk Jul 1, 2025
61d1cf3
docs-review
mendonk Jul 1, 2025
8056bf8
update-api-overview-page-docs-review
mendonk Jul 1, 2025
3fef7d2
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jul 2, 2025
54fd3d8
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jul 3, 2025
ec9f8c0
docs-and-eng-review
mendonk Jul 3, 2025
d119761
details-title
mendonk Jul 3, 2025
348ad92
Apply suggestions from code review
mendonk Jul 3, 2025
4494b75
Apply suggestions from code review
mendonk Jul 3, 2025
df2e99d
docs-review
mendonk Jul 3, 2025
2282179
Merge branch 'docs-add-api-auth-requirement' of https://github.com/la…
mendonk Jul 3, 2025
fb3224a
add-env-var-to-table
mendonk Jul 3, 2025
ef3dfd1
clarify-cli-key-requirements
mendonk Jul 3, 2025
c2c5fea
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jul 3, 2025
ae045e4
docs: update API key creation instructions in CLI documentation
mendonk Jul 3, 2025
fbd0291
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jul 7, 2025
8dbb1a2
public-server-update-env-vars
mendonk Jul 7, 2025
7ae812c
reference-page
mendonk Jul 7, 2025
d33261d
Apply suggestions from code review
mendonk Jul 7, 2025
61a1937
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jul 8, 2025
a3dc5bf
Apply suggestions from code review
mendonk Jul 8, 2025
ac1cfb1
Apply suggestions from code review
mendonk Jul 8, 2025
ea9cf5c
Apply suggestions from code review
mendonk Jul 8, 2025
6c8f3bc
Merge branch 'main' into docs-add-api-auth-requirement
mendonk Jul 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/docs/API-Reference/api-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ curl -X POST \
"$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '{
"inputs": {
"input_value": "Tell me a story"
Expand Down Expand Up @@ -59,7 +60,8 @@ curl -X POST \
```text
curl -X GET \
"$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"
```

</TabItem>
Expand All @@ -84,7 +86,8 @@ To disable streaming and get all events at once, set `stream` to `false`.
```text
curl -X GET \
"$LANGFLOW_URL/api/v1/build/123e4567-e89b-12d3-a456-426614174000/events?stream=false" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

## Build headers
Expand Down Expand Up @@ -134,6 +137,7 @@ curl -X POST \
"$LANGFLOW_URL/api/v1/build/$FLOW_ID/flow" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '{
"data": {
"nodes": [],
Expand Down
16 changes: 12 additions & 4 deletions docs/docs/API-Reference/api-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ curl -X POST \
"$LANGFLOW_URL/api/v1/files/upload/$FLOW_ID" \
-H "accept: application/json" \
-H "Content-Type: multipart/form-data" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-F "file=@FILE_NAME.txt"
```

Expand Down Expand Up @@ -72,6 +73,7 @@ For more information, see [Supported environment variables](/environment-variabl
```bash
curl -X POST "$LANGFLOW_URL/api/v1/files/upload/a430cc57-06bb-4c11-be39-d3d4de68d2c4" \
-H "Content-Type: multipart/form-data" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-F "file=@FILE_NAME.png"
```

Expand All @@ -91,7 +93,8 @@ The API returns the image file path in the format `"file_path":"<YOUR-FLOW-ID>/<
```bash
curl -X POST \
"$LANGFLOW_URL/api/v1/run/a430cc57-06bb-4c11-be39-d3d4de68d2c4?stream=false" \
-H 'Content-Type: application/json'\
-H 'Content-Type: application/json' \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '{
"output_type": "chat",
"input_type": "chat",
Expand Down Expand Up @@ -119,7 +122,8 @@ List all files associated with a specific flow.
```bash
curl -X GET \
"$LANGFLOW_URL/api/v1/files/list/$FLOW_ID" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand All @@ -145,6 +149,7 @@ Download a specific file from a flow.
curl -X GET \
"$LANGFLOW_URL/api/v1/files/download/$FLOW_ID/2024-12-30_15-19-43_your_file.txt" \
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
--output downloaded_file.txt
```

Expand All @@ -168,7 +173,8 @@ Delete a specific file from a flow.
```bash
curl -X DELETE \
"$LANGFLOW_URL/api/v1/files/delete/$FLOW_ID/2024-12-30_15-19-43_your_file.txt" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand Down Expand Up @@ -200,7 +206,8 @@ To retrieve your current `user_id`, call the `/whoami` endpoint.
```bash
curl -X GET \
"$LANGFLOW_URL/api/v1/users/whoami" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

Result:
Expand Down Expand Up @@ -279,6 +286,7 @@ In this example, the file uploaded to `/v2/files` is included with the `/v1/run`
curl --request POST \
--url "$LANGFLOW_URL/api/v1/run/$FLOW_ID" \
--header "Content-Type: application/json" \
--header "x-api-key: $LANGFLOW_API_KEY" \
--data '{
"input_value": "what do you see?",
"output_type": "chat",
Expand Down
5 changes: 4 additions & 1 deletion docs/docs/API-Reference/api-flows-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ This flow requires a chat input string (`input_value`), and uses default values
curl -X POST \
Comment thread
mendonk marked this conversation as resolved.
"$LANGFLOW_SERVER_URL/api/v1/run/$FLOW_ID" \
-H "Content-Type: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '{
"input_value": "Tell me about something interesting!",
"session_id": "chat-123",
Expand Down Expand Up @@ -86,6 +87,7 @@ curl -X POST \
"$LANGFLOW_SERVER_URL/api/v1/run/$FLOW_ID?stream=true" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '{
"message": "Tell me something interesting!",
"session_id": "chat-123"
Expand Down Expand Up @@ -152,7 +154,7 @@ curl -X POST \
"$LANGFLOW_SERVER_URL/api/v1/run/$FLOW_ID?stream=true" \
-H "Content-Type: application/json" \
-H "accept: application/json" \
-H "x-api-key: sk-..." \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '{
"input_value": "Tell me a story",
"input_type": "chat",
Expand All @@ -179,6 +181,7 @@ After you add a **Webhook** component to a flow, open the [**API access** pane](
curl -X POST \
"$LANGFLOW_SERVER_URL/api/v1/webhook/$FLOW_ID" \
-H "Content-Type: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '{"data": "example-data"}'
```

Expand Down
20 changes: 15 additions & 5 deletions docs/docs/API-Reference/api-flows.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ curl -X POST \
"$LANGFLOW_URL/api/v1/flows/" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '{
"name": "string2",
"description": "string",
Expand Down Expand Up @@ -74,6 +75,7 @@ curl -X POST \
"$LANGFLOW_URL/api/v1/flows/batch/" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '{
"flows": [
{
Expand Down Expand Up @@ -126,7 +128,8 @@ Retrieves a specific flow by its ID.
```bash
curl -X GET \
"$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand Down Expand Up @@ -160,15 +163,17 @@ Retrieve all flows with pagination:
```bash
curl -X GET \
"$LANGFLOW_URL/api/v1/flows/?remove_example_flows=false&components_only=false&get_all=true&header_flows=false&page=1&size=50" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

To retrieve flows from a specific project, use the `project_id` query parameter:

```bash
curl -X GET \
"$LANGFLOW_URL/api/v1/flows/?remove_example_flows=true&components_only=false&get_all=false&project_id=$PROJECT_ID&header_flows=false&page=1&size=1" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

## Read sample flows
Expand All @@ -178,7 +183,8 @@ Retrieves a list of sample flows:
```bash
curl -X GET \
"$LANGFLOW_URL/api/v1/flows/basic_examples/" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

## Update flow
Expand All @@ -195,6 +201,7 @@ curl -X PATCH \
"$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '{
"name": "string",
"description": "string",
Expand Down Expand Up @@ -241,7 +248,8 @@ Deletes a specific flow by its ID.
```bash
curl -X DELETE \
"$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand Down Expand Up @@ -271,6 +279,7 @@ curl -X POST \
"$LANGFLOW_URL/api/v1/flows/download/" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '[
"e1e40c77-0541-41a9-88ab-ddb3419398b5",
"92f9a4c5-cfc8-4656-ae63-1f0881163c28"
Expand Down Expand Up @@ -307,6 +316,7 @@ curl -X POST \
"$LANGFLOW_URL/api/v1/flows/upload/?project_id=$PROJECT_ID" \
-H "accept: application/json" \
-H "Content-Type: multipart/form-data" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-F "file=@agent-with-astra-db-tool.json;type=application/json"
```

Expand Down
6 changes: 4 additions & 2 deletions docs/docs/API-Reference/api-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ Stream logs in real-time using Server Sent Events (SSE).
```bash
curl -X GET \
"$LANGFLOW_URL/logs-stream" \
-H "accept: text/event-stream"
-H "accept: text/event-stream" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand Down Expand Up @@ -84,7 +85,8 @@ With default values, the endpoint returns the last 10 lines of logs.
```bash
curl -X GET \
"$LANGFLOW_URL/logs?lines_before=0&lines_after=0&timestamp=0" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand Down
23 changes: 16 additions & 7 deletions docs/docs/API-Reference/api-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Retrieve Vertex builds for a specific flow.
```bash
curl -X GET \
"$LANGFLOW_URL/api/v1/monitor/builds?flow_id=$FLOW_ID" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand Down Expand Up @@ -397,7 +398,8 @@ Delete Vertex builds for a specific flow.
```bash
curl -X DELETE \
"$LANGFLOW_URL/api/v1/monitor/builds?flow_id=$FLOW_ID" \
-H "accept: */*"
-H "accept: */*" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand All @@ -417,7 +419,8 @@ Retrieve a list of all messages:
```bash
curl -X GET \
"$LANGFLOW_URL/api/v1/monitor/messages" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

To filter messages, use the `flow_id`, `session_id`, `sender`, and `sender_name` query parameters.
Expand All @@ -432,7 +435,8 @@ This example retrieves messages sent by `Machine` and `AI` in a given chat sessi
```bash
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" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand Down Expand Up @@ -488,6 +492,7 @@ curl -v -X DELETE \
"$LANGFLOW_URL/api/v1/monitor/messages" \
-H "accept: */*" \
-H "Content-Type: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '["MESSAGE_ID_1", "MESSAGE_ID_2"]'
```

Expand Down Expand Up @@ -515,6 +520,7 @@ curl -X PUT \
"$LANGFLOW_URL/api/v1/monitor/messages/3ab66cc6-c048-48f8-ab07-570f5af7b160" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY" \
-d '{
"text": "testing 1234"
}'
Expand Down Expand Up @@ -566,7 +572,8 @@ This example updates the `session_ID` value `01ce083d-748b-4b8d-97b6-33adbb6a528
```bash
curl -X PATCH \
"$LANGFLOW_URL/api/v1/monitor/messages/session/01ce083d-748b-4b8d-97b6-33adbb6a528a?new_session_id=different_session_id" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand Down Expand Up @@ -618,7 +625,8 @@ Delete all messages for a specific session.
```bash
curl -X DELETE \
"$LANGFLOW_URL/api/v1/monitor/messages/session/different_session_id_2" \
-H "accept: */*"
-H "accept: */*" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand All @@ -641,7 +649,8 @@ Retrieve all transactions, which are interactions between components, for a spec
```bash
curl -X GET \
"$LANGFLOW_URL/api/v1/monitor/transactions?flow_id=$FLOW_ID&page=1&size=50" \
-H "accept: application/json"
-H "accept: application/json" \
-H "x-api-key: $LANGFLOW_API_KEY"
```

</TabItem>
Expand Down
Loading
Loading