获取Dify on DMS的API Key

更新时间:
复制 MD 格式

当您通过API调用在Dify工作室发布的应用时,需要先获取Dify API Key。本文为您介绍如何获取Dify on DMS的API Key。

注意事项

  • 目前每个Dify仅支持创建一个API Key。

  • 若您在工作空间的角色为开发,则无权限创建API Key。

  • 若您在工作空间的角色为访客,则无权限创建API Key和查看API Key的具体值。

获取API Key

  1. 以运维、空间管理员或开发角色进入工作空间。

  2. 在左侧导航栏选择image > Dify资源。

  3. 单击API KEY,在该页面您可查看已有的API Key或新建API Key。

    说明

    目前暂不支持删除API Key。后续会支持删除API Key,删除后API Key将会失效。

相关信息

社区版Dify支持在应用发布后通过API进行调用。出于安全合规要求,您需要在代码或API工具中新增可访问API的header:Dify API Key。Dify官网信息,请参见基于APIs开发。

重要
  • 该API 仅限测试使用,不支持大规模并发调用以及 90 秒以上的长连接。该 API 后续将逐步下线,请勿用于生产环境。

  • 如需在生产环境使用,请在创建Dify on DMS实例时,为实例创建内网或公网地址,然后通过该地址进行调用。您可以在工作空间的Dify资源页获取到实例内网地址和实例公网地址。

例如,在发送对话消息的请求中增加可访问API的header。

curl -X POST 'https://dify-{region_id}-dms.aliyuncs.com/v1' \
--header 'Authorization: Bearer app-xxxx' \
--header 'DifyApiKey: xxxx-xxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
    "inputs": {},
    "query": "What are the specs of the iPhone 13 Pro Max?",
    "response_mode": "streaming",
    "conversation_id": "",
    "user": "abc-123"
}'

第三方工具集成

DMS Dify API 同时支持 OpenAI 兼容协议和 Dify 原生协议:

  • OpenAI 兼容:POST /v1/chat/completions

  • Dify 原生:POST /v1/chat-messages

在第三方工具中配置自定义供应商调用 DMS Dify API 时,需提供以下参数:

参数

说明

API 兼容模式

OpenAI chat.completions

Base URL

https://dify-{region_id}-dms.aliyuncs.com/v1

API Key

在工作空间 > Dify资源 > API KEY 页面获取

模型 ID

通过 GET /v1/models 获取可用模型列表

重要
  • cn-hangzhou 地域的 API 域名不可达,请使用 cn-beijing、cn-shanghai、cn-shenzhen 等地域的域名。

  • 标准 Dify 的 Authorization: Bearer 认证方式不适用于 DMS Dify,需通过从 DMS 控制台工作空间获取的认证信息调用。

以 qwenpaw 为例,添加自定义供应商时:提供商 ID 可自定义(如 dms-dify),显示名称可自定义(如 DMS Dify),Base URL 填写可用地域的 Dify API 地址加 /v1,API 秘钥填写 DMS API Key,添加模型时模型 ID 通过 GET /v1/models 获取。