创建格式化输出
POST/v1/messages 创建格式化输出
通过 Vortap 的 Messages 接口发送提示词与对话消息,模型会根据请求内容生成回复。该接口兼容 OpenAI 风格的响应结构,可用于构建聊天、问答、内容生成以及需要格式化结果的应用场景。
接口地址
POST https://www.vortapapi.com/v1/messages
请求头
| 名称 | 必填 | 说明 |
|---|---|---|
Content-Type | 是 | 请求体格式,通常为 application/json |
Accept | 是 | 响应格式,通常为 application/json |
Authorization | 否 | API 认证信息,格式为 Bearer sk-*** |
anthropic-beta | 否 | 可选的 Beta 功能开关,用于启用特定实验能力 |
请求示例
curl https://www.vortapapi.com/v1/messages \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer sk-***" \
-d '{
"model": "your-model-name",
"messages": [
{
"role": "user",
"content": "请用 JSON 格式返回一条问候语。"
}
]
}'
响应示例
{
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652288,
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "\n\nHello there, how may I assist you today?"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 9,
"completion_tokens": 12,
"total_tokens": 21
}
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | 本次生成结果的唯一标识 |
object | string | 返回对象类型,例如 chat.completion |
created | integer | 响应创建时间,Unix 时间戳 |
choices | array | 模型生成的候选结果列表 |
choices[].index | integer | 当前候选结果的序号 |
choices[].message | object | 模型返回的消息内容 |
choices[].message.role | string | 消息角色,通常为 assistant |
choices[].message.content | string | 模型生成的文本内容 |
choices[].finish_reason | string | 生成结束原因,例如 stop |
usage | object | Token 使用统计 |
usage.prompt_tokens | integer | 输入内容消耗的 token 数 |
usage.completion_tokens | integer | 输出内容消耗的 token 数 |
usage.total_tokens | integer | 输入与输出合计消耗的 token 数 |