API 密钥

DeckFlow 使用 API 密钥（API key）身份验证来进行开发者访问。密钥绑定到创建它的账户或工作区，使用该密钥的额度消耗将计入对应的账户或工作区。

获取 API 密钥

登录 DeckFlow。
打开设置 (Settings)。
进入 API 密钥管理页面。
生成或复制您的 API 密钥。

请妥善保管您的密钥。该密钥可用于创建任务、访问工作区资源以及消耗 Credit 和 Spark 额度。

配置您的 API 密钥

环境变量（推荐）

  export DECKFLOW_API_KEY="Bearer <YOUR_API_KEY>"
  export DECKFLOW_API_BASE="https://app.deckflow.com/api"

`.env` 文件

如果您的项目使用 .env 文件，请将密钥存储在源代码之外：

DECKFLOW_API_KEY="Bearer <YOUR_API_KEY>"
DECKFLOW_API_BASE=https://app.deckflow.com/api

MCP 与 CLI

对于 MCP 客户端、本地智能体、CI 任务和 CLI 自动化，请在启动工作流之前设置 DECKFLOW_API_KEY 环境变量。

  export DECKFLOW_API_KEY="Bearer <YOUR_API_KEY>"
  # Start your MCP client, CLI command, or agent process after this.

在 CI 环境中，请将密钥存储在服务商提供的机密管理器（Secret Manager）中。请勿将 API 密钥直接写入提示词、Notebook（如 Jupyter）、已提交的配置文件或纯前端浏览器代码中。

在请求中携带密钥

所有 DeckFlow API 请求均通过 Authorization 请求头进行身份验证。

  curl -X POST "$DECKFLOW_API_BASE/tools/tasks" \
    -H "Authorization: $DECKFLOW_API_KEY"

  const response = await fetch(`${process.env.DECKFLOW_API_BASE}/tools/tasks`, {
    method: "POST",
    headers: { "Authorization": process.env.DECKFLOW_API_KEY },
  });

  import os, requests

  response = requests.post(
      f"{os.environ['DECKFLOW_API_BASE']}/tools/tasks",
      headers={"Authorization": os.environ["DECKFLOW_API_KEY"]},
      timeout=60,
  )

密钥范围与计费

API 请求所产生的额度消耗将直接计入与该 API 密钥关联的账户或工作区。如果服务器、CI 任务、MCP 客户端或 CLI 脚本使用该密钥，则这些环境启动的所有任务都将消耗相同的工作区配额。

有关配额扣减规则和计费详情，请参阅定价与计费。

常见错误排查

状态码	含义	推荐排查方案
`401`	密钥缺失、无效、已过期，或使用了错误的 Header。	确认 `Authorization` 请求头，并从设置页面重新复制密钥。
`403`	密钥有效，但无权访问请求的工作区、功能或资源。	检查工作区成员资格、套餐权限和功能可用性。
`429`	密钥有效，但账户消耗超出了速率限制或配额上限。	降低请求并发或等待额度自动恢复。

安全最佳实践

切勿将 API 密钥提交到版本控制系统中。 请将 .env 添加到 .gitignore 中。
切勿在客户端或浏览器代码中直接暴露密钥。 应当从后端或受信任的自动化环境中调用 DeckFlow。
定期轮换或重新生成密钥。 当团队人员变动、服务器更换或密钥可能泄露时，应在设置页面重新生成密钥。
在设置中监控额度与使用情况。 定期查看配额消耗，排查是否存在异常任务或非预期流量。