dify-api
  1. 智能体
dify-api
  • 管理模块
    • 用户管理
      • 角色组
        • 获取用户分组列表
        • 新增用户分组
        • 修改用户分组
        • 删除用户分组
        • 为用户分配分组
        • 为智能体分配分组
        • 获取分组下用户
        • 获取分组下智能体
      • 用户管理
      • 更改用户类型
    • 智能体管理
      • 获取智能体列表
      • 创建智能体 - 准备
      • 创建智能体 - 开始创建
      • 更新智能体
      • 删除智能体
      • 设置默认智能体
      • 上传文件 OSS
    • 系统设置
      • 配置列表
      • 新增配置
      • 更新配置
  • C端模块
    • 用户体系
      • Wechat - 获取登录二维码
      • Wechat - 轮询扫码状态
      • Wechat - 微信服务器认证
      • MOCK - 模拟用户登录
      • 账号密码-注册
      • 账号密码-登录
      • 账号修改密码
      • 获取登录用户基本信息
    • 智能体
      • 智能体列表
        GET
      • 获取应用参数
        GET
    • AI 相关能力
      • 开始会话
      • 获取会话列表
      • 获取会话消息
      • 重命名会话
      • 获取建议问题
      • 消息反馈
      • 停止响应
      • 删除会话
      • 上传文件
      • API形式访问智能体
    • 地图服务
      • 通过数据生成地图录屏
      • 获取视频任务状态
    • 配置列表
      GET
  • Map服务
    • 录屏
      POST
    • 生成地图
      POST
    • 生成地图+录屏任务
      POST
    • 获取任务信息
      GET
  1. 智能体

获取应用参数

GET
/api/agents/parameters

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Query 参数
agent_key
string 
智能体标识
必需

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/agents/parameters?agent_key'

返回响应

🟢200成功
application/json
流式响应
Body
code
integer 
必需
message
string 
必需
data
object 
必需
opening_statement
string 
必需
suggested_questions
array[string]
必需
suggested_questions_after_answer
object 
必需
speech_to_text
object 
必需
text_to_speech
object 
必需
retriever_resource
object 
必需
annotation_reply
object 
必需
more_like_this
object 
必需
user_input_form
array [object {6}] 
必需
sensitive_word_avoidance
object 
必需
file_upload
object 
必需
system_parameters
object 
必需
示例
{
    "code": 0,
    "message": "string",
    "data": {
        "opening_statement": "string",
        "suggested_questions": [
            "string"
        ],
        "suggested_questions_after_answer": {
            "enabled": true
        },
        "speech_to_text": {
            "enabled": true
        },
        "text_to_speech": {
            "enabled": true,
            "voice": "string",
            "language": "string"
        },
        "retriever_resource": {
            "enabled": true
        },
        "annotation_reply": {
            "enabled": true
        },
        "more_like_this": {
            "enabled": true
        },
        "user_input_form": [
            {
                "text-input": {
                    "variable": "string",
                    "label": "string",
                    "type": "string",
                    "max_length": 0,
                    "required": true,
                    "options": [
                        "string"
                    ]
                },
                "paragraph": {
                    "variable": "string",
                    "label": "string",
                    "type": "string",
                    "max_length": 0,
                    "required": true,
                    "options": [
                        "string"
                    ]
                },
                "select": {
                    "variable": "string",
                    "label": "string",
                    "type": "string",
                    "max_length": 0,
                    "required": true,
                    "options": [
                        "string"
                    ]
                },
                "number": {
                    "variable": "string",
                    "label": "string",
                    "type": "string",
                    "max_length": 0,
                    "required": true,
                    "options": [
                        "string"
                    ]
                },
                "file": {
                    "variable": "string",
                    "label": "string",
                    "type": "string",
                    "max_length": 0,
                    "required": true,
                    "options": [
                        "string"
                    ],
                    "allowed_file_upload_methods": [
                        "string"
                    ],
                    "allowed_file_types": [
                        "string"
                    ],
                    "allowed_file_extensions": [
                        "string"
                    ]
                },
                "file-list": {
                    "variable": "string",
                    "label": "string",
                    "type": "string",
                    "max_length": 0,
                    "required": true,
                    "options": [
                        "string"
                    ],
                    "allowed_file_upload_methods": [
                        "string"
                    ],
                    "allowed_file_types": [
                        "string"
                    ],
                    "allowed_file_extensions": [
                        "string"
                    ]
                }
            }
        ],
        "sensitive_word_avoidance": {
            "enabled": true
        },
        "file_upload": {
            "image": {
                "enabled": true,
                "number_limits": 0,
                "transfer_methods": [
                    "string"
                ]
            },
            "enabled": true,
            "allowed_file_types": [
                "string"
            ],
            "allowed_file_extensions": [
                "string"
            ],
            "allowed_file_upload_methods": [
                "string"
            ],
            "number_limits": 0,
            "fileUploadConfig": {
                "file_size_limit": 0,
                "batch_count_limit": 0,
                "image_file_size_limit": 0,
                "video_file_size_limit": 0,
                "audio_file_size_limit": 0,
                "workflow_file_upload_limit": 0
            }
        },
        "system_parameters": {
            "image_file_size_limit": 0,
            "video_file_size_limit": 0,
            "audio_file_size_limit": 0,
            "file_size_limit": 0,
            "workflow_file_upload_limit": 0
        }
    }
}
修改于 2025-03-24 06:04:08
上一页
智能体列表
下一页
开始会话
Built with