mirror of
https://github.com/hanzoai/flow.git
synced 2026-10-17 01:29:18 +00:00
zeekay
94741a8363
Completes the rebrand per direction: LANGFLOW_/LANGFLOW -> FLOW_/FLOW (env vars, headers), langflow_ -> flow_ (settings fields, local vars), camelCase identifiers (LangflowClient/Logo/HTTPError, builtWithLangflow, getLangflowDesktop) -> Flow*, and all remaining bare tokens. Fixed the identifier-space hazard (Langflow -> 'Hanzo Flow' is prose-only; in code it collapses to Flow so no identifier gains a space). compileall of flow + lfx is clean. Repo-wide langflow now = 4, all the protected MIT attribution to langflow-ai/ langflow in README (legally required; deliberately preserved). Breaking (per no-backwards-compat / forward-perfection): the LANGFLOW_* env-var prefix is now FLOW_* — deployments must update their env. CI's uv + frontend build is the runtime gate.
57 lines
2.2 KiB
Plaintext
57 lines
2.2 KiB
Plaintext
## Prerequisites
|
|
|
|
Before using the API, you need:
|
|
|
|
* [Install and start Hanzo Flow](/get-started-installation) with the developer API enabled
|
|
|
|
The Workflows API endpoints require the `developer_api_enabled` setting to be enabled. If this setting is disabled, these endpoints will return a 404 Not Found error.
|
|
|
|
To enable the developer API endpoint, do the following:
|
|
1. In the Hanzo Flow `.env` file, set the environment variable to `true`:
|
|
```
|
|
FLOW_DEVELOPER_API_ENABLED=true
|
|
```
|
|
2. Start your Hanzo Flow server with the `.env` file enabled:
|
|
```
|
|
uv run flow run --env-file .env
|
|
```
|
|
|
|
For more information about configuring environment variables, see [Environment variables](/environment-variables).
|
|
* [Create a Hanzo Flow API key](/api-keys-and-authentication)
|
|
* [Create a flow](/concepts-flows) that you want to execute
|
|
* [Get the flow ID](/concepts-publish#api-access) or endpoint name of the flow you want to execute
|
|
|
|
### Set environment variables
|
|
|
|
All code examples in this documentation assume you have set the following environment variables:
|
|
|
|
**Python:**
|
|
```python
|
|
import os
|
|
|
|
FLOW_SERVER_URL = os.getenv("FLOW_SERVER_URL")
|
|
FLOW_API_KEY = os.getenv("FLOW_API_KEY")
|
|
```
|
|
|
|
**TypeScript/JavaScript:**
|
|
```typescript
|
|
const FLOW_SERVER_URL = process.env.FLOW_SERVER_URL;
|
|
const FLOW_API_KEY = process.env.FLOW_API_KEY;
|
|
```
|
|
|
|
Set these environment variables before running the examples, or replace the variable references in the code examples with your actual Hanzo Flow server URL and API key.
|
|
|
|
The default `FLOW_SERVER_URL` for a local Hanzo Flow deployment is `http://localhost:7860`.
|
|
For remote deployments, the domain is set by your hosting service, such as `https://UUID.ngrok.app`.
|
|
|
|
### Authentication and headers
|
|
|
|
All Workflows API requests require authentication using a Hanzo Flow API key. The API key is passed in the `x-api-key` header.
|
|
|
|
For more information, see [Create a Hanzo Flow API key](/api-keys-and-authentication).
|
|
|
|
| Header | Description | Example |
|
|
|--------|-------------|---------|
|
|
| `Content-Type` | Specifies the JSON format. | `application/json` |
|
|
| `x-api-key` | Your Hanzo Flow API key. | `sk-...` |
|
|
| `accept` | Optional. Specifies the response format. | `application/json` | |