Tạo một Chat Completion

Tạo phản hồi của mô hình dựa trên lịch sử hội thoại. Hỗ trợ phản hồi streaming và không streaming. Tương thích với OpenAI Chat Completions API.

POST /v1/chat/completions

URL gốc của dịch vụ: https://getrouter.ai

Giao thức: OpenAI Chat Completions

Xác thực: Authorization: Bearer YOUR_API_KEY

Nội dung yêu cầu

Nội dung yêu cầu là bắt buộc. Loại nội dung: application/json

Trường yêu cầu

TrườngKiểuBắt buộcMô tả
modelstringmodel ID
messagesarray<object>Danh sách tin nhắn hội thoại
temperaturenumberKhôngNhiệt độ lấy mẫu Giá trị mặc định: 1; Khoảng giá trị: 0–2
top_pnumberKhôngTham số lấy mẫu hạt nhân Giá trị mặc định: 1; Khoảng giá trị: 0–1
nintegerKhôngSố lượng kết quả cần tạo Giá trị mặc định: 1; Khoảng giá trị: 1–∞
streambooleanKhôngCó streaming phản hồi hay không Giá trị mặc định: false
stream_optionsobjectKhông
stopstring or array<string>KhôngChuỗi dừng
max_tokensintegerKhôngSố token tối đa cần tạo
max_completion_tokensintegerKhôngSố token hoàn tất tối đa
presence_penaltynumberKhôngGiá trị mặc định: 0; Khoảng giá trị: -2–2
frequency_penaltynumberKhôngGiá trị mặc định: 0; Khoảng giá trị: -2–2
logit_biasobjectKhông
userstringKhông
toolsarray<object>Không
tool_choicestring or objectKhông
response_formatobjectKhông
seedintegerKhông
reasoning_effortstringKhôngMức độ suy luận (dùng cho các mô hình hỗ trợ suy luận) Giá trị cho phép: low, medium, high
modalitiesarray<string>Không
audioobjectKhông

Ví dụ yêu cầu

curl --request POST \
  --url https://getrouter.ai/v1/chat/completions \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "model": "MODEL_ID",
  "messages": [
    {
      "role": "system",
      "content": "Xin chào, hãy giới thiệu về bạn."
    }
  ],
  "stream": false,
  "temperature": 1,
  "max_tokens": 1
}'

Phản hồi

Trạng tháiMô tả
200Tạo phản hồi thành công
400Tham số yêu cầu không hợp lệ
429Đã vượt giới hạn tốc độ yêu cầu

Các trường của phản hồi thành công

TrườngKiểuBắt buộcMô tả
idstringKhông
objectstringKhông
createdintegerKhông
modelstringKhông
choicesarray<object>Không
usageobjectKhông
system_fingerprintstringKhông

Ví dụ phản hồi

{
  "id": "string",
  "object": "object",
  "created": 1,
  "model": "MODEL_ID",
  "choices": [
    {
      "index": 1,
      "message": {
        "role": "system",
        "content": "Xin chào, hãy giới thiệu về bạn.",
        "name": "string",
        "tool_calls": [
          {
            "id": null,
            "type": null,
            "function": null
          }
        ],
        "tool_call_id": "string",
        "reasoning_content": "string"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1,
    "prompt_tokens_details": {
      "cached_tokens": 1,
      "text_tokens": 1,
      "audio_tokens": 1,
      "image_tokens": 1
    },
    "completion_tokens_details": {
      "text_tokens": 1,
      "audio_tokens": 1,
      "reasoning_tokens": 1
    }
  },
  "system_fingerprint": "string"
}

Hướng dẫn liên quan

Để xem quy trình và ví dụ đầy đủ, hãy đọc hướng dẫn API Chat Completions.


Trang này được tạo từ đặc tả OpenAPI công khai của Relay. Xem đặc tả đầy đủ trong API Explorer.