MrKop One API
使用文档返回首页
平台概览API 接入API 参考模型说明额度规则三方工具接入常见问题错误码参考

MrKop One API v0.26.5

API 参考

MrKop One API 提供 OpenAI 与 Anthropic 两种兼容协议,以及企业管理和 MCP 端点。

认证方式

所有公开 API 请求需携带入口 API Key:

http
# 方式一:Authorization Header(推荐)
Authorization: Bearer mrkop-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# 方式二:X-API-Key Header
X-API-Key: mrkop-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

管理后台 API 使用 JWT Bearer Token:

http
Authorization: Bearer <jwt_token>

API Key 在 Key 管理 页面创建。企业用户可在 企业管理 中创建企业级密钥。

速率限制

所有 API 请求均受速率限制。响应头中包含以下限流信息:

响应头说明
X-RateLimit-Limit-Requests每分钟请求上限
X-RateLimit-Remaining-Requests当前窗口剩余请求数
X-RateLimit-Limit-Tokens每分钟 Token 上限
X-RateLimit-Remaining-Tokens当前窗口剩余 Token 数

超出限制时返回 429 Too Many Requests。


聊天补全

POST /v1/chat/completions

OpenAI 兼容格式的聊天补全接口,支持流式(SSE)和非流式响应。

请求体:

参数类型必填说明
modelstring是模型 ID,如 kimi-for-coding
messagesarray是消息列表,每条消息含 role 和 content
streamboolean否是否流式返回,默认 false
max_tokensinteger否最大输出 Token 数
temperaturenumber否采样温度 0-2
top_pnumber否核采样参数 0-1
stopstring/array否停止序列
toolsarray否工具定义列表

响应(非流式):

json
{
  "id": "chatcmpl-xxx",
  "object": "chat.completion",
  "created": 1713801600,
  "model": "kimi-for-coding",
  "choices": [{
    "index": 0,
    "message": { "role": "assistant", "content": "你好!我是 MrKop AI 助手。" },
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 20,
    "total_tokens": 30
  }
}

流式响应(SSE):

text
data: {"id":"1","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"role":"assistant","content":""},"finish_reason":null}]}

data: {"id":"2","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"你好"},"finish_reason":null}]}

data: [DONE]

Anthropic Messages

POST /v1/messages

Anthropic Messages API 兼容端点。路径别名:/anthropic/v1/messages。

请求体:

参数类型必填说明
modelstring是模型 ID
messagesarray是Anthropic 格式消息列表
max_tokensinteger是最大输出 Token 数
streamboolean否是否流式返回
systemstring否系统提示词
temperaturenumber否采样温度
top_pnumber否核采样参数
top_kinteger否Top-K 采样
stop_sequencesarray否停止序列


嵌入

POST /v1/embeddings

获取文本的向量嵌入表示。

请求体:

json
{
  "model": "BAAI/bge-m3",
  "input": "需要嵌入的文本"
}

input 支持单个字符串或字符串数组。

响应:

json
{
  "object": "list",
  "data": [{
    "object": "embedding",
    "index": 0,
    "embedding": [0.012, -0.034, ...]
  }],
  "model": "BAAI/bge-m3",
  "usage": { "prompt_tokens": 5, "total_tokens": 5 }
}

重排序

POST /v1/rerank

对文档列表按与查询的相关性重新排序。

请求体:

json
{
  "model": "BAAI/bge-reranker-v2-m3",
  "query": "什么是机器学习",
  "documents": ["文档1内容...", "文档2内容...", "文档3内容..."],
  "top_n": 2
}

响应:

json
{
  "results": [
    { "index": 2, "relevance_score": 0.95 },
    { "index": 0, "relevance_score": 0.80 }
  ]
}

图像生成

POST /v1/images/generations

OpenAI 兼容的图像生成接口。

请求体:

json
{
  "model": "wan2.7-image",
  "prompt": "一只坐在草地上的柴犬",
  "n": 1,
  "size": "1024x1024"
}

响应:

json
{
  "data": [{ "url": "https://..." }]
}

视频生成

POST /v1/video/generations

OpenAI 兼容的视频生成接口。

请求体:

json
{
  "model": "Wan-AI/Wan2.2-T2V-A14B",
  "prompt": "海浪拍打礁石的慢动作",
  "size": "1280x720",
  "duration": 5
}

响应:

json
{
  "data": [{ "url": "https://..." }]
}

模型列表

GET /v1/models

获取当前可用模型列表。

bash
curl https://gw.mrkop.com/v1/models \
  -H "Authorization: Bearer $YOUR_API_KEY"

详细模型列表参见 模型说明。


健康检查

GET /health

综合健康检查,返回服务状态和 KeyPool 信息。

json
{
  "status": "ok",
  "available_keys": 4,
  "total_concurrency": 120,
  "cache_hit_rate": "75.7%"
}

GET /health/live

存活探针(Kubernetes Liveness Probe)。

GET /health/ready

就绪探针(Kubernetes Readiness Probe),检查 DB、Redis、KeyPool。


企业 API

企业 API 需要 JWT 认证 + 企业角色。详见 企业管理。

企业密钥管理

方法路径说明
GET/v1/enterprise/{id}/keys列出企业 API 密钥(脱敏)
POST/v1/enterprise/{id}/keys创建企业密钥(返回完整密钥仅一次)
GET/v1/enterprise/{id}/keys/{keyId}查看密钥详情
PUT/v1/enterprise/{id}/keys/{keyId}/toggle启用/禁用密钥
DELETE/v1/enterprise/{id}/keys/{keyId}删除密钥


MCP 集成

MrKop One API 支持 Model Context Protocol (MCP),允许通过标准化协议调用 AI 模型和企业管理工具。

可用端点

端点说明
GET /mcp/sseSSE 连接端点
POST /mcp/messagesMCP 消息端点
GET /mcp/tools列出可用工具
POST /mcp/tools/{name}调用指定工具

MCP 端点需要 JWT 认证。详细的配置和工具列表参见 MCP 集成指南。


错误码参考

HTTP 状态码错误类型说明
400invalid_request请求参数错误
401auth_errorAPI Key 无效或已过期
403access_denied无权限访问该资源
429rate_limit请求频率超限
429quota_exhaustedToken 配额已耗尽
500server_error服务器内部错误
503service_unavailable上游服务不可用

详细的错误码说明和排查指南参见 错误码参考。