数据结构参考

以下请求 / 响应数据结构由 newapi 的 OpenAPIOpenAPI描述 REST API 的开放规范（原 Swagger）。Lurus 的数据结构由网关 OpenAPI 规范自动同步生成。OpenAPI Specification了解更多 → 规范（relay.json）自动同步生成，始终与网关实现保持一致。完整端点列表见 API 概述，调用示例见 Chat Completions。

如何更新

本页 <!-- sync:schemas --> 标记区由 bun run sync 从 2b-svc-newapi/docs/openapi/relay.json 重新生成，请勿手动编辑该区域。

共 35 个数据结构（由 OpenAPI 规范自动生成）。

AudioTranscriptionResponse

字段	类型	必填	说明
text	string	—

ChatCompletionRequest

字段	类型	必填	说明
model	string	是	模型 ID
messages	array<Message>	是	对话消息列表
temperature	number	—	采样温度
top_p	number	—	核采样参数
n	integer	—	生成数量
stream	boolean	—	是否流式响应
stream_options	object	—
stop	string | array<string>	—	停止序列
max_tokens	integer	—	最大生成 Token 数
max_completion_tokens	integer	—	最大补全 Token 数
presence_penalty	number	—
frequency_penalty	number	—
logit_bias	object	—
user	string	—
tools	array<Tool>	—
tool_choice	string (none / auto / required) | object	—
response_format	ResponseFormat	—
seed	integer	—
reasoning_effort	string (low / medium / high)	—	推理强度 (用于支持推理的模型)
modalities	array<string (text / audio)>	—
audio	object	—

ChatCompletionResponse

字段	类型	必填	说明
id	string	—
object	string	—
created	integer	—
model	string	—
choices	array<object>	—
usage	Usage	—
system_fingerprint	string	—

ClaudeMessage

字段	类型	必填	说明
role	string (user / assistant)	是
content	string | array<object>	是

ClaudeRequest

字段	类型	必填	说明
model	string	是
messages	array<ClaudeMessage>	是
system	string | array<object>	—
cache_control	object	—
inference_geo	string	—
max_tokens	integer	是
temperature	number	—
top_p	number	—
top_k	integer	—
stream	boolean	—
stop_sequences	array<string>	—
tools	array<object>	—
tool_choice	object	—
thinking	object	—
context_management	object	—
output_config	object	—
output_format	object	—
container	string | object	—
mcp_servers	array<object>	—
metadata	object	—
speed	string (standard / fast)	—
service_tier	string (auto / standard_only)	—

ClaudeResponse

字段	类型	必填	说明
id	string	—
type	string	—
role	string	—
content	array<object>	—
model	string	—
stop_reason	string (end_turn / max_tokens / stop_sequence / tool_use)	—
usage	object	—

CompletionRequest

字段	类型	必填	说明
model	string	是
prompt	string | array<string>	是
max_tokens	integer	—
temperature	number	—
top_p	number	—
n	integer	—
stream	boolean	—
stop	string | array<string>	—
suffix	string	—
echo	boolean	—

CompletionResponse

字段	类型	必填	说明
id	string	—
object	string	—
created	integer	—
model	string	—
choices	array<object>	—
usage	Usage	—

EmbeddingRequest

字段	类型	必填	说明
model	string	是
input	string | array<string>	是	要嵌入的文本
encoding_format	string (float / base64)	—
dimensions	integer	—	输出向量维度

EmbeddingResponse

字段	类型	必填	说明
object	string	—
data	array<object>	—
model	string	—
usage	object	—

GeminiModelsResponse

字段	类型	必填	说明
models	array<object>	—

GeminiResponse

字段	类型	必填	说明
candidates	array<object>	—
usageMetadata	object	—

ImageResponse

字段	类型	必填	说明
created	integer	—
data	array<object>	—

Message

字段	类型	必填	说明
role	string (system / user / assistant / tool / developer)	是	消息角色
content	string | array<MessageContent>	是	消息内容
name	string	—	发送者名称
tool_calls	array<ToolCall>	—
tool_call_id	string	—	工具调用 ID（用于 tool 角色消息）
reasoning_content	string	—	推理内容

MessageContent

字段	类型	必填	说明
type	string (text / image_url / input_audio / file / video_url)	—
text	string	—
image_url	object	—
input_audio	object	—
file	object	—
video_url	object	—

Model

字段	类型	必填	说明
id	string	—	模型 ID
object	string	—	对象类型
created	integer	—	创建时间戳
owned_by	string	—	模型所有者

ModelsResponse

字段	类型	必填	说明
object	string	—
data	array<Model>	—

ModerationRequest

字段	类型	必填	说明
input	string | array<string>	是
model	string	—

ModerationResponse

字段	类型	必填	说明
id	string	—
model	string	—
results	array<object>	—

RerankRequest

字段	类型	必填	说明
model	string	是
query	string	是	查询文本
documents	array<string | object>	是	要重排序的文档列表
top_n	integer	—	返回前 N 个结果
return_documents	boolean	—

RerankResponse

字段	类型	必填	说明
id	string	—
results	array<object>	—
meta	object	—

ResponseFormat

字段	类型	必填	说明
type	string (text / json_object / json_schema)	—
json_schema	object	—	JSON Schema 定义

ResponsesCompactionRequest

字段	类型	必填	说明
model	string	是
input	string | array<object>	—	输入内容，可以是字符串或消息数组
instructions	string	—
previous_response_id	string	—

ResponsesCompactionResponse

字段	类型	必填	说明
id	string	—
object	string	—
created_at	integer	—
output	array<object>	—
usage	Usage	—
error	object	—

ResponsesRequest

字段	类型	必填	说明
model	string	是
input	string | array<object>	—	输入内容，可以是字符串或消息数组
instructions	string	—
max_output_tokens	integer	—
temperature	number	—
top_p	number	—
stream	boolean	—
tools	array<object>	—
tool_choice	string | object	—
reasoning	object	—
previous_response_id	string	—
truncation	string (auto / disabled)	—

ResponsesResponse

字段	类型	必填	说明
id	string	—
object	string	—
created_at	integer	—
status	string (completed / failed / in_progress / incomplete)	—
model	string	—
output	array<object>	—
usage	Usage	—

SpeechRequest

字段	类型	必填	说明
model	string	是
input	string	是	要转换的文本
voice	string (alloy / echo / fable / onyx / nova / shimmer)	是
response_format	string (mp3 / opus / aac / flac / wav / pcm)	—
speed	number	—

Tool

字段	类型	必填	说明
type	string	—
function	object	—

ToolCall

字段	类型	必填	说明
id	string	—
type	string	—
function	object	—

Usage

字段	类型	必填	说明
prompt_tokens	integer	—	提示词 Token 数
completion_tokens	integer	—	补全 Token 数
total_tokens	integer	—	总 Token 数
prompt_tokens_details	object	—
completion_tokens_details	object	—

VideoRequest

视频生成请求

字段	类型	必填	说明
model	string	—	模型/风格 ID
prompt	string	—	文本描述提示词
image	string	—	图片输入 (URL 或 Base64)
duration	number	—	视频时长（秒）
width	integer	—	视频宽度
height	integer	—	视频高度
fps	integer	—	视频帧率
seed	integer	—	随机种子
n	integer	—	生成视频数量
response_format	string	—	响应格式
user	string	—	用户标识
metadata	object	—	扩展参数 (如 negative_prompt, style, quality_level 等)

VideoResponse

视频生成任务提交响应

字段	类型	必填	说明
task_id	string	—	任务 ID
status	string	—	任务状态

VideoTaskError

视频任务错误信息

字段	类型	必填	说明
code	integer	—	错误码
message	string	—	错误信息

VideoTaskMetadata

视频任务元数据

字段	类型	必填	说明
duration	number	—	实际生成的视频时长
fps	integer	—	实际帧率
width	integer	—	实际宽度
height	integer	—	实际高度
seed	integer	—	使用的随机种子

VideoTaskResponse

视频任务状态查询响应

字段	类型	必填	说明
task_id	string	—	任务 ID
status	string (queued / in_progress / completed / failed)	—	任务状态
url	string	—	视频资源 URL（成功时）
format	string	—	视频格式
metadata	VideoTaskMetadata	—
error	VideoTaskError	—

下一步

API 概述Chat Completions集成与 MCP 目录错误处理