跳转到主要内容
千问云 home page
开放平台文档
使用 API

配置 API Key

避免在代码中硬编码密钥

前提条件

先创建 API Key。

操作步骤

  • Linux
  • macOS
  • Windows

永久环境变量

为当前用户设置永久环境变量：
1

添加环境变量

将变量写入 ~/.bashrc：
# 将 YOUR_DASHSCOPE_API_KEY 替换为您的 API Key
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bashrc
打开 ~/.bashrc：
nano ~/.bashrc
在文件中添加以下内容：
# 将 YOUR_DASHSCOPE_API_KEY 替换为您的 API Key
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
在 nano 编辑器中，按 Ctrl+X，然后按 Y，再按 Enter 保存并关闭文件。
2

使变更生效

执行以下命令：
source ~/.bashrc
3

验证

在新的终端会话中验证：
echo $DASHSCOPE_API_KEY

临时环境变量

设置临时变量（仅当前会话有效）：
1

设置变量

# 将 YOUR_DASHSCOPE_API_KEY 替换为您的 API Key
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
2

验证

echo $DASHSCOPE_API_KEY

常见问题

echo 能输出，但代码提示"未找到 API Key"

常见原因：
  • 未设置永久变量：临时变量仅在当前会话有效，请改用永久环境变量。
  • 需要重启：重启 IDE、终端或应用程序。通过服务管理器托管的应用可能需要重启服务。
  • 服务管理器配置：对于由服务管理器（systemd、supervisord）托管的应用，需要在服务配置文件中添加该环境变量。
  • 使用了 sudo：sudo 不会继承环境变量。使用 sudo -E python xx.py（-E 参数会传递环境变量），或在权限允许时不使用 sudo。
  • 需要设置 Base URL：设置千问云的 Base URL：
    • 在代码中设置：
dashscope.base_http_api_url = 'https://dashscope.aliyuncs.com/api/v1'
  • 通过环境变量设置：
export DASHSCOPE_HTTP_BASE_URL='https://dashscope.aliyuncs.com/api/v1'