版本历史

版本	状态	作者	创建日期	备注
v1.0	已发布	姚思崎	2023-12-05	--
v1.1	未发布	姚思崎	--	优化基于sse交互模型交互接口
v1.2	已发布	陈冰	2025-2-8	--

1. 接入流程说明

流程说明：

1. 与商务沟通，开通用户密钥、模型权限，授权成功后用户可在“MaaS-授权模型页-模型授权信息”查看API KEY、Secret Key。
2. 于“授权模型页”点击激活按钮，进行模型部署。（DeepSeek模型无需激活）
3. 将 API KEY、Secret Key 加入请求体。对需上传文件的模型，同时调用“文件上传”与“下载文件”的接口。
4. 发起请求，获取模型接口返回内容。

1.1 服务地址

环境	URL	备注
生产环境	http://maas-openapi.wanjiedata.com/maas-open-api	已发布
测试环境	单独提供	已发布

1.2 调用方式

每个接口有对应的请求方式(GET/POST)，请严格按照文档说明选择相应的调用方式。

1.3 请求报文格式

HTTP GET

• 参数编码在URL中

HTTP POST

• 参数以JSON格式填入Request的Body中
• Request的_Content-Type_为application/json; charset=utf-8

1.4 响应报文格式

接口返回结果为JSON格式，Response的Content-Type均为application/json; charset=utf-8

每个接口返回的数据格式如下：

{
    "timestamp": 1688095311701,
    "code": 0,
    "message": "ok",
    "result": {}
}

各参数说明如下：

参数	说明
code	接口状态码
message	接口状态描述
result	具体的业务数据
timestamp	服务端时间戳

1.5 返回码说明

接口状态码	说明
0	成功
2000	失败
1000	密钥对不正确或未生效
1001	模型未授权
1002	文件上传失败
1003	文件下载失败

1.6 请求公共参数

参数名	说明
apiKey	模型接口key，此参数放入请求头。
secretKey	apiKey的配对密钥，此参数放入请求头。

请求头示例：

apiKey:d0c11993786706E34259647315Ad8715
secretKey:31d2d6CB3E11723FeBaA813d982116ea

2. 接口列表

2.1 文件上传

POST /api/file/v1/uploadFile请求示例：

maasFile = k2.jpeg

请求体参数说明：

名称	类型	是否必填	说明
maasFile	multipart/form-data	required	1. 使用multipart/form-data方式提交数据,key为maasFile。

2. 图片大小 <= 5MB。
3. 图片仅支持单文件上传。 |

响应示例：

{
    "success": true,
    "message": "",
    "code": 0,
    "result": {
        "fileKey": "2023-12/00034-2845487295_1701755152007.png",
        "fileCode": "31c9909982eeeb5e8159dc84edad9a41"
    },
    "timestamp": 1701755157984
}

响应参数说明：

名称	类型	说明
fileCode	string	文件下载验证码
fileKey	string	文件的key

2.2 下载文件

GET /api/file/v1/download请求示例：

/api/file/v1/download?fileKey=2023-12/00034-2845487295_1701755152007.png&fileCode=31c9909982eeeb5e8159dc84edad9a41

请求参数说明：

名称	类型	是否必填	默认值	说明
fileCode	string	required		文件下载验证码
fileKey	string	required
文件的key

2.3 可用的模型

GET /api/model/v1/getModelList响应示例：

{
	"success": true,
	"message": "",
	"code": 0,
	"result": [
		{
			"id": "1704419089321107458",
			"modelName": "多轮聊天模型",
			"interactionType": 1
		},
		{
			"id": "1719251908753969154",
			"modelName": "OCR",
			"interactionType": 0
		},
		{
			"id": "1719264740270755842",
			"modelName": "通用情感分析",
			"interactionType": 0
		}
	],
	"timestamp": 1701842538273
}

响应参数说明：

名称	类型	说明
id	string	模型id
modelName	string	模型名称
interactionType	int	交互类型：0 短连接 1 sse交互

2.4 模型交互(http短链接)

POST /api/model/v1/shortInteraction?modelId=xxx请求示例：

{
  "modelInteractionList": [
    {"path": "2023-12/00034-2845487295_1701755152007.png"}
  ]
}

请求参数说明：

名称	类型	是否必填	说明
modelId	string	required	模型id**（通过可用的模型接口获取）**
path	string	optional	文件key，当交互内容是非文本内容时，必填。
message	string	optional	用户输入的内容，当交互内容是文本内容时，必填。

响应示例：

{
    "success": true,
    "message": "",
    "code": 0,
    "result": {
        "url": "2023-12/output_1701757525452775_1701757525679.jpg",
        "fileCode": "99ae49af7889a603f8ce73ca52a1dbd1",
    },
    "timestamp": 1701757527117
}

响应参数说明：

名称	类型	说明
url	string	文件的key
fileCode	string	文件下载验证码

2.5 模型交互(sse交互)

POST /api/model/v1/longInteraction?modelId=xxx请求头示例：

参数名	说明
chatId	会话id(此参数不传时，响应参数会生成新的会话id，否则原样返回。)

请求头示例：

chatId:6e41345b-3b54-444c-919d-64d312937bc6

请求体示例：

{
    "modelInteractionList": [
        {
            "message": "武汉有什么特产"
        }
    ]
}

请求参数说明：

名称	类型	是否必填	说明
modelId	string	required	模型id**（通过可用的模型接口获取）**
message	string	required	用户输入的内容

响应示例：

id:1704336628549
event:message
retry:10000
data:问

id:1704336628587
event:message
retry:10000
data:题

id:1704336628621
event:message
retry:10000
data:。

id:1704336628656
event:message
retry:10000
data:

id:1704336628692
event:complete
retry:10000

响应参数说明：

名称	类型	说明
id	long	会话聊天流式内容唯一标识
event	string	事件类型：
message：sse服务端正常推送数据，但未结束。
complete：sse服务端正常推送数据结束。
retry	long	客户端重新发起连接的时间间隔
data	string	会话聊天返回内容