API文档

通过API接口,将AI能力集成到您的应用中。


简介

本平台提供RESTful API接口,支持AI对话、知识库查询、文本翻译、摘要生成等功能。

Base URL: https://ai.mzcms.com/openapi/


认证方式

所有API请求需要携带API Key进行认证,支持以下方式:

方式1:Header认证(推荐)
X-API-Key: sk-your-api-key
方式2:Bearer Token
Authorization: Bearer sk-your-api-key
方式3:Query参数
GET /openapi/xxx?api_key=sk-your-api-key

AI对话

POST /openapi/chat

与AI进行对话。

请求参数
参数类型必填说明
messagestring用户消息
systemstring系统提示词
historyarray历史消息
knowledge_baseboolean是否使用知识库
max_tokensinteger最大Token数,默认2000
temperaturefloat温度,默认0.7
请求示例
curl -X POST https://ai.mzcms.com/openapi/chat \
  -H "X-API-Key: sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "你好,请介绍一下自己",
    "system": "你是一个友好的助手"
  }'
响应示例
{
  "code": 0,
  "msg": "success",
  "data": {
    "content": "你好!我是AI助手...",
    "model": "Qwen/Qwen2.5-7B-Instruct",
    "usage": {
      "prompt_tokens": 20,
      "completion_tokens": 50,
      "total_tokens": 70
    }
  }
}

知识库

GET /openapi/knowledge/search

搜索知识库文档。

参数类型必填说明
qstring搜索关键词
space_idinteger知识空间ID
pageinteger页码,默认1
limitinteger每页数量,默认10
GET /openapi/knowledge/doc/{id}

获取文档详情。

GET /openapi/knowledge/spaces

获取知识空间列表。


AI工具

POST /openapi/translate

文本翻译。

参数类型必填说明
textstring要翻译的文本
targetstring目标语言:zh/en/ja/ko,默认zh
POST /openapi/summarize

文本摘要。

参数类型必填说明
textstring要摘要的文本
lengthstring摘要长度:short/medium/long
POST /openapi/keywords

关键词提取。

POST /openapi/classify

文本分类。


错误码

HTTP状态码code说明
2000成功
400400请求参数错误
401401认证失败(API Key无效)
429429请求频率超限
500500服务器内部错误