NewAPI Chat 接口字段

协议身份

插件 ID：newapi-chat。
Provider ID：newapi-chat。
能力：text。
默认 Base URL：http://127.0.0.1:3000。
鉴权驱动：bearer。
创建：POST /v1/chat/completions。
Agent：POST /v1/chat/completions。
生命周期：同步响应。

配置字段

字段	类型	必填	含义
`apiKey`	secret	是	API Key

统一字段映射

统一字段	类型	必填	上游映射	说明
`model`	string	是	`model`	上游模型 ID。
`messages`	message[]	是	`provider message container`	包含历史消息和当前用户输入。
`instructions`	string	否	`system/instructions`	系统指令。
`temperature`	number	否	`temperature`	采样温度。
`top_p`	number	否	`top_p`	核采样参数。
`max_tokens`	integer	否	`max_tokens/max_output_tokens`	最大输出 token。
`tools`	array	否	`tools/toolConfig`	工具定义。
`tool_choice`	object	string	否	`tool_choice`
`response_format`	object	否	`response_format/text`	结构化输出配置。
`stream`	boolean	否	`stream`	流式开关；后台任务当前以最终响应归一。

上游请求模板逐字段清单

下表由插件请求模板生成，覆盖 body、query、headers 和 multipart 文件声明中的每个字段。

上游位置	值或转换表达式
`create.method`	`"POST"`
`create.path`	`"/v1/chat/completions"`
`create.contentType`	`"application/json"`
`create.body.model`	`{"$ref":"request.model"}`
`create.body.messages`	`{"$ref":"request.messages"}`
`create.body.temperature`	`{"$omitEmpty":{"$ref":"request.providerOptions.newapi-chat.temperature"}}`
`create.body.top_p`	`{"$omitEmpty":{"$ref":"request.providerOptions.newapi-chat.top_p"}}`
`create.body.max_tokens`	`{"$omitEmpty":{"$coalesce":[{"$ref":"request.extra.max_tokens"},{"$ref":"request.providerOptions.newapi-chat.max_tokens"}]}}`
`create.body.tools`	`{"$omitEmpty":{"$ref":"request.providerOptions.newapi-chat.tools"}}`
`create.body.tool_choice`	`{"$omitEmpty":{"$ref":"request.providerOptions.newapi-chat.tool_choice"}}`
`create.body.response_format`	`{"$omitEmpty":{"$ref":"request.providerOptions.newapi-chat.response_format"}}`
`create.body.stream`	`{"$omitEmpty":{"$ref":"request.providerOptions.newapi-chat.stream"}}`
`create.body.provider`	`{"$omitEmpty":{"$ref":"request.providerOptions.newapi-chat.provider"}}`
`create.body.transforms`	`{"$omitEmpty":{"$ref":"request.providerOptions.newapi-chat.transforms"}}`
`create.body.extra_body`	`{"$omitEmpty":{"$ref":"request.providerOptions.newapi-chat.extra_body"}}`
`agent.method`	`"POST"`
`agent.path`	`"/v1/chat/completions"`
`agent.contentType`	`"application/json"`
`agent.body`	`{"$merge":[{"$ref":"request.extra.agent.chatCompletion"},{"model":{"$ref":"request.model"}}]}`

Provider 扩展键

providerOptions.newapi-chat.extra_body
providerOptions.newapi-chat.max_tokens
providerOptions.newapi-chat.provider
providerOptions.newapi-chat.response_format
providerOptions.newapi-chat.stream
providerOptions.newapi-chat.temperature
providerOptions.newapi-chat.tool_choice
providerOptions.newapi-chat.tools
providerOptions.newapi-chat.top_p
providerOptions.newapi-chat.transforms

动态模型或工作流允许使用文档声明的完整 parameters/input/extra_body 对象；该对象是协议本身的开放 schema，不会被宿主裁剪。

响应映射逐字段清单

映射位置	上游路径或转换表达式
`response.status`	`"succeeded"`
`response.textPaths[0]`	`"choices.0.message.content"`
`response.textPaths[1]`	`"choices.0.text"`
`response.reasoningPaths[0]`	`"choices.0.message.reasoning_content"`
`response.usage`	`{"$ref":"response.usage"}`
`response.errorPaths[0]`	`"error.code"`
`response.messagePaths[0]`	`"error.message"`
`agentResponse.textPaths[0]`	`"choices.0.message.content"`
`agentResponse.textPaths[1]`	`"choices.0.text"`
`agentResponse.reasoningPaths[0]`	`"choices.0.message.reasoning_content"`
`agentResponse.toolCallsPath`	`"choices.0.message.tool_calls"`
`agentResponse.toolCallIdPaths[0]`	`"id"`
`agentResponse.toolCallNamePaths[0]`	`"function.name"`
`agentResponse.toolCallArgumentsPaths[0]`	`"function.arguments"`

响应与错误

插件把上游 task/status/text/media/usage 映射为统一结果。临时媒体 URL 标记为 ephemeral，由宿主立即下载持久化。HTTP 错误、业务 code 和 error object 保持失败语义，不包装成成功。

兼容边界

该插件实现该平台公开的 OpenAI Chat Completions 线协议 profile；平台专有字段通过 providerOptions 命名空间透传，未声明支持的 OpenAI 字段仍由模型 capability profile 校验。

Manifest 完整接口定义

以下 JSON 与插件包内实际 manifest.json 逐字段一致，覆盖插件身份、权限、配置、鉴权、参数、校验、创建、Agent、查询、取消、结果下载、响应和 Agent 响应映射。documentation 字段的值就是当前完整文档；为避免文档在自身内部无限递归，JSON 中仅用等义占位文本表示正文。

{
  "apiVersion": "yingce.plugin/v2",
  "id": "newapi-chat",
  "name": "NewAPI Chat",
  "version": "2.0.0",
  "author": "NewAPI / 影策",
  "description": "NewAPI Chat 独立请求协议插件。",
  "documentation": "<当前插件的完整 documentation，由 README.md 与 docs/interface.md 拼接而成；为避免 JSON 递归，此处不重复展开正文。>",
  "permissions": [
    "generation.run",
    "media.read"
  ],
  "configuration": {
    "fields": [
      {
        "name": "apiKey",
        "type": "secret",
        "label": "API Key",
        "required": true
      }
    ]
  },
  "contributes": {
    "providers": [
      {
        "id": "newapi-chat",
        "label": "NewAPI Chat",
        "capabilities": [
          "text"
        ],
        "scopes": [
          "admin.system-channel",
          "user.custom-channel",
          "canvas",
          "creation",
          "agent"
        ],
        "baseUrl": "http://127.0.0.1:3000",
        "requiresPublicMediaUrls": false,
        "auth": {
          "type": "bearer",
          "field": "apiKey"
        },
        "parameters": [
          {
            "name": "model",
            "type": "string",
            "required": true,
            "mapping": "model",
            "description": "上游模型 ID。"
          },
          {
            "name": "messages",
            "type": "message[]",
            "required": true,
            "mapping": "provider message container",
            "description": "包含历史消息和当前用户输入。"
          },
          {
            "name": "instructions",
            "type": "string",
            "required": false,
            "mapping": "system/instructions",
            "description": "系统指令。"
          },
          {
            "name": "temperature",
            "type": "number",
            "required": false,
            "mapping": "temperature",
            "description": "采样温度。"
          },
          {
            "name": "top_p",
            "type": "number",
            "required": false,
            "mapping": "top_p",
            "description": "核采样参数。"
          },
          {
            "name": "max_tokens",
            "type": "integer",
            "required": false,
            "mapping": "max_tokens/max_output_tokens",
            "description": "最大输出 token。"
          },
          {
            "name": "tools",
            "type": "array",
            "required": false,
            "mapping": "tools/toolConfig",
            "description": "工具定义。"
          },
          {
            "name": "tool_choice",
            "type": "object|string",
            "required": false,
            "mapping": "tool_choice",
            "description": "工具选择策略。"
          },
          {
            "name": "response_format",
            "type": "object",
            "required": false,
            "mapping": "response_format/text",
            "description": "结构化输出配置。"
          },
          {
            "name": "stream",
            "type": "boolean",
            "required": false,
            "mapping": "stream",
            "description": "流式开关；后台任务当前以最终响应归一。"
          }
        ],
        "create": {
          "method": "POST",
          "path": "/v1/chat/completions",
          "contentType": "application/json",
          "body": {
            "model": {
              "$ref": "request.model"
            },
            "messages": {
              "$ref": "request.messages"
            },
            "temperature": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.newapi-chat.temperature"
              }
            },
            "top_p": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.newapi-chat.top_p"
              }
            },
            "max_tokens": {
              "$omitEmpty": {
                "$coalesce": [
                  {
                    "$ref": "request.extra.max_tokens"
                  },
                  {
                    "$ref": "request.providerOptions.newapi-chat.max_tokens"
                  }
                ]
              }
            },
            "tools": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.newapi-chat.tools"
              }
            },
            "tool_choice": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.newapi-chat.tool_choice"
              }
            },
            "response_format": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.newapi-chat.response_format"
              }
            },
            "stream": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.newapi-chat.stream"
              }
            },
            "provider": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.newapi-chat.provider"
              }
            },
            "transforms": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.newapi-chat.transforms"
              }
            },
            "extra_body": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.newapi-chat.extra_body"
              }
            }
          }
        },
        "agent": {
          "method": "POST",
          "path": "/v1/chat/completions",
          "contentType": "application/json",
          "body": {
            "$merge": [
              {
                "$ref": "request.extra.agent.chatCompletion"
              },
              {
                "model": {
                  "$ref": "request.model"
                }
              }
            ]
          }
        },
        "response": {
          "status": "succeeded",
          "textPaths": [
            "choices.0.message.content",
            "choices.0.text"
          ],
          "reasoningPaths": [
            "choices.0.message.reasoning_content"
          ],
          "usage": {
            "$ref": "response.usage"
          },
          "errorPaths": [
            "error.code"
          ],
          "messagePaths": [
            "error.message"
          ]
        },
        "agentResponse": {
          "textPaths": [
            "choices.0.message.content",
            "choices.0.text"
          ],
          "reasoningPaths": [
            "choices.0.message.reasoning_content"
          ],
          "toolCallsPath": "choices.0.message.tool_calls",
          "toolCallIdPaths": [
            "id"
          ],
          "toolCallNamePaths": [
            "function.name"
          ],
          "toolCallArgumentsPaths": [
            "function.arguments"
          ]
        }
      }
    ]
  }
}

12 KiB Raw Permalink Blame History Unescape Escape