{
  "name": "tdai",
  "display_name": "腾讯云数据库 AI 服务",
  "description": "腾讯云数据库 AI 服务相关API接口主要提供数据库智能体实例的管控操作。",
  "domain": "other",
  "api_version": "2025-07-17",
  "endpoint": "tdai.tencentcloudapi.com",
  "actions": [
    {
      "name": "ContinueAgentWork",
      "description": "本接口（ContinueAgentWork）用于重启智能体实例的值守任务，通常在用户需要重启时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，为空时查询所有，如果填写则会根据InstanceId筛选",
          "example": "agentins-efbt5y3h"
        },
        {
          "name": "AgentTaskType",
          "type": "string",
          "required": false,
          "description": "Agent任务类型",
          "example": "sql_precheck"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "CreateAgentInstance",
      "description": "本接口（CreateAgentInstance）用于创建一个智能体实例，通常在用户购买一个智能体实例时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "AgentId",
          "type": "string",
          "required": false,
          "description": "智能体ID",
          "example": "agt-xpcn2t3e"
        },
        {
          "name": "AgentVersion",
          "type": "string",
          "required": false,
          "description": "智能体版本",
          "example": "v1.0.0.0"
        },
        {
          "name": "InstanceName",
          "type": "string",
          "required": false,
          "description": "实例名",
          "example": "风险SQL治理Agent实例"
        },
        {
          "name": "Parameters",
          "type": "array",
          "required": false,
          "description": "智能体实例的参数列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "参数键 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "git_branch"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "参数值 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "master"
            },
            {
              "name": "ValueType",
              "type": "string",
              "required": true,
              "description": "枚举值，可取值包括：string(字符串), int(整型), float(浮点型), bool(布尔型), struct(结构体), array(数组), 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "string"
            }
          ]
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "资源的标签信息",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签键",
              "example": "负责人"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": false,
              "description": "标签值",
              "example": "bob"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "CreateChatCompletion",
      "description": "用于创建一次会话的SSE接口",
      "status": "online",
      "parameters": [
        {
          "name": "IsHidden",
          "type": "boolean",
          "required": false,
          "description": "是否隐藏",
          "example": "false"
        },
        {
          "name": "IsChatHidden",
          "type": "boolean",
          "required": false,
          "description": "是否隐藏会话",
          "example": "false"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeAgentDutyTaskDetail",
      "description": "查询智能体值守任务详情",
      "status": "online",
      "parameters": [
        {
          "name": "Parameters",
          "type": "array",
          "required": false,
          "description": "业务参数列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "参数键 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "git_branch"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "参数值 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "master"
            },
            {
              "name": "ValueType",
              "type": "string",
              "required": true,
              "description": "枚举值，可取值包括：string(字符串), int(整型), float(浮点型), bool(布尔型), struct(结构体), array(数组), 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "string"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "DescribeAgentDutyTasks",
      "description": "查询智能体值守任务列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "agent实例ID",
          "example": "agtinst-s7u9342"
        },
        {
          "name": "ChatId",
          "type": "string",
          "required": false,
          "description": "会话ID",
          "example": "chat-xfwe24"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询开始位置",
          "example": "10"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "列表查询数量",
          "example": "10"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": false,
          "description": "任务启动时间",
          "example": "2025-08-11 10:00:00"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": false,
          "description": "任务结束时间",
          "example": "2025-08-12 10:00:00"
        },
        {
          "name": "AgentTaskType",
          "type": "string",
          "required": false,
          "description": "任务类型",
          "example": "sql_precheck"
        },
        {
          "name": "Parameters",
          "type": "array",
          "required": false,
          "description": "业务参数",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "参数键 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "git_branch"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "参数值 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "master"
            },
            {
              "name": "ValueType",
              "type": "string",
              "required": true,
              "description": "枚举值，可取值包括：string(字符串), int(整型), float(浮点型), bool(布尔型), struct(结构体), array(数组), 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "string"
            }
          ]
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeAgentInstance",
      "description": "本接口（DescribeAgentInstance）用于查询智能体实例详情，通常在用户查询所购买的所有智能体实例详情时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": false,
          "description": "实例ID，为空时查询所有，如果填写则会根据InstanceId筛选",
          "example": "agentins-efbt5y3h"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeAgentInstances",
      "description": "本接口（DescribeAgentInstances）用于查询智能体实例列表，通常在用户查询所购买的所有智能体列表。",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询开始位置",
          "example": "10"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "列表查询数量",
          "example": "10"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": false,
          "description": "实例ID，为空时查询所有，如果填写则会根据InstanceId筛选",
          "example": "agentins-efbt5y3h"
        },
        {
          "name": "InstanceName",
          "type": "string",
          "required": false,
          "description": "实例名，为空时查询所有，如果填写则会根据InstanceName筛选",
          "example": "风险SQL治理Agent实例"
        },
        {
          "name": "AgentId",
          "type": "string",
          "required": false,
          "description": "智能体ID，为空时查询所有，如果填写则会根据AgentId筛选",
          "example": "agt-xpcn2t3e"
        },
        {
          "name": "AgentName",
          "type": "string",
          "required": false,
          "description": "智能体名称，为空时查询所有，如果填写则会根据AgentName筛选",
          "example": "风险SQL治理Agent智能体"
        },
        {
          "name": "AgentInternalName",
          "type": "string",
          "required": false,
          "description": "智能体类型，为空时查询所有，如果填写则会根据AgentName筛选",
          "example": "aid"
        },
        {
          "name": "Status",
          "type": "string",
          "required": false,
          "description": "智能体实例状态，为空时查询所有，如果填写则会根据Status筛选",
          "example": "running"
        },
        {
          "name": "TagFilter",
          "type": "array",
          "required": false,
          "description": "标签过滤信息",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签键",
              "example": "负责人"
            },
            {
              "name": "TagValue",
              "type": "array",
              "required": false,
              "description": "标签值",
              "example": "[\"bob\"]",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "DescribeAgents",
      "description": "本接口（DescribeAgents）用于查询智能体列表，通常在用户查询所购买的所有智能体列表。",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询开始位置",
          "example": "10"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "列表查询数量",
          "example": "10"
        },
        {
          "name": "AgentId",
          "type": "string",
          "required": false,
          "description": "智能体ID，为空时查询所有，如果填写则会根据AgentId筛选",
          "example": "agt-xpcn2t3e"
        },
        {
          "name": "AgentName",
          "type": "string",
          "required": false,
          "description": "智能体名称，为空时查询所有，如果填写则会根据AgentName筛选",
          "example": "风险SQL治理Agent智能体"
        },
        {
          "name": "AgentInternalName",
          "type": "string",
          "required": false,
          "description": "智能体类型，为空时查询所有，如果填写则会根据AgentName筛选",
          "example": "aid"
        },
        {
          "name": "AgentStatus",
          "type": "string",
          "required": false,
          "description": "智能体状态，为空时查询所有，如果填写则会根据AgentStatus筛选",
          "example": "normal"
        },
        {
          "name": "DeployPlace",
          "type": "string",
          "required": false,
          "description": "架构，共享版-intranet，企业版-userVpc",
          "example": "intranet"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeChatDetail",
      "description": "本接口（DescribeChatDetail）用于查询对话详情，通常在用户查询会话的历史记录时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "智能体ID",
          "example": "agtins-acegikm"
        },
        {
          "name": "ChatId",
          "type": "string",
          "required": false,
          "description": "会话Id",
          "example": "chat-acegikm"
        },
        {
          "name": "StreamingId",
          "type": "string",
          "required": false,
          "description": "流ID",
          "example": "strm-j92jbf9w"
        },
        {
          "name": "BeginStreamingTokenId",
          "type": "integer",
          "required": false,
          "description": "开始拉取的流式TokenID。0表示从该流最早的TokenID开始获取",
          "example": "0"
        },
        {
          "name": "TokenLimit",
          "type": "integer",
          "required": false,
          "description": "单次获取的token数量，默认2000",
          "example": "2000"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeChats",
      "description": "本接口（DescribeChats）用于查询对话列表，通常在用户查询会话列表时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "智能体ID",
          "example": "agtins-xxxxxxxx"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询开始位置",
          "example": "10"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "列表查询数量",
          "example": "10"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeReportUrl",
      "description": "智能体报告地址生成并下载",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "IsolateAgentInstance",
      "description": "本接口（IsolateAgentInstance）用于隔离智能体实例，通常在用户需要隔离智能体实例时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，为空时查询所有，如果填写则会根据InstanceId筛选",
          "example": "agentins-efbt5y3h"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ModifyAgentInstanceParameters",
      "description": "本接口（ModifyAgentInstanceParameters）用于修改智能体实例的参数列表，通常在用户需要配置智能体实例时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "agentins-efbt5y3h"
        },
        {
          "name": "TaskType",
          "type": "string",
          "required": false,
          "description": "任务类型, 可选，默认default",
          "example": "default"
        },
        {
          "name": "Parameters",
          "type": "object",
          "required": false,
          "description": "更新的参数列表",
          "example": "无",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "参数键 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "git_branch"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "参数值 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "master"
            },
            {
              "name": "ValueType",
              "type": "string",
              "required": true,
              "description": "枚举值，可取值包括：string(字符串), int(整型), float(浮点型), bool(布尔型), struct(结构体), array(数组), 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "string"
            }
          ]
        },
        {
          "name": "SqlAgentParameter",
          "type": "object",
          "required": false,
          "description": "风险SQL智能体参数列表",
          "example": "无",
          "children": [
            {
              "name": "InstanceInfos",
              "type": "array",
              "required": false,
              "description": "数据库实例信息列表",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Region",
                  "type": "string",
                  "required": true,
                  "description": "数据库地域",
                  "example": "ap-guangzhou"
                },
                {
                  "name": "InstanceId",
                  "type": "string",
                  "required": true,
                  "description": "数据库实例id",
                  "example": "cdb-jgmilzl8"
                },
                {
                  "name": "DatabaseName",
                  "type": "string",
                  "required": false,
                  "description": "数据库名称",
                  "example": "test_database"
                },
                {
                  "name": "TableName",
                  "type": "string",
                  "required": false,
                  "description": "表名称",
                  "example": "test_table"
                }
              ]
            },
            {
              "name": "CodeRepo",
              "type": "object",
              "required": false,
              "description": "代码仓库信息",
              "example": "无",
              "children": [
                {
                  "name": "RepoUrl",
                  "type": "string",
                  "required": true,
                  "description": "代码仓库地址",
                  "example": "https://git.woa.com/calvinliao/tcs-middleware"
                },
                {
                  "name": "Branch",
                  "type": "string",
                  "required": true,
                  "description": "分支名",
                  "example": "master"
                },
                {
                  "name": "GitCommitPipelines",
                  "type": "array",
                  "required": false,
                  "description": "Commit信息",
                  "example": "[\"bdbe54afaa7e60b11cd87682bd9ab59c92a489ac\"]",
                  "item_type": "string"
                },
                {
                  "name": "GitORMType",
                  "type": "string",
                  "required": false,
                  "description": "数据库ORM类型",
                  "example": "goframe"
                },
                {
                  "name": "GitCodeLanguage",
                  "type": "string",
                  "required": false,
                  "description": "代码编写语言",
                  "example": "golang"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ModifyChatTitle",
      "description": "本接口（ModifyChatTitle）用于修改会话标题，通常在用户修改会话标题时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "智能体ID",
          "example": "agtins-xxxxxxxx"
        },
        {
          "name": "ChatId",
          "type": "string",
          "required": false,
          "description": "会话Id",
          "example": "chat-xxxxxxxx"
        },
        {
          "name": "Title",
          "type": "string",
          "required": false,
          "description": "标题",
          "example": "新标题"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "PauseAgentWork",
      "description": "本接口（PauseAgentWork）用于暂停智能体实例的值守任务，通常在用户需要暂停时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，为空时查询所有，如果填写则会根据InstanceId筛选",
          "example": "agentins-efbt5y3h"
        },
        {
          "name": "AgentTaskType",
          "type": "string",
          "required": false,
          "description": "Agent任务类型",
          "example": "sql_precheck"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "RecoverAgentInstance",
      "description": "本接口（RecoverAgentInstance）用于解隔离智能体实例，通常在用户需要解隔离智能体实例时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，为空时查询所有，如果填写则会根据InstanceId筛选",
          "example": "agentins-efbt5y3h"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "RemoveChat",
      "description": "本接口（RemoveChat）用于删除会话，通常在用户删除会话时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "智能体ID",
          "example": "agtins-xxxxxxxx"
        },
        {
          "name": "ChatId",
          "type": "string",
          "required": false,
          "description": "会话Id",
          "example": "chat-xxxxxxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "StartAgentTask",
      "description": "该接口用于启动一个智能体的任务",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "agentins-example"
        },
        {
          "name": "InstanceToken",
          "type": "string",
          "required": false,
          "description": "配置Token",
          "example": "QWER"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "TerminateAgentInstance",
      "description": "本接口（TerminateAgentInstance）用于下线智能体实例，通常在用户需要下线智能体实例时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，为空时查询所有，如果填写则会根据InstanceId筛选",
          "example": "agentins-efbt5y3h"
        }
      ],
      "required": [
        "InstanceId"
      ]
    }
  ]
}