-
Notifications
You must be signed in to change notification settings - Fork 4.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: API examples #5499
base: main
Are you sure you want to change the base?
docs: API examples #5499
Conversation
… folders, and files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-
the endpoints are not working out of the box on macbook warp terminal because of the simple quotes in the url
-
create multiple flows example have only one flow inside the array
-
upload flow from file works fine but when passing a folder the global varaible used was not mentioned before and it does not especify how to get the folder id from the langflow ui, also if we pass a wrong id it still works but the flow can't be seen in the ui, this should be fixed but would be good to alert the user that the folder id should already exist before uploading the flow.
-
download all flows endpoint uses an array of ids in it's body, but it's not clear to the user if those ids are flow ids or folder ids or if they are necessary if the endpoint should download all flows or just the ones related to the ids provided in the request.
-
monitor description is not accurate, monitor endpoint does not only handle messages
-
get messages endpoint uses an optional parameter as session_id with a uuid that is not needed and can lead to confusion
-
the json on this example is invalid because of the ending comma http://localhost:3000/api-reference-api-examples#update-message
-
Create folder endpoint example could create a new folder without flows or component so the example can work out of the box from copy and pasting
-
Update folder description does not explain exactly what the endpoint do, if we send two flow ids the folder will have the past flows + the two new ones or we will override the folder content?
-
Upload file endpoint uses a flow id, but it's not clear to the user the provided uuid need to be from an existing flow
-
would be nice to tell how to enable logs stream before this example:
-
simplified run flow could use the global variable for langflow_id
-
run advanced could say what are the advanced options before the example
-starter-projects did not return the list of projects ad it's probably deprecated, the active endpoint is basic examples
This pull request includes updates to the documentation and the OpenAPI specification for the Langflow API.
The new API Examples page includes examples for endpoints related to flow building, CRUD, file upload and download, and monitoring. Endpoints not included are documented in the swagger spec.
The OpenAPI spec has been updated to 1.1.1.