跳到主要内容

API 密钥

Langflow 提供了 API 密钥功能，允许用户在没有传统登录身份验证的情况下访问其个人组件和流。

生成 Langflow API 密钥​

生成一个特定于用户的令牌以用于 Langflow。

使用 Langflow UI 生成 API 密钥​

  1. 点击您的用户图标，然后选择 设置。
  2. 点击 Langflow API，然后点击 添加新密钥。
  3. 命名您的密钥，然后点击 创建密钥。
  4. 复制 API 密钥并将其存储在安全位置。

使用 Langflow CLI 生成 API 密钥​


_13
langflow api-key
_13
# 或
_13
python -m langflow api-key
_13
╭─────────────────────────────────────────────────────────────────────╮
_13
│ API 密钥创建成功： │
_13
│ │
_13
│ sk-O0elzoWID1izAH8RUKrnnvyyMwIzHi2Wk-uXWoNJ2Ro │
_13
│ │
_13
│ 这是唯一一次显示 API 密钥。 │
_13
│ 请务必将其存储在安全位置。 │
_13
│ │
_13
│ API 密钥已复制到剪贴板。按 Cmd + V 粘贴。 │
_13
╰──────────────────────────────

使用 Langflow API 密钥验证请求​

在 API 请求中包含您的 API 密钥，以验证对 Langflow 的请求。

API 密钥仅允许访问密钥颁发给的特定用户的流和组件。

将 API 密钥包含在 HTTP 头中​

在发出 API 请求时使用 API 密钥，将其包含在 HTTP 头中


_10
curl -X POST \
_10
"http://127.0.0.1:7860/api/v1/run/FLOW_ID?stream=false" \
_10
-H 'Content-Type: application/json' \
_10
-H 'x-api-key: API_KEY' \
_10
-d '{"inputs": {"text":""}, "tweaks": {}}'

将 API 密钥作为查询参数包含​

将 API 密钥作为查询参数传递


_10
curl -X POST \
_10
"http://127.0.0.1:7860/api/v1/run/FLOW_ID?x-api-key=API_KEY?stream=false" \
_10
-H 'Content-Type: application/json' \
_10
-d '{"inputs": {"text":""}, "tweaks": {}}'

生成 Langflow 密钥​

Langflow 使用 Fernet 库加密敏感数据。

如果未提供 LANGFLOW_SECRET_KEY，Langflow 会自动生成一个。

更多信息，请参阅 身份验证。

撤销 API 密钥​

要撤销 API 密钥，请在 设置 菜单的密钥列表中删除它。

  1. 点击您的用户图标，然后选择 设置。
  2. 点击 Langflow API。
  3. 选择您要删除的密钥，然后点击垃圾桶图标。

此操作会立即使密钥失效，并阻止其再次使用。

向 Langflow 添加组件 API 密钥​

这些是用于外部服务（如 OpenAI）的凭据。可以通过 .env 文件或在 Langflow UI 中将其添加到 Langflow。

在 UI 中设置的组件 API 密钥会覆盖在环境变量中设置的密钥。

使用 .env 文件添加组件 API 密钥​

将组件 API 密钥添加到您的 .env 文件


_10
OPENAI_API_KEY=sk-...
_10
ANTHROPIC_API_KEY=sk-...
_10
GOOGLE_API_KEY=...

使用 Langflow UI 添加组件 API 密钥​

使用 Langflow UI 将组件 API 密钥添加为 全局变量

  1. 点击您的用户图标，然后选择 设置。
  2. 点击 Langflow API。
  3. 添加新的 API 密钥作为 凭据 类型变量。
  4. 将其应用于特定的组件字段。

直接在流中设置的组件值会覆盖在 UI 和 环境变量中设置的值。

更多信息，请参阅 全局变量。

Search