流程管理端点
使用 /flows
端点来创建、读取、更新和删除流程。
如果您想要使用 Langflow API 运行流程,请参阅流程触发端点。
创建流程
创建一个新流程。
_20curl -X POST \_20 "$LANGFLOW_URL/api/v1/flows/" \_20 -H "accept: application/json" \_20 -H "Content-Type: application/json" \_20 -H "x-api-key: $LANGFLOW_API_KEY" \_20 -d '{_20 "name": "string2",_20 "description": "string",_20 "icon": "string",_20 "icon_bg_color": "#FF0000",_20 "gradient": "string",_20 "data": {},_20 "is_component": false,_20 "updated_at": "2024-12-30T15:48:01.519Z",_20 "webhook": false,_20 "endpoint_name": "string",_20 "tags": [_20 "string"_20 ]_20}'
结果
_17{_17 "name": "string2",_17 "description": "string",_17 "icon": "string",_17 "icon_bg_color": "#FF0000",_17 "gradient": "string",_17 "data": {},_17 "is_component": false,_17 "updated_at": "2025-02-04T21:07:36+00:00",_17 "webhook": false,_17 "endpoint_name": "string",_17 "tags": ["string"],_17 "locked": false,_17 "id": "e8d81c37-714b-49ae-ba82-e61141f020ee",_17 "user_id": "f58396d4-a387-4bb8-b749-f40825c3d9f3",_17 "project_id": "1415de42-8f01-4f36-bf34-539f23e47466"_17}
创建多个流程
创建多个新流程,返回流程对象数组。
_45curl -X POST \_45 "$LANGFLOW_URL/api/v1/flows/batch/" \_45 -H "accept: application/json" \_45 -H "Content-Type: application/json" \_45 -H "x-api-key: $LANGFLOW_API_KEY" \_45 -d '{_45 "flows": [_45 {_45 "name": "string",_45 "description": "string",_45 "icon": "string",_45 "icon_bg_color": "string",_45 "gradient": "string",_45 "data": {},_45 "is_component": false,_45 "updated_at": "2024-12-30T18:36:02.737Z",_45 "webhook": false,_45 "endpoint_name": "string",_45 "tags": [_45 "string"_45 ],_45 "locked": false,_45 "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",_45 "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"_45 },_45 {_45 "name": "string",_45 "description": "string",_45 "icon": "string",_45 "icon_bg_color": "string",_45 "gradient": "string",_45 "data": {},_45 "is_component": false,_45 "updated_at": "2024-12-30T18:36:02.737Z",_45 "webhook": false,_45 "endpoint_name": "string",_45 "tags": [_45 "string"_45 ],_45 "locked": false,_45 "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",_45 "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"_45 }_45 ]_45}'
读取流程
根据 ID 检索特定流程。
_10curl -X GET \_10 "$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \_10 -H "accept: application/json" \_10 -H "x-api-key: $LANGFLOW_API_KEY"
结果
_12{_12 "name": "Basic Prompting",_12 "description": "Perform basic prompting with an OpenAI model.",_12 "icon": "Braces",_12 "icon_bg_color": null,_12 "gradient": "2",_12 "data": {_12 "nodes": [_12 ..._12 ]_12 }_12}
读取多个流程
返回包含流程列表的 JSON 对象。
使用分页检索所有流程:
_10curl -X GET \_10 "$LANGFLOW_URL/api/v1/flows/?remove_example_flows=false&components_only=false&get_all=true&header_flows=false&page=1&size=50" \_10 -H "accept: application/json" \_10 -H "x-api-key: $LANGFLOW_API_KEY"
要从特定项目检索流程,请使用 project_id
查询参数:
_10curl -X GET \_10 "$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" \_10 -H "accept: application/json" \_10 -H "x-api-key: $LANGFLOW_API_KEY"
读取示例流程
检索示例流程列表:
_10curl -X GET \_10 "$LANGFLOW_URL/api/v1/flows/basic_examples/" \_10 -H "accept: application/json" \_10 -H "x-api-key: $LANGFLOW_API_KEY"
更新 流程
根据 ID 更新现有流程。
此示例将 endpoint_name
的值从随机 UUID 更改为 my_new_endpoint_name
。
_13curl -X PATCH \_13 "$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \_13 -H "accept: application/json" \_13 -H "Content-Type: application/json" \_13 -H "x-api-key: $LANGFLOW_API_KEY" \_13 -d '{_13 "name": "string",_13 "description": "string",_13 "data": {},_13 "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",_13 "endpoint_name": "my_new_endpoint_name",_13 "locked": true_13}'
结果
_17{_17 "name": "string",_17 "description": "string",_17 "icon": "Braces",_17 "icon_bg_color": null,_17 "gradient": "2",_17 "data": {},_17 "is_component": false,_17 "updated_at": "2024-12-30T18:30:22+00:00",_17 "webhook": false,_17 "endpoint_name": "my_new_endpoint_name",_17 "tags": null,_17 "locked": true,_17 "id": "01ce083d-748b-4b8d-97b6-33adbb6a528a",_17 "user_id": "f58396d4-a387-4bb8-b749-f40825c3d9f3",_17 "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"_17}
删除流程
根据 ID 删除特定流程。
_10curl -X DELETE \_10 "$LANGFLOW_URL/api/v1/flows/$FLOW_ID" \_10 -H "accept: application/json" \_10 -H "x-api-key: $LANGFLOW_API_KEY"
结果
_10{_10 "message": "Flow deleted successfully"_10}
导出流程
将 指定流程导出为 ZIP 文件。
此端点下载包含请求主体中列出的每个流程 ID 的 Langflow JSON 文件的 ZIP 文件。
_10curl -X POST \_10 "$LANGFLOW_URL/api/v1/flows/download/" \_10 -H "accept: application/json" \_10 -H "Content-Type: application/json" \_10 -H "x-api-key: $LANGFLOW_API_KEY" \_10 -d '[_10 "e1e40c77-0541-41a9-88ab-ddb3419398b5",_10 "92f9a4c5-cfc8-4656-ae63-1f0881163c28"_10]' \_10 --output langflow-flows.zip
结果
_10 % Total % Received % Xferd Average Speed Time Time Time Current_10 Dload Upload Total Spent Left Speed_10100 76437 0 76353 100 84 4516k 5088 --:--:-- --:--:-- --:--:-- 4665k
导入流程
通过上传 Langflow 兼容的 JSON 文件导入流程。
要为流程指定目标项目,请包含查询参数 project_id
。
在上传流程之前,目标 project_id
必须已存在。调用 /api/v1/projects/ 端点获取可用项目列表。
此示例将名为 agent-with-astra-db-tool.json
的本地文件上传到由 PROJECT_ID
变量指定的项目:
_10curl -X POST \_10 "$LANGFLOW_URL/api/v1/flows/upload/?project_id=$PROJECT_ID" \_10 -H "accept: application/json" \_10 -H "Content-Type: multipart/form-data" \_10 -H "x-api-key: $LANGFLOW_API_KEY" \_10 -F "file=@agent-with-astra-db-tool.json;type=application/json"
结果
_11[_11 {_11 "name": "agent-with-astra-db-tool",_11 "description": "",_11 "icon": null,_11 "icon_bg_color": null,_11 "gradient": null,_11 "data": {}_11 ..._11 }_11]