docs: API examples #5499
Merged
docs: API examples #5499
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… folders, and files
dosubot
bot
added
size:XXL
github-actions
bot
added
documentation
github-actions
bot
added
the
documentation
KimberlyFields
approved these changes
Jan 15, 2025
github-actions
bot
added
documentation
Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>
github-actions
bot
added
documentation
github-actions
bot
added
documentation
github-actions
bot
added
documentation
github-actions
bot
added
documentation
github-actions
bot
added
documentation
mieslep
pushed a commit
to mieslep/langflow
that referenced
this pull request
Jan 15, 2025
* bump-api-to-1.1.1 * docs: api reference content * more-endpoints * cleanup * all-endpoints-accounted-for * docs: update API reference with user response examples and authorization header * all-200s-complete * fix-spacing-for-gh-preview * sidebars * monitor-endpoints * fix-build-error * fix-sidebar-error * create-flows * flows-endpoint-finished * move * files-endpoint * run-flow * folder-endpoint * docs: update API reference with new endpoints and examples for flows, folders, and files * value * docs: update openapi.json * docs: enhance API reference with folder-id export instructions and examples * docs: update API reference with new flow structure and log retrieval instructions * docs: clarify ZIP file download endpoint description in API examples * docs: refine API examples for clarity and consistency * docs: refine API examples for clarity and consistency * webhook * docs: format curl example for improved readability * docs: update curl examples to use double quotes for variable interpolation * docs: Update API example descriptions for improved clarity * docs: Update API example descriptions for improved clarity * docs: Enhance API reference with Langflow API key setup and build flow examples * docs: update API reference examples with new event data and structure * docs: add clarification on LLM chat response streaming in API examples * error-and-build-vertex * docs: remove wrong information from API examples * Apply suggestions from code review Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com> * docs: Update API reference examples for environment variable exports * docs: Fix JSON structure in API reference examples * docs: Update API reference examples for file download and log retrieval --------- Co-authored-by: anovazzi1 <otavio2204@gmail.com> Co-authored-by: Gabriel Luiz Freitas Almeida <gabriel@langflow.org> Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>
viniciossilva3
pushed a commit
to viniciossilva3/langflow
that referenced
this pull request
Jan 16, 2025
* bump-api-to-1.1.1 * docs: api reference content * more-endpoints * cleanup * all-endpoints-accounted-for * docs: update API reference with user response examples and authorization header * all-200s-complete * fix-spacing-for-gh-preview * sidebars * monitor-endpoints * fix-build-error * fix-sidebar-error * create-flows * flows-endpoint-finished * move * files-endpoint * run-flow * folder-endpoint * docs: update API reference with new endpoints and examples for flows, folders, and files * value * docs: update openapi.json * docs: enhance API reference with folder-id export instructions and examples * docs: update API reference with new flow structure and log retrieval instructions * docs: clarify ZIP file download endpoint description in API examples * docs: refine API examples for clarity and consistency * docs: refine API examples for clarity and consistency * webhook * docs: format curl example for improved readability * docs: update curl examples to use double quotes for variable interpolation * docs: Update API example descriptions for improved clarity * docs: Update API example descriptions for improved clarity * docs: Enhance API reference with Langflow API key setup and build flow examples * docs: update API reference examples with new event data and structure * docs: add clarification on LLM chat response streaming in API examples * error-and-build-vertex * docs: remove wrong information from API examples * Apply suggestions from code review Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com> * docs: Update API reference examples for environment variable exports * docs: Fix JSON structure in API reference examples * docs: Update API reference examples for file download and log retrieval --------- Co-authored-by: anovazzi1 <otavio2204@gmail.com> Co-authored-by: Gabriel Luiz Freitas Almeida <gabriel@langflow.org> Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 (and updated to include the EventManager integration)