Tài liệu API

Tích hợp qua một Base URL: chọn model, endpoint, gửi request và xử lý phản hồi streaming.

Một cổng API, nhiều model

Dùng Base URL bên dưới cho OpenAI SDK cùng API key tạo trong dashboard. Với Anthropic hoặc Gemini native, chọn đúng URL và header trong phần Model & Endpoint.

OpenAI-compatible APIREST APIStreaming (SSE)

URL cơ sở

https://your-domain.com/v1

Header xác thực

Authorization: Bearer YOUR_API_KEY

Gửi request đầu tiên

Tạo API key, chọn model và chạy ví dụ Chat Completions bên dưới.

1. Tạo API key

Tạo key trong mục Khóa API. Kiểm tra nhóm, số dư và giới hạn model của key trước khi sử dụng.

Tạo API key Nạp số dư

Bảo vệ API key

Không đưa API key lên GitHub hoặc vào mã chạy trên trình duyệt. Đọc key từ biến môi trường ở backend.

2. Chọn model cho ví dụ Chat Completions

Chọn một model OpenAI thế hệ mới cho request mẫu. Quyền truy cập thực tế phụ thuộc API key và kênh đang hoạt động.

Xem model và bảng giá →

Chọn model mới nhất

Bốn lựa chọn chính, sắp theo năng lực và chi phí. Chọn model để cập nhật ngay các request mẫu trên trang.

GPT-6 Astra, GPT-5.6 Sol, GPT-5.6 Terra và GPT-5.6 Luna hỗ trợ text/image input, text output và streaming. Gọi GET /v1/models bằng chính API key để xác nhận model khả dụng trên gateway.

Model & Endpoint

Chọn định dạng API để xem model tương thích và request mẫu. Một model có thể hỗ trợ nhiều endpoint; đổi endpoint sẽ thay cả URL, header và cấu trúc dữ liệu.

POST/v1/chat/completions

Dùng messages gồm role và content cho hội thoại nhiều lượt. Nội dung trả về nằm ở choices[0].message.content. Khi model hỗ trợ streaming, thêm stream: true và đọc các sự kiện SSE.

Model hỗ trợ endpoint này

Đang tải danh mục model…

Khả dụng thực tế còn phụ thuộc nhóm, quyền của API key và kênh đang hoạt động. Danh mục không xác nhận quyền truy cập của một API key cụ thể.

Xem model và bảng giá →

openai.sh

bash

curl 'https://your-domain.com/v1/chat/completions' \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $GATEWAY_API_KEY" \
  -d '{
  "model": "YOUR_MODEL_ID",
  "messages": [
    {
      "role": "user",
      "content": "Hello!"
    }
  ]
}'

Đặt GATEWAY_API_KEY trong biến môi trường phía server. Ví dụ dùng URL đầy đủ; với OpenAI SDK, Base URL kết thúc ở /v1. Không thêm /v1 hai lần hoặc dùng OpenAI SDK cho payload native Anthropic/Gemini.

Chat Completions

POST/v1/chat/completions

Đặt OPENAI_API_KEY trong biến môi trường, chọn ngôn ngữ và chạy request với model đã chọn.

chat-completions.sh

bash

curl https://your-domain.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "gpt-6-astra",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "Hello!"}
    ]
  }'

Phản hồi streaming (SSE)

Bật "stream": true để nhận từng phần phản hồi (delta) qua Server-Sent Events ngay khi model sinh dữ liệu.

stream-completions.sh

bash

curl -N https://your-domain.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "gpt-6-astra",
    "stream": true,
    "messages": [
      {"role": "user", "content": "Stream a short greeting."}
    ]
  }'

Embeddings

POST/v1/embeddings

Calculate embedding vectors for text inputs using standard compatible formats.

embeddings.sh

bash

curl https://your-domain.com/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "text-embedding-3-small",
    "input": "The quick brown fox"
  }'

Tạo hình ảnh

POST/v1/images/generations

Generate images from text descriptions using the DALL-E compatible endpoint.

image-generation.sh

bash

curl https://your-domain.com/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "gpt-image-2.5-sunburst",
    "prompt": "a cat reading a book, watercolor",
    "size": "1024x1024"
  }'

Submit standard JSON parameters including size, response format, and model fields to customize generation output.

Các lỗi thường gặp

Kiểm tra HTTP status và nội dung lỗi trả về. Định dạng lỗi có thể khác nhau giữa các endpoint và nhà cung cấp.

Trạng thái	Ý nghĩa	Cách xử lý
401	API key không hợp lệ	Kiểm tra header xác thực và trạng thái API key.
402	Không đủ số dư	Nạp số dư hoặc kiểm tra hạn mức của key.
404	Không tìm thấy mô hình	Kiểm tra model ID, đường dẫn endpoint và quyền truy cập của nhóm.
429	Vượt giới hạn request	Giảm tốc độ gửi request và thử lại với khoảng chờ tăng dần.
5xx	Lỗi nhà cung cấp	Nhà cung cấp gặp lỗi. Kiểm tra nội dung lỗi và thử lại có giới hạn với khoảng chờ tăng dần.

Tích hợp IDE & CLI

Chọn công cụ để xem hướng dẫn cấu hình từng bước với cổng API này.

Claude Code

Cấu hình Claude Code với cổng API.

Xem hướng dẫn

Codex CLI

Kết nối Codex CLI qua provider tương thích OpenAI.

Xem hướng dẫn

Opencode

Thiết lập Opencode với provider tương thích OpenAI.

Xem hướng dẫn

Tiếp tục khám phá

Playground

Thử model và tham số trực tiếp.

Tìm hiểu thêm

Khóa API

Tạo và quản lý API key.

Tìm hiểu thêm

Lịch sử gọi API

Theo dõi token và tra cứu lỗi request.

Tìm hiểu thêm

Bảng giá

So sánh giá và cách tính phí từng model.

Tìm hiểu thêm

curl 'https://your-domain.com/v1/chat/completions' \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $GATEWAY_API_KEY" \ -d '{ "model": "YOUR_MODEL_ID", "messages": [ { "role": "user", "content": "Hello!" } ] }'

curl https://your-domain.com/v1/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ "model": "gpt-6-astra", "messages": [ {"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "Hello!"} ] }'

curl -N https://your-domain.com/v1/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ "model": "gpt-6-astra", "stream": true, "messages": [ {"role": "user", "content": "Stream a short greeting."} ] }'

Trạng thái

Ý nghĩa

Cách xử lý

401

API key không hợp lệ

Kiểm tra header xác thực và trạng thái API key.

402

Không đủ số dư

Nạp số dư hoặc kiểm tra hạn mức của key.

404

Không tìm thấy mô hình

Kiểm tra model ID, đường dẫn endpoint và quyền truy cập của nhóm.

429

Vượt giới hạn request

Giảm tốc độ gửi request và thử lại với khoảng chờ tăng dần.

5xx

Lỗi nhà cung cấp

Nhà cung cấp gặp lỗi. Kiểm tra nội dung lỗi và thử lại có giới hạn với khoảng chờ tăng dần.