跳转到主要内容
POST
/
v1
/
chat
/
completions
curl -X POST https://api-llm.sunra.ai/v1/chat/completions \
  -H "Authorization: Bearer <SUNRA_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4o",
    "messages": [
      {
        "role": "system",
        "content": "You are a helpful assistant."
      },
      {
        "role": "user",
        "content": "What is the capital of France?"
      }
    ]
  }'

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "openai/gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "The capital of France is Paris."
      },
      "finish_reason": "stop",
      "logprobs": null
    }
  ],
  "system_fingerprint": "fp_44709d6fcb",
  "usage": {
    "prompt_tokens": 25,
    "completion_tokens": 8,
    "total_tokens": 33
  }
}
发送请求以获取给定聊天对话的模型响应。支持流式和非流式模式。兼容 OpenAI Chat Completions API 格式。

​
认证

​
Authorization
string
必填
Bearer 令牌。在 Authorization 请求头中使用您的 API 密钥作为 Bearer 令牌。格式：Bearer <SUNRA_KEY>

​
请求

此端点接受一个 JSON 对象。
​
messages
object[]
必填
对话的消息列表。
​
model
string
必填
用于补全的模型。在 sunra.ai/models 浏览可用模型。
​
stream
boolean
默认值:false
如果设置为 true，将以服务器发送事件（SSE）的方式发送部分消息增量。
​
max_tokens
integer
补全中生成的最大令牌数。输入令牌和生成令牌的总长度受模型上下文长度的限制。
​
temperature
number
默认值:1
采样温度，介于 0 到 2 之间。较高的值（如 0.8）使输出更随机，较低的值（如 0.2）使其更集中和确定性。
​
top_p
number
默认值:1
核采样参数（0-1）。温度采样的替代方案，模型会考虑具有 top_p 概率质量的令牌。
​
frequency_penalty
number
默认值:0
介于 -2.0 和 2.0 之间的数字。正值会根据新令牌在文本中的现有频率进行惩罚，降低模型逐字重复相同内容的可能性。
​
presence_penalty
number
默认值:0
介于 -2.0 和 2.0 之间的数字。正值会根据新令牌是否出现在文本中进行惩罚，增加模型谈论新话题的可能性。
​
stop
string | string[]
最多 4 个序列，API 将在这些序列处停止生成更多令牌。
​
n
integer
默认值:1
为每条输入消息生成多少个聊天补全选择。
​
logprobs
boolean
默认值:false
是否返回输出令牌的对数概率。如果为 true，则返回消息内容中每个输出令牌的对数概率。
​
top_logprobs
integer
一个介于 0 到 20 之间的整数，指定在每个令牌位置返回最可能的令牌数量。使用此参数时，logprobs 必须设置为 true。
​
response_format
object
指定模型必须输出的格式的对象。
​
seed
integer
如果指定，系统将尽最大努力进行确定性采样，使得具有相同种子和参数的重复请求应返回相同的结果。
​
tools
object[]
模型可以调用的工具列表。目前仅支持函数作为工具。
​
tool_choice
string | object
控制模型调用哪个（如果有的话）工具。none 表示模型不会调用任何工具。auto 表示模型可以在生成消息或调用工具之间选择。required 表示模型必须调用一个或多个工具。也可以通过 {"type": "function", "function": {"name": "my_function"}} 指定特定函数。
​
parallel_tool_calls
boolean
默认值:true
是否在工具使用期间启用并行函数调用。
​
user
string
代表您的最终用户的唯一标识符，可帮助监控和检测滥用行为。

​
响应

成功的聊天补全响应。
​
id
string
聊天补全的唯一标识符。
​
object
string
对象类型。始终为 chat.completion。
​
created
integer
聊天补全创建时的 Unix 时间戳（秒）。
​
model
string
用于聊天补全的模型。
​
choices
object[]
聊天补全选择列表。如果 n 大于 1，则可以有多个选择。
​
usage
object
补全请求的使用统计。
​
system_fingerprint
string | null
此指纹表示模型运行的后端配置。可与 seed 参数一起使用，以了解后端何时发生了更改。
curl -X POST https://api-llm.sunra.ai/v1/chat/completions \
  -H "Authorization: Bearer <SUNRA_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4o",
    "messages": [
      {
        "role": "system",
        "content": "You are a helpful assistant."
      },
      {
        "role": "user",
        "content": "What is the capital of France?"
      }
    ]
  }'

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "openai/gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "The capital of France is Paris."
      },
      "finish_reason": "stop",
      "logprobs": null
    }
  ],
  "system_fingerprint": "fp_44709d6fcb",
  "usage": {
    "prompt_tokens": 25,
    "completion_tokens": 8,
    "total_tokens": 33
  }
}