Skip to main content

Projects endpoints

Use the /projects endpoint to create, read, update, and delete projects.

Projects store your flows and components.

Read projects

Get a list of Langflow projects, including project IDs, names, and descriptions.


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

Create project

Create a new project.


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

To add flows and components at project creation, retrieve the components_list and flows_list values from the /all and /flows/read endpoints and add them to the request body.

Adding a flow to a project moves the flow from its previous location. The flow is not copied.


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

Read project

Retrieve details of a specific project.

To find the UUID of your project, call the read projects endpoint.


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

Update project

Update the information of a specific project with a PATCH request.

Each PATCH request updates the project with the values you send. 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.


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

Delete project

Delete a specific project.


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

Export a project

Download all flows from a project as a zip file.

The --output flag is optional.


_10
curl -X GET \
_10
"$LANGFLOW_URL/api/v1/projects/download/b408ddb9-6266-4431-9be8-e04a62758331" \
_10
-H "accept: application/json" \
_10
--output langflow-project.zip

Import a project

Import a project and its flows by uploading a Langflow project zip file:


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

Search