AI智能体 搭建指南
API对接文档
Agent平台组件开发规约
更新日志
体验
AI智能体 搭建指南
API对接文档
Agent平台组件开发规约
更新日志
体验

获取助手信息(技能编排)

curl -X GET 'https://HOST:PORT/api/v1/third_interface/flow/info?key=秘钥'

鉴权

出于安全考虑，必须将 TOKEN 存储于服务端并通过后端接口调用，避免在前端代码中直接暴露，以防止凭证泄露造成损失

请在 HTTP 请求的 Authorization 请求头中包含您的 TOKEN，格式如下：

Authorization: Bearer {YOUR_TOKEN}

TOKEN获取可通过 个人令牌 和 OAuth 应用获取，具体见 个人令牌授权，OAuth 授权码授权

应用秘钥key 的获取具体见 生成应用密钥

Request Params

  • key* (str)秘钥

Response

  • status_code (int) 状态码
  • status_message (str) 消息 正常返回success
  • data (object)
    • start_node_id (str) 首个节点的ID
    • id (str) 助手ID
    • name (str) 助手名称
    • description (str) 描述
    • guide_question (str) 引导问题
    • guide_word (str) 开场白
    • is_file (int) 是否可上传文件 0否 1是
    • file_amount (int) 文件上传数量
    • file_size_limit (int) 文件上传总字数限制
    • is_img (int) 是否可上传图片 0否 1是
    • photo_amount (int) 文件可上传数量
    • input_variables (list) 可传入的变量列表
    • input_forms (list) 可传入表单变量列表
      • formName (str) 表单名称
      • form_variables (list) 表单变量列表
        • model (str) 变量名
        • type (str) 控件类型
        • label (str) 标签名
        • format (str) 日志格式（针对日期控件 DatePicker）
        • options (dict) 配置项
          • disabled (bool) 是否禁用填写
          • defaultValue (str) 默认值
          • maxSize (int) 文件最大大小（针对文件、图片上传控件 UploadFile UploadImage）
          • maxCount (int) 文件最大上传数量（针对文件、图片上传控件 UploadFile UploadImage）
          • accept (str) 可接受的文件格式（针对文件、图片上传控件 UploadFile UploadImage）
          • options (list) 下拉框列表（针对下拉框 单选框 复选框 Select Radio Checkbox）

            • label (str) 选项名

            • value (str) 选项值

{
  "status_code": 200,
  "status_message": "SUCCESS",
  "data": {
    "start_node_id": "ConditionalBranch-e9bb8",
    "id": "89de097358ec4f0bb3bfaec7d715b5c3",
    "name": "高级变量例子",
    "description": "高级变量例子",
    "guide_question": [
      "引导问题1",
      "引导问题2"
    ],
    "guide_word": "这是开场引导",
    "is_file": 1,
    "file_amount": 1,
    "file_size_limit": 8000,
    "is_img": 1,
    "photo_amount": 1,
    "input_variables": [
      "input",
      "file_list"
    ],
    "input_forms": [
      {
        "formName": "表单1",
        "form_variables": [
          {
            "model": "Input_1744788467616",
            "type": "Input",
            "label": "输入框",
            "options": {
              "formName": "表单1",
              "disabled": false,
              "defaultValue": "今天天气"
            }
          },
          {
            "model": "InputTextera_1744788464857",
            "type": "InputTextera",
            "label": "文本框",
            "options": {
              "formName": "表单1",
              "disabled": false,
              "defaultValue": ""
            }
          },
          {
            "model": "InputNumber_1744788460520",
            "type": "InputNumber",
            "label": "数字输入框",
            "options": {
              "formName": "表单1",
              "disabled": false,
              "defaultValue": ""
            }
          },
          {
            "model": "Select_1744788459205",
            "type": "Select",
            "label": "下拉选择器",
            "options": {
              "formName": "表单1",
              "disabled": false,
              "defaultValue": "选项1",
              "options": [
                {
                  "label": "选项1",
                  "value": "选项1"
                },
                {
                  "label": "选项2",
                  "value": "选项2"
                }
              ]
            }
          },
          {
            "model": "Radio_1744788457888",
            "type": "Radio",
            "label": "单选框",
            "options": {
              "formName": "表单1",
              "disabled": false,
              "defaultValue": "",
              "options": [
                {
                  "label": "选项1",
                  "value": "选项1"
                },
                {
                  "label": "选项2",
                  "value": "选项2"
                },
                {
                  "label": "选项3",
                  "value": "选项3"
                }
              ]
            }
          },
          {
            "model": "Checkbox_1744788456599",
            "type": "Checkbox",
            "label": "复选框",
            "options": {
              "formName": "表单1",
              "disabled": false,
              "defaultValue": "",
              "options": [
                {
                  "label": "选项1",
                  "value": "选项1"
                },
                {
                  "label": "选项2",
                  "value": "选项2"
                },
                {
                  "label": "选项3",
                  "value": "选项3"
                }
              ]
            }
          },
          {
            "model": "DatePicker_1744788455301",
            "type": "DatePicker",
            "label": "日期选择框",
            "options": {
              "formName": "表单1",
              "disabled": false,
              "defaultValue": "",
              "format": "YYYY-MM-DD"
            }
          },
          {
            "model": "UploadFile_1744788453579",
            "type": "UploadFile",
            "label": "上传文件",
            "options": {
              "formName": "表单1",
              "disabled": false,
              "defaultValue": "",
              "max_size": 5,
              "max_count": 3,
              "accept": ".pdf,.docx,.xlsx,.pptx,.txt,.jpg,.jpeg,.png,.bmp"
            }
          },
          {
            "model": "UploadImage_1744788451800",
            "type": "UploadImage",
            "label": "上传图片",
            "options": {
              "formName": "表单1",
              "disabled": false,
              "defaultValue": "",
              "max_size": 5,
              "max_count": 3,
              "accept": ".jpg,.jpeg,.png,.bmp"
            }
          }
        ]
      }
    ]
  }
}

消息发送事例

{ "chatHistory": [], "flow_id": "89de0973-58ec-4f0b-b3bf-aec7d715b5c3", "chat_id": "debug_372044c2b3379d63", "name": "高级变量例子", "description": "高级变量例子", "inputs": { "input": "表单1", "id": "ConditionalBranch-e9bb8", "file_list": [], "form": { "Input_1744788467616": "今天天气", "InputTextera_1744788464857": "文本框今天天气", "InputNumber_1744788460520": 29, "Select_1744788459205": "选项2", "Radio_1744788457888": "选项3", "Checkbox_1744788456599": [ "选项1", "选项2" ], "DatePicker_1744788455301": "2025-04-24", "UploadFile_1744788453579": [ { "file_path": "http://Host:PORT/api/v1/file/download?object_name=20250423315a474b1b2d4ee8934aa52122b83f21.docx", "object_name": "20250423315a474b1b2d4ee8934aa52122b83f21.docx", "file_name": "请假.docx", "hash_code": "a68dc3dc2aa50de0088c12c2c0fdfbb4" } ], "UploadImage_1744788451800": [ { "file_path": "http://Host:PORT/api/v1/assistant/read-image?object_name=20250422-29b7dc7b-336f-4f88-89c4-5f8aaf9f4ba3.png", "file_name": "照片.png", "file_id": "9a107380-fd00-4b16-bc95-49f75aaa679a", "file_status": 1 } ] } } }
ON THIS PAGE