<aside> ⚠️ The Browserflow API is in public beta and undergoing active development. Please expect occasional breaking changes until it is released as production-ready. Changes will be communicated beforehand as much as possible.
If you run into issues or have additional requests, don’t hesitate to message DK in the Browserflow Discord or email [email protected]. Thanks!
</aside>
Access to the Browserflow API requires a paid subscription. Once you have an active subscription, navigate to your account settings (click on your avatar in the top right of the website) and scroll to the API section to generate your key.
The API key must be included in all API requests using the HTTP Authorization header:
Authorization: Bearer API_KEY
POST <https://api.browserflow.app/v1/flows/:flowId/runs>
Note: The flow ID can be found by opening the flow in the dashboard and copying the ID from the URL (https://browserflow.app/flows/:flowId) or by opening the “API & Webhooks” tab for the flow.
| inputVariables optional | Set of key-value pairs where the keys are https://docs.browserflow.app/guides/input-variables and values are the values to be used (as strings) |
|---|
This endpoint will respond with a 202 Accepted once it has queued your flow to be run. Flows will be run immediately.
If you’d like to read the results of the run, you can add webhooks to be notified when runs complete.
Steps to try out this end point: