应用详情

获取已发布应用的完整配置详情，包含基础信息与应用编排（AppSchema：模型、提示词、工具、知识库、技能、记忆、交互配置等）。支持按版本号获取指定版本，不传则返回最新发布版本。

接口路径：POST /v1/openapi/apps/detail

请求头

参数名	必填	说明
Content-Type	是	`application/json`
Authorization	是	鉴权凭证，格式 `Bearer sk_xxx`

请求参数

json

{
    "app_id": "",      // 必填-应用ID
    "version": ""      // 版本号（可选），为空时获取最新发布版本
}

参数名	类型	必填	说明
app_id	string(uuid)	是	应用 ID
version	string	否	语义版本号（如 `1.0.1`），为空时取最新发布版本

返回数据

json

{
    "code": 200,
    "message": "success",
    "data": {
        "app_id": "01965de1-1920-7fe4-aa38-2e6836c46f22",
        "workspace_id": "01965de1-1920-7fe4-aa38-2e6836c46f22",
        "name": "医疗问答助手",
        "description": "面向门诊的智能问答",
        "icon": "robot",
        "icon_background": "#E0F2FE",
        "icon_color": "#0284C7",
        "app_type": 2,
        "app_source": 1,
        "status": 1,
        "is_lite": false,
        "created_at": "2025-04-22 22:22:34",
        "updated_at": "2025-04-22 22:30:11",
        "app_schema": {
            "loose_status": 0,
            "free_models": [],
            "model_info": {
                "model_id": "01965de1-1920-7fe4-aa38-2e6836c46f22",
                "config": []
            },
            "prompt": {
                "type": 1,
                "text": "你是一名专业的医疗助手...",
                "content": {"identity": "", "soul": "", "agents": "", "user": ""},
                "variables": [
                    {
                        "variable_name": "tone",
                        "display_name": "语气",
                        "description": "选择回复的表达方式",
                        "schema": "{\"type\":\"string\"}",
                        "control_type": "select",
                        "control_spec": {
                            "options": ["正式", "简洁"],
                            "placeholder": "请选择语气"
                        },
                        "default_value_state": "value",
                        "default_value": "正式",
                        "required": false,
                        "writable": false,
                        "encrypted": false
                    }
                ]
            },
            "tool_list": [],
            "skill_list": [],
            "knowledge_list": [],
            "data_table_list": [],
            "memory_config": {
                "global_term": 0,
                "short_term": {"context_round": 20},
                "long_term": {"name": []}
            },
            "interaction_config": {
                "chat_prologue": {"status": 1, "prologue": "您好...", "suggested_questions": []},
                "user_suggestion": {"status": 0, "custom_prompt": 0, "prologue": ""},
                "voice": {
                    "tts": {"status": 0, "provider": "", "code": ""},
                    "asr": {"status": 0, "provider": ""}
                },
                "runtime_setting": {"max_steps": 40}
            },
            "version_meta": {
                "version": "1.0.1",
                "version_name": "首个正式版",
                "version_desc": "",
                "is_latest": true,
                "is_draft": false,
                "is_auto_ver": false,
                "published_at": "2025-04-22 22:30:11"
            }
        }
    }
}

基础信息字段

字段	类型	说明
app_id	string(uuid)	应用 ID
workspace_id	string(uuid)	工作空间 ID
name	string	应用名称
description	string	应用描述
icon / icon_background / icon_color	string	图标及配色
app_type	uint8	应用类型：`1`-claw、`2`-agent、`3`-agent_lite、`4`-text_completion、`5`-chat_flow
app_source	uint8	应用来源：`1`-自建、`2`-Dify、`3`-FastGPT
status	uint8	启用状态：`0`-禁用、`1`-启用
is_lite	bool	是否为轻量类型（AgentLite / TextCompletion / ChatFlow 等）
created_at / updated_at	string	创建 / 更新时间，`YYYY-MM-DD HH:mm:ss`

app_schema 应用编排

字段	类型	说明
loose_status	uint8	自由模式：`0`-禁用、`1`-启用。启用后调用方可在请求中用 `select_model_id` 指定模型
free_models	array	自由模式下可选的模型列表
model_info	object	应用绑定的模型配置，含 `model_id` 与参数 `config`
prompt	object	提示词模板，含 `type`、`text`、`content`、`variables`
tool_list	array	已挂载工具列表（插件 / MCP / 工作流 / 三方服务 / 内置工具，按 `type` 区分）
skill_list	array	已挂载技能列表
knowledge_list	array	已关联知识库列表
data_table_list	array	已关联数据表列表
memory_config	object	记忆配置（全局记忆、短期记忆轮数、长期记忆库）
interaction_config	object	交互配置，结构同应用配置接口
version_meta	object	版本元信息

TIP

interaction_config 的字段说明（开场白、用户问题建议、语音、运行设置）详见应用配置接口文档。客户端若仅需交互配置，推荐使用更轻量的应用配置接口。

prompt.variables 提示词变量

字段	类型	说明
variable_name	string	变量名称，对应提示词引用名称和发送消息时 `input` 的 key
display_name	string	变量显示名称
description	string	变量用途、格式或填写说明
schema	string	JSON String 格式的数据结构定义，解析后支持 `string`、`integer`、`float`、`boolean`、`object` 和 `list`
control_type	string	输入控件类型，如 `text_input`、`select`、`multi_select`、`date_picker`、`code_editor`、`file_upload`
control_spec	object	控件补充配置，可包含 `options`、`max_length`、`placeholder`、`checked_value`、`unchecked_value`
default_value_state	string	默认值状态：`unset`-未设置、`value`-有明确值、`masked`-已有值但不返回明文
default_value	any	`default_value_state=value` 时的默认值，类型必须符合 `schema`
required	bool	是否必填
writable	bool	是否允许通过 Workflow / ChatFlow 的变量赋值节点写入
encrypted	bool	是否按加密变量处理

变量的数据类型、控件组合、Schema 结构和默认值状态详见变量协议。

version_meta 版本元信息

字段	类型	说明
version	string	语义版本号（如 `1.0.1`）
version_name	string	版本名称
version_desc	string	版本描述
is_latest	bool	是否为最新版本
is_draft	bool	是否为草稿
is_auto_ver	bool	是否自动发版
published_at	string	发布时间，`YYYY-MM-DD HH:mm:ss`

应用详情 ​

请求头 ​

请求参数 ​

返回数据 ​

基础信息字段 ​

app_schema 应用编排 ​

prompt.variables 提示词变量 ​

version_meta 版本元信息 ​