Made for Agent
语言: 简体中文

接口总表

4.1 接口总表

合规的服务必须实现标记为“必需”的每个接口，可以实现可选接口，并通过其服务描述中的能力标志声明。

方法 路径 必需性 用途
GET /.well-known/lmsp.json 必需 服务与能力发现
GET /lmsp/v1/openapi.json 必需 机器可读的接口规范
GET /lmsp/v1/health 必需 存活与就绪检查
POST /lmsp/v1/pair 必需 用配对码换取 Bearer Token
GET /lmsp/v1/models 必需 获取本地模型列表
GET /lmsp/v1/models/{model_id} 必需 获取单个模型详情
POST /lmsp/v1/responses 必需 同步或流式生成
GET /lmsp/v1/responses/{response_id} 可选 查询已保存的响应
POST /lmsp/v1/tasks 必需 创建异步生成任务
GET /lmsp/v1/tasks/{task_id} 必需 查询异步任务
POST /lmsp/v1/tasks/{task_id}/cancel 必需 取消异步任务
GET /lmsp/v1/tasks/{task_id}/events 可选 订阅或恢复事件流
POST /lmsp/v1/models/{model_id}/load 可选 预加载模型
POST /lmsp/v1/models/{model_id}/unload 可选 卸载模型

/v1 下兼容 OpenAI 的接口，以及可选的兼容 Ollama 的接口，列在第 8 章。

4.2 约定

  • 请求体。 请求体和响应体均为 JSON（application/json），事件流（text/event-stream）和错误（application/problem+json）除外。
  • 路径参数。 花括号中的名称（如 {model_id}）是占位符。取值必须经过百分号编码。形如 qwen3:14b-q4_k_m 的模型 id 要写成 qwen3%3A14b-q4_k_m。
  • 认证。 除 /.well-known/lmsp.json、/lmsp/v1/openapi.json、/lmsp/v1/health 和 /lmsp/v1/pair 之外，每个接口都要求 Authorization: Bearer <token>。
  • 可选接口。 服务未实现的可选接口必须返回 501 Not Implemented，错误码为 unsupported_capability。
  • 版本与错误。 请求可以携带版本请求头，所有错误使用统一的格式，两者均在第 9 章中定义。
  • 契约。 发布在 /lmsp/1.0/openapi.json 的 OpenAPI 文档是本章的机器可读形式。两者如有差异，以文本为准。