API 目录

聊天+读取文件接口 [Chat 兼容格式]

POST
/v1/chat/completions

聊天与文件读取接口(Chat 兼容格式)

POST https://www.vortapapi.com/v1/chat/completions

该接口使用 Chat Completions 兼容格式提交对话请求。你可以在消息中提供文本提示,也可以结合支持的文件内容输入,让模型基于上下文生成回复。

功能说明

向指定模型发送对话消息后,Vortap 会返回一个或多个候选回复。响应中包含生成内容、结束原因以及 token 用量统计等信息。

请求头

名称必填说明
Content-Type请求体格式,通常为 application/json
Accept期望的响应格式,通常为 application/json
AuthorizationAPI Key 鉴权信息,格式为 Bearer sk-***

请求示例

curl https://www.vortapapi.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer sk-***" \
  -d '{
    "model": "your-model-name",
    "messages": [
      {
        "role": "user",
        "content": "请帮我总结这份文件的主要内容。"
      }
    ]
  }'

响应示例

{
  "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
  }
}

响应字段说明

字段类型说明
idstring本次补全请求的唯一标识
objectstring对象类型,通常为 chat.completion
createdinteger响应创建时间,Unix 时间戳格式
choicesarray模型返回的候选结果列表
choices[].indexinteger当前候选结果在列表中的序号
choices[].messageobject模型生成的消息内容
choices[].message.rolestring消息角色,通常为 assistant
choices[].message.contentstring模型生成的文本内容
choices[].finish_reasonstring生成结束原因,例如 stop
usageobjecttoken 使用情况
usage.prompt_tokensinteger输入内容消耗的 token 数
usage.completion_tokensinteger输出内容消耗的 token 数
usage.total_tokensinteger输入与输出合计消耗的 token 数