跳到主要内容

项目端点

使用 /projects 端点来创建、读取、更新和删除 Langflow 项目

项目存储您的流程和组件。

读取项目

获取 Langflow 项目列表,包括项目 ID、名称和描述。


_10
curl -X GET \
_10
"$LANGFLOW_URL/api/v1/projects/" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $LANGFLOW_API_KEY"

结果

_10
[
_10
{
_10
"name": "Starter Project",
_10
"description": "Manage your own projects. Download and upload projects.",
_10
"id": "1415de42-8f01-4f36-bf34-539f23e47466",
_10
"parent_id": null
_10
}
_10
]

创建项目

创建一个新项目。


_10
curl -X POST \
_10
"$LANGFLOW_URL/api/v1/projects/" \
_10
-H "Content-Type: application/json" \
_10
-H "x-api-key: $LANGFLOW_API_KEY" \
_10
-d '{
_10
"name": "new_project_name",
_10
"description": "string",
_10
"components_list": [],
_10
"flows_list": []
_10
}'

结果

_10
{
_10
"name": "new_project_name",
_10
"description": "string",
_10
"id": "b408ddb9-6266-4431-9be8-e04a62758331",
_10
"parent_id": null
_10
}

要在项目创建时添加流程和组件,请从 /all/flows/read 端点检索 components_listflows_list 值,并将它们添加到请求体中。

将流程添加到项目会将流程从其之前的位置移动过来。流程不会被复制。


_15
curl -X POST \
_15
"$LANGFLOW_URL/api/v1/projects/" \
_15
-H "accept: application/json" \
_15
-H "Content-Type: application/json" \
_15
-H "x-api-key: $LANGFLOW_API_KEY" \
_15
-d '{
_15
"name": "new_project_name",
_15
"description": "string",
_15
"components_list": [
_15
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
_15
],
_15
"flows_list": [
_15
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
_15
]
_15
}'

读取项目

检索特定项目的详细信息。

要查找项目的 UUID,请调用 读取项目 端点。


_10
curl -X GET \
_10
"$LANGFLOW_URL/api/v1/projects/$PROJECT_ID" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $LANGFLOW_API_KEY"

结果

_10
[
_10
{
_10
"name": "Starter Project",
_10
"description": "Manage your own projects. Download and upload projects.",
_10
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
_10
"parent_id": null
_10
}
_10
]

更新项目

使用 PATCH 请求更新特定项目的信息。

每个 PATCH 请求都会使用您发送的值更新项目。 只有您在请求中包含的字段会被更新。 如果您多次发送相同的值,更新仍会被处理,即使值没有改变。


_15
curl -X PATCH \
_15
"$LANGFLOW_URL/api/v1/projects/b408ddb9-6266-4431-9be8-e04a62758331" \
_15
-H "accept: application/json" \
_15
-H "x-api-key: $LANGFLOW_API_KEY" \
_15
-d '{
_15
"name": "string",
_15
"description": "string",
_15
"parent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
_15
"components": [
_15
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
_15
],
_15
"flows": [
_15
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
_15
]
_15
}'

结果

_10
{
_10
"name": "string",
_10
"description": "string",
_10
"id": "b408ddb9-6266-4431-9be8-e04a62758331",
_10
"parent_id": null
_10
}

删除项目

删除特定项目。


_10
curl -X DELETE \
_10
"$LANGFLOW_URL/api/v1/projects/$PROJECT_ID" \
_10
-H "accept: */*" \
_10
-H "x-api-key: $LANGFLOW_API_KEY"

结果

_10
204 No Content

导出项目

将项目中的所有流程下载为 zip 文件。

--output 标志是可选的。


_10
curl -X GET \
_10
"$LANGFLOW_URL/api/v1/projects/download/$PROJECT_ID" \
_10
-H "accept: application/json" \
_10
-H "x-api-key: $LANGFLOW_API_KEY" \
_10
--output langflow-project.zip

导入项目

通过上传 Langflow 项目 zip 文件来导入项目及其流程:


_10
curl -X POST \
_10
"$LANGFLOW_URL/api/v1/projects/upload/" \
_10
-H "accept: application/json" \
_10
-H "Content-Type: multipart/form-data" \
_10
-H "x-api-key: $LANGFLOW_API_KEY" \
_10
-F "file=@20241230_135006_langflow_flows.zip;type=application/zip"

Search