Appearance
文本生成
聊天、响应、消息、补全与向量接口。
所有路径相对于当前 API 站点域名。认证方式参见 认证与访问地址。
创建聊天对话
POST /v1/chat/completions
根据对话历史创建模型响应。支持流式和非流式响应。 兼容 OpenAI Chat Completions API。
分类: OpenAI格式(Chat)
请求体
请求类型:application/json(必填)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | 模型 ID |
messages | object[] | 是 | 对话消息列表 |
temperature | number | 否 | 采样温度 |
top_p | number | 否 | 核采样参数 |
n | integer | 否 | 生成数量 |
stream | boolean | 否 | 是否流式响应 |
stream_options | object | 否 | |
stop | string / string[] | 否 | 停止序列 |
max_tokens | integer | 否 | 最大生成 Token 数 |
max_completion_tokens | integer | 否 | 最大补全 Token 数 |
presence_penalty | number | 否 | |
frequency_penalty | number | 否 | |
logit_bias | object | 否 | |
user | string | 否 | |
tools | object[] | 否 | |
tool_choice | none / auto / required / object | 否 | |
response_format | object | 否 | |
seed | integer | 否 | |
reasoning_effort | low / medium / high | 否 | 推理强度 (用于支持推理的模型) |
modalities | text / audio[] | 否 | |
audio | object | 否 |
响应
| 状态码 | 说明 |
|---|---|
200 | 成功创建响应 |
400 | 请求参数错误 |
429 | 请求频率限制 |
创建响应 (OpenAI Responses API)
POST /v1/responses
OpenAI Responses API,用于创建模型响应。 支持多轮对话、工具调用、推理等功能。
分类: OpenAI格式(Responses)
请求体
请求类型:application/json(必填)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | |
input | string / object[] | 否 | 输入内容,可以是字符串或消息数组 |
instructions | string | 否 | |
max_output_tokens | integer | 否 | |
temperature | number | 否 | |
top_p | number | 否 | |
stream | boolean | 否 | |
tools | object[] | 否 | |
tool_choice | string / object | 否 | |
reasoning | object | 否 | |
previous_response_id | string | 否 | |
truncation | auto / disabled | 否 |
响应
| 状态码 | 说明 |
|---|---|
200 | 成功创建响应 |
压缩对话 (OpenAI Responses API)
POST /v1/responses/compact
OpenAI Responses API,用于对长对话进行 compaction。
分类: OpenAI格式(Responses)
请求体
请求类型:application/json(必填)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | |
input | string / object[] | 否 | 输入内容,可以是字符串或消息数组 |
instructions | string | 否 | |
previous_response_id | string | 否 |
响应
| 状态码 | 说明 |
|---|---|
200 | 成功压缩对话 |
Claude 聊天
POST /v1/messages
Anthropic Claude Messages API 格式的请求。 需要在请求头中包含 anthropic-version。
分类: Claude格式(Messages)
路径与查询参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
anthropic-version | header | string | 是 | Anthropic API 版本 |
x-api-key | header | string | 否 | Anthropic API Key (可选,也可使用 Bearer Token) |
请求体
请求类型:application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | |
messages | object[] | 是 | |
system | string / object[] | 否 | |
cache_control | object | 否 | |
inference_geo | string | 否 | |
max_tokens | integer | 是 | |
temperature | number | 否 | |
top_p | number | 否 | |
top_k | integer | 否 | |
stream | boolean | 否 | |
stop_sequences | string[] | 否 | |
tools | object[] | 否 | |
tool_choice | object | 否 | |
thinking | object | 否 | |
context_management | object | 否 | |
output_config | object | 否 | |
output_format | object | 否 | |
container | string / object | 否 | |
mcp_servers | object[] | 否 | |
metadata | object | 否 | |
speed | standard / fast | 否 | |
service_tier | auto / standard_only | 否 |
响应
| 状态码 | 说明 |
|---|---|
200 | 成功创建响应 |
Gemini 嵌入(Embeddings)
POST /v1/engines/{model}/embeddings
使用指定引擎/模型创建嵌入
分类: Gemini格式
路径与查询参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
model | path | string | 是 | 模型/引擎 ID |
请求体
请求类型:application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | |
input | string / string[] | 是 | 要嵌入的文本 |
encoding_format | float / base64 | 否 | |
dimensions | integer | 否 | 输出向量维度 |
响应
| 状态码 | 说明 |
|---|---|
200 | 成功创建嵌入 |
创建文本嵌入
POST /v1/embeddings
将文本转换为向量嵌入
分类: OpenAI格式(Embeddings)
请求体
请求类型:application/json(必填)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | |
input | string / string[] | 是 | 要嵌入的文本 |
encoding_format | float / base64 | 否 | |
dimensions | integer | 否 | 输出向量维度 |
响应
| 状态码 | 说明 |
|---|---|
200 | 成功创建嵌入 |
创建文本补全
POST /v1/completions
基于给定提示创建文本补全
分类: 文本补全(Completions)
请求体
请求类型:application/json(必填)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | |
prompt | string / string[] | 是 | |
max_tokens | integer | 否 | |
temperature | number | 否 | |
top_p | number | 否 | |
n | integer | 否 | |
stream | boolean | 否 | |
stop | string / string[] | 否 | |
suffix | string | 否 | |
echo | boolean | 否 |
响应
| 状态码 | 说明 |
|---|---|
200 | 成功创建响应 |