企业级 APIs（Admin APIs）遵循 REST API 规范，旨在帮助你在 Dify 企业版平台内实现高效的自动化管理。为了便于阅读，后续将统一使用 Admin APIs。

支持对以下资源的信息查询和管理操作：

  • Workspaces：全局工作空间管理，支持工作空间信息的查询与管理。
  • Members：全局团队成员管理，支持团队成员信息的查询与管理。
  • Workspace Member：工作空间内成员管理，支持成员信息的查询与管理。

随着版本迭代，将支持更多 Admin API，涵盖更丰富的操作和资源管理功能。

​
API 类型

Dify 平台内存在不同层级的 API 服务，为避免使用误导，现作出以下区分：

  • 应用内提供的 API 称为 Workspace API。

  • 针对 Dify 平台管理操作的 API 统称为 Admin API。

​
端点 URL

Admin APIs 使用以下端点地址。实际调用 API 时，请将 your-domain 替换为你的 Dify 企业版平台域名，并在后缀添加各个请求的路径以形成完整的 API 端点。

https://your-domain/admin-api/v1

​
认证

请求 API 时要求输入鉴权 Secret Key，请前往 Dify 企业版管理后台中的 Admin APIs 页生成并配置 Key。

调用 Admin APIs 时可能会影响企业内部的生产数据，请谨慎操作。

​
使用示例

为了便于理解，以下示例将演示如何使用 Admin APIs 查看当前工作空间列表（List Workspaces）。

​
1. 创建 API Key

在企业版管理后台，点击 Admin APIs 页右上角的 Add 按钮，按提示创建 API Key。

​
2. 导入 API 文件并修改环境变量

下载页面提供的 Postman Collection 配置文件。

将该文件导入至 Postman 内，替换 Variables 中的 base_url 和 secret_key。

​
3. 发送请求

发送请求，获取响应结果。你可以在响应结果内查看当前企业版内完整工作空间列表及对应信息。

{
    "data": [
        {
            "id": "a7145b74-****--****---****",     # 工作空间 ID
            "name": "Workspace A Name",             # 工作空间名称
            "status": "normal",                     # 工作空间状态
            "created_at": "2025-02-08T02:45:33Z",   # 工作空间创建时间
            "updated_at": "2025-02-08T02:45:33Z"    # 工作空间更新时间
        },
        {
            "id": "bbffbfdf-****--****---****",
            "name": "Dify's Workspace",
            "status": "normal",
            "created_at": "2025-02-07T16:55:59Z",
            "updated_at": "2025-02-07T16:55:59Z"
        },
    ],
    "has_more": true,
    "limit": 10,
    "page": 1,
    "total": 491
}