Sử dụng API và Playground

Muốn thử ngay?

Trang Kiểm thử API nhận khóa, mô hình và nội dung của bạn, hiển thị cùng một lệnh gọi bằng curl, Python, Node.js, Go và Java — cả truyền theo luồng lẫn không — rồi gửi yêu cầu ngay trên trang.

Playground

Playground dùng để thử nghiệm nhanh và trải nghiệm mô hình AI trực tuyến: bạn nhập câu hỏi hoặc chỉ dẫn, trò chuyện với mô hình và xem kết quả sinh ra. Lối vào là «Playground» trên thanh điều hướng bên trái hoặc /playground.

1. Chọn nhóm và mô hình: ở góc dưới bên phải ô nhập, chọn nhóm mô hình khả dụng và mô hình cụ thể để xác nhận mô hình dùng cho cuộc trò chuyện này.
2. Đặt tham số yêu cầu: bấm nút cài đặt tham số, bật và điều chỉnh các tham số sinh nội dung như temperature, Top P, frequency penalty, presence penalty và số token tối đa theo nhu cầu.
3. Nhập nội dung trò chuyện: nhập câu hỏi, chỉ dẫn hoặc prompt vào ô nhập ở dưới cùng.
4. Gửi yêu cầu: sau khi xác nhận mô hình, tham số và nội dung, bấm nút «Gửi».
5. Xem kết quả trả lời: khi mô hình sinh xong, xem nội dung trả về trong khu vực hội thoại và tiếp tục nhập câu hỏi mới để trò chuyện nhiều lượt.

Địa chỉ API và xác thực

Địa chỉ tương thích OpenAI của cổng thường có dạng:

https://your-host/v1

Dùng khóa API làm Bearer Token:

Authorization: Bearer sk-your-api-key

Ví dụ với chat completion:

curl https://your-host/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-api-key" \
  -d '{"model":"gpt-4o-mini","messages":[{"role":"user","content":"Xin chào"}]}'

Ví dụ SDK

Python (OpenAI SDK)

from openai import OpenAI

client = OpenAI(
    api_key="sk-xxxxxxxx",
    base_url="https://your-host/v1",
)

response = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Xin chào"}],
)
print(response.choices[0].message.content)

Định dạng gốc của Claude

curl https://your-host/v1/messages \
  -H "x-api-key: sk-xxxxxxxx" \
  -H "anthropic-version: 2023-06-01" \
  -H "content-type: application/json" \
  -d '{"model": "claude-3-5-sonnet-20241022", "max_tokens": 1024, "messages": [{"role": "user", "content": "Hello"}]}'

Định dạng gốc của Gemini

curl "https://your-host/v1beta/models/gemini-1.5-pro:generateContent?key=sk-xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"contents": [{"parts": [{"text": "Hello"}]}]}'

Các endpoint được hỗ trợ

Hội thoại và văn bản

Endpoint	Đường dẫn	Mô tả
Chat completion	POST /v1/chat/completions	Endpoint tương thích OpenAI Chat Completions, yêu cầu model và messages, hỗ trợ phản hồi dạng luồng hoặc thông thường.
Chat Playground	POST /pg/chat/completions	Endpoint riêng cho Playground trên web, xác thực bằng phiên đăng nhập thay vì khóa API; cách tính phí giống hệt lượt gọi thông thường.
Text completion	POST /v1/completions	Endpoint hoàn thiện văn bản truyền thống, yêu cầu prompt và model.
Responses API	POST /v1/responses	Endpoint định dạng OpenAI Responses, hỗ trợ đầu vào, công cụ và sự kiện phản hồi.
Nén Responses	POST /v1/responses/compact	Nén ngữ cảnh của yêu cầu Responses.
Claude Messages	POST /v1/messages	Endpoint tương thích Anthropic Claude Messages, yêu cầu model và nội dung tin nhắn, chuyển đổi sang giao thức thượng nguồn khi cần.
Tìm kiếm web Codex	POST /v1/alpha/search	Endpoint định dạng tìm kiếm web riêng của Codex, chỉ một số mô hình hỗ trợ.
Hội thoại thời gian thực	GET /v1/realtime (WebSocket)	Endpoint giao tiếp hai chiều theo phong cách OpenAI Realtime; mô hình thường truyền qua tham số truy vấn, khóa API có thể truyền qua Bearer Token hoặc subprotocol của WebSocket.

Vector và sắp xếp

Endpoint	Đường dẫn	Mô tả
Embedding	POST /v1/embeddings	Chuyển văn bản hoặc mảng văn bản thành vector, yêu cầu input.
Endpoint embedding tương thích Gemini	POST /v1/engines/{model}/embeddings	Đường dẫn embedding theo phong cách Gemini cũ, xử lý theo tên mô hình trong URL.
Sắp xếp lại (rerank)	POST /v1/rerank	Sắp xếp documents ứng viên theo độ liên quan với query; nội dung truy vấn và danh sách tài liệu không được rỗng.
Kiểm duyệt nội dung	POST /v1/moderations	Thực hiện kiểm duyệt văn bản hoặc đầu vào khác; nếu không cung cấp mô hình, hệ thống dùng mô hình kiểm duyệt mặc định.

Hình ảnh và âm thanh

Endpoint	Đường dẫn	Mô tả
Tạo hình ảnh	POST /v1/images/generations	Tạo hình ảnh theo prompt; kích thước, chất lượng và số lượng khả dụng phụ thuộc vào mô hình bạn chọn.
Chỉnh sửa hình ảnh	POST /v1/images/edits	Chỉnh sửa hình ảnh dựa trên ảnh đầu vào và prompt, hỗ trợ JSON và multipart/form-data.
Endpoint chỉnh sửa cũ	POST /v1/edits	Đường dẫn tương thích được giữ lại, đi vào luồng relay hình ảnh; ứng dụng khách mới nên ưu tiên /v1/images/edits.
Chuyển giọng nói thành văn bản	POST /v1/audio/transcriptions	Chuyển âm thanh thành văn bản, chuyển tiếp tới kênh nhận dạng giọng nói tương ứng theo định dạng API âm thanh của OpenAI.
Dịch âm thanh	POST /v1/audio/translations	Nhận dạng nội dung âm thanh và trả về văn bản đã dịch.
Chuyển văn bản thành giọng nói	POST /v1/audio/speech	Chuyển văn bản đầu vào thành âm thanh.

Các endpoint sinh nội dung bất đồng bộ như video, nhạc được mô tả trong mục «Endpoint sinh nội dung bất đồng bộ và tác vụ» của Nhật ký và tác vụ bất đồng bộ.

Danh sách mô hình

Endpoint	Đường dẫn	Mô tả
Danh sách mô hình	GET /v1/models	Mặc định trả về danh sách mô hình định dạng OpenAI; khi dùng header Anthropic thì trả về định dạng Claude, khi dùng header x-goog-api-key hoặc tham số key thì trả về định dạng Gemini.
Chi tiết mô hình	GET /v1/models/{model}	Truy vấn thông tin một mô hình; nếu mô hình không tồn tại thì trả về đối tượng lỗi model_not_found.
Danh sách mô hình Gemini	GET /v1beta/models	Trả về danh sách mô hình khả dụng theo định dạng Gemini, với các trường models và nextPageToken.
Danh sách mô hình định dạng OpenAI	GET /v1beta/openai/models	Trả về danh sách mô hình theo định dạng OpenAI trong không gian tên tương thích Gemini.

Đường dẫn gốc của Gemini

Endpoint	Đường dẫn	Mô tả
Gọi mô hình gốc Gemini	POST /v1beta/models/{model}:{action}	Endpoint định dạng gốc Gemini, hỗ trợ generateContent, streamGenerateContent và các thao tác liên quan tới embedding.
Gọi mô hình tương thích Gemini	POST /v1/models/{model}:{action}	Tiếp nhận yêu cầu thao tác mô hình theo phong cách Gemini dưới tiền tố /v1, do relay Gemini phân tích và chuyển đổi.

Ghi chú

Không phải mô hình nào cũng hỗ trợ tất cả endpoint ở trên. Trước khi gọi, hãy kiểm tra trong Thư viện mô hình rằng mô hình đã bật và nhóm của bạn dùng được, đồng thời xem các khả năng được ghi kèm (thị giác, gọi hàm, truyền luồng…).