Publish flows
DataStax Langflow provides several ways to publish and integrate your flows into external applications. Whether you want to expose your flow with API endpoints or share it as a public playground, this guide covers the options available for making your flows accessible to users.
The Publish pane presents the API access pane with code templates for integrating your flow into external applications, and a Shareable Playground option for sharing your flow with other users in your DataStax organization.
API access
The API access pane presents code templates for integrating your flow into external applications.
Prerequisites
-
Before you can use Langflow’s API access pane, you must have a flow that you want to expose as an API endpoint. If you haven’t already created a flow, create the Basic Prompting flow and ensure it’s working correctly.
Langflow automatically makes your flows available as API endpoints, and Langflow runs a server process that listens for API requests.
-
Get an application token. You can generate an application token in the API Access pane, or use an existing Astra application token with Organization Administrator permissions.
Interact with your flow as an API endpoint
Flows are exposed at the /api/v1/run/{flow_id} endpoint, where {flow_id} is the ID of the flow you want to run. You POST a JSON object to the endpoint, with optional flow customizations, and then receive a response.
This example demonstrates how you can use the API access pane to interact with the Basic Prompting flow as an API endpoint.
-
Python
-
JavaScript
-
cURL
The Python tab displays code to interact with your flow using the Python requests library.
-
Copy and paste the code into a Python script.
-
Run the script.
python3 python-test-script.py --message="tell me about something interesting"The response content depends on your flow. Ensure the endpoint returns a successful response.
The JavaScript API tab displays code to interact with your flow in JavaScript.
-
Copy and paste the code into a JavaScript file.
-
Run the script.
node test-script.js "tell me about something interesting"The response content depends on your flow. Ensure the endpoint returns a successful response.
The cURL tab displays sample code for posting a query to your flow.
Copy the code and run it to post a query to your flow and get the result.
The response content depends on your flow. Ensure the endpoint returns a successful response.
Temporary overrides
The Temporary overrides tab displays the available parameters for your flow.
Modifying the parameters changes the code parameters across all windows.
For example, changing the Chat Input component’s input_value changes that value across all API calls to the /run endpoint of this flow.
Shareable playground
The Shareable playground exposes your Langflow application’s Playground at the /public_flow/flow_id endpoint.
You can share this endpoint publicly with any users within your Organization.
To share your flow, follow these steps:
-
In the Workspace, click Publish.
-
Enable the Shareable Playground toggle.
-
Click Shareable Playground to open the link. Your shareable playground opens. You can share this link with other users in your organization.
