> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ominiapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ChatCompletions格式

# 聊天 (Chat) - ChatCompletions 格式 (原生 OpenAI)

根据对话历史创建模型响应。支持流式和非流式响应。完全兼容 OpenAI Chat Completions API。

* **接口地址**: `POST /v1/chat/completions`
* **基础 URL (示例)**: `https://www.ominiapi.com`

## 认证与请求头 (Headers)

* `Authorization` (**必选**): 使用 Bearer Token 认证。格式: `Bearer sk-xxxxxx`
* `Content-Type`: `application/json`

## 请求参数 (Request Body)

| 参数名                     | 类型            | 必选    | 说明                                          |
| :---------------------- | :------------ | :---- | :------------------------------------------ |
| `model`                 | String        | **是** | 模型 ID，如 `gpt-4` 等                           |
| `messages`              | ArrayObject   | **是** | 对话消息列表，包含 `role` 和 `content` 等              |
| `temperature`           | Number        | 否     | 采样温度，默认 `1`，范围 `0 <= value <= 2`            |
| `top_p`                 | Number        | 否     | 核采样参数，默认 `1`，范围 `0 <= value <= 1`           |
| `n`                     | Integer       | 否     | 生成响应的数量，默认 `1`，必须 `>= 1`                    |
| `stream`                | Boolean       | 否     | 是否启用流式响应，默认 `false`                         |
| `stream_options`        | Object        | 否     | 流式响应的额外选项配置                                 |
| `stop`                  | String/Array  | 否     | 触发停止生成的字符或序列                                |
| `max_tokens`            | Integer       | 否     | 最大生成 Token 数                                |
| `max_completion_tokens` | Integer       | 否     | 最大补全 Token 数                                |
| `presence_penalty`      | Number        | 否     | 存在惩罚，默认 `0`，范围 `-2 <= value <= 2`           |
| `frequency_penalty`     | Number        | 否     | 频率惩罚，默认 `0`，范围 `-2 <= value <= 2`           |
| `logit_bias`            | Object        | 否     | 调整特定 Token 生成概率的偏置参数                        |
| `user`                  | String        | 否     | 终端用户的唯一标识符                                  |
| `tools`                 | ArrayObject   | 否     | 模型可调用的工具（函数）列表                              |
| `tool_choice`           | String/Object | 否     | 控制工具的选择模式                                   |
| `response_format`       | Object        | 否     | 指定响应格式（如 JSON 对象）                           |
| `seed`                  | Integer       | 否     | 随机种子，用于实现确定性输出                              |
| `reasoning_effort`      | String        | 否     | 推理强度（用于支持推理的模型），可选: `low`, `medium`, `high` |
| `modalities`            | ArrayString   | 否     | 模态设置                                        |
| `audio`                 | Object        | 否     | 音频输入/输出相关配置                                 |

## 示例代码 (cURL)

```javascript theme={null}
curl -X POST "[https://www.ominiapi.com/v1/chat/completions](https://www.ominiapi.com/v1/chat/completions)" \
  -H "Authorization: Bearer <您的_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4",
    "messages": [
      {
        "role": "system",
        "content": "你是我的得力助手。"
      },
      {
        "role": "user",
        "content": "你好！"
      }
    ]
  }'
```

## 响应体结构 (Response - 200 OK)

成功请求返回 JSON 格式结果。

```bash theme={null}
{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "gpt-4-0613",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好！有什么我可以帮你的吗？",
        "name": "string",
        "tool_calls": [
          {
            "id": "string",
            "type": "function",
            "function": {
              "name": "string",
              "arguments": "string"
            }
          }
        ],
        "tool_call_id": "string",
        "reasoning_content": "string"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "text_tokens": 9,
      "audio_tokens": 0,
      "image_tokens": 0
    },
    "completion_tokens_details": {
      "text_tokens": 12,
      "audio_tokens": 0,
      "reasoning_tokens": 0
    }
  },
  "system_fingerprint": "string"
}
```