微步在线云API
我的API

XGPT

XGPT 是微步在线自研的网络安全大模型，基于 DeepSeek-R1 构建，融合微步丰富的情报库与安全知识库，专为网络安全场景深度优化，具备更强的中文理解与推理能力，能够提供高质量的威胁分析、处置建议与深度安全洞见。

调用脚本
Run In Postman
请求方式
请求地址： https://api.threatbook.cn/v3/xgpt/completion

请求方式：POST

使用说明

适用场景： 该接口适用于网络安全场景下的智能问答、告警解读、威胁分析摘要、处置建议生成和安全知识辅助查询。相关场景示例可参考：智能安全问答。

使用建议： 建议在调用前明确输入问题、上下文范围和输出用途。可将告警日志、IOC 情报、漏洞信息或安全事件背景作为上下文输入，但应避免提交不必要的敏感数据。模型输出适合作为分析辅助，关键处置建议仍应结合结构化情报字段、客户环境和人工确认。

响应字段解读建议： 建议重点读取 choice.message.content 获取模型回答，并结合 finish_reason 判断回答是否完整；若返回 length，说明达到最大 token 限制，可提高 max_tokens 或拆分问题后重新请求。id、created、model 适合用于日志追踪、效果评估和问题复现。

请求参数说明
序号参数名称必选类型描述
1message是array对话信息。是一个JSON数组，每个item的字段定义如下：
  • role：消息角色，目前支持user/assistant/system
  • content：消息内容
2max_tokens否int允许生成的最大 token 数，取值[1, 4000]，默认值为1024。
3model否string模型名称，默认为"XGPT-deepseek"
响应参数说明
序号参数名称类型描述使用说明
1response_codeint响应正常会返回"0"。其他Response code及对应msg描述参见"响应Code和Msg对照表"用于判断本次请求是否成功。业务系统应先判断该字段，再解析 data 内的业务结果；非 0 时建议按异常请求处理。
2verbose_msgstring响应正常会返回"Ok"。其他Response code及对应msg描述参见"响应Code和Msg对照表"用于展示或记录接口返回说明，适合写入调用日志和错误排查信息；自动化流程建议以 response_code 为主要判断依据。
3idstring请求 id用于调用链路追踪、问题排查和日志关联，反馈异常结果时建议提供该字段。
4createdstring表示本次 chat 请求被创建的时间用于记录请求创建时间，适合审计、日志和排障。
5choiceobject模型返回内容，是一个JSON对象，字段说明如下：
  • message：模型返回内容，是一个JSON对象，包含以下字段：
    • role：消息角色，目前支持user/assistant/system
    • content：消息内容
  • finish_reason：结束原因，string类型，"stop"表示正常生成结束， "length"表示已经到了制定的最大的 token 数量（max_tokens）
模型输出的主结果对象，建议重点读取 message.content 和 finish_reason。
6modelstring响应正常会返回"XGPT-deepseek"用于记录实际调用模型，方便效果评估、问题复现和后续模型切换。
请求示例

微步在线云API支持cURL、Python、PHP、Java、Go语言的请求，以Python为例：

Python
import requests
 
url = "https://api.threatbook.cn/v3/xgpt/completion"
 
headers = {
    "Authorization": "Bearer 请替换apikey",
    "Content-Type": "application/json"
}
 
query = {
    "message": [
        {
            "role": "user",
            "content": "What are the latest trends in cybersecurity?"
        }
    ],
    "max_tokens": 1024,
    "model": "XGPT-deepseek"
}
 
response = requests.post(url, headers=headers, json=query)  # Fixed params to json since content-type is json
 
print(response.json())
响应示例（JSON）
{
    "response_code": 0,
    "verbose_msg": "Ok",
    "data": {
        "id": "unique_request_id",
        "created": "2024-11-14T10:30:45Z",
        "choice": {
            "message": {
                "role": "assistant",
                "content": "The latest trends in cybersecurity include advancements in AI-driven threat detection, zero-trust architecture, and enhanced data privacy measures."
            },
            "finish_reason": "stop"
        },
        "model": "XGPT-deepseek"
    }
}
云API是北京微步在线科技有限公司旗下产品了解微步在线《用户服务条款》《数据保护政策》联系我们：api@threatbook.cn
Copyright © ThreatBook.CN All Rights Reserved. 京ICP备15044984号-4 北京微步在线科技有限公司 京公网安备11010802025715号