Tổng quan API

URL Gốc

Môi trường	URL
Production	`https://api.openmodex.com/v1`
Sandbox	`https://api-sandbox.openmodex.com/v1`

Sử dụng môi trường Sandbox để phát triển và thử nghiệm — nó hoạt động giống hệt Production nhưng không tính phí. Tất cả các endpoint API đều tương thích với OpenAI. Nếu bạn đã sử dụng OpenAI API, bạn có thể chuyển đổi bằng cách thay đổi URL gốc và khóa API.

Xác Thực

Bao gồm khóa API của bạn trong header Authorization:

Authorization: Bearer omx_sk_YOUR_API_KEY

Các Endpoint

Phương thức	Endpoint	Mô tả
`POST`	`/chat/completions`	Tạo hoàn thành chat
`POST`	`/completions`	Tạo hoàn thành văn bản (cũ)
`POST`	`/embeddings`	Tạo embedding
`GET`	`/models`	Liệt kê các mô hình có sẵn
`GET`	`/models/:id`	Lấy thông tin mô hình
`GET`	`/models/compare`	So sánh các mô hình song song

Định Dạng Yêu Cầu

Tất cả yêu cầu POST chấp nhận body JSON với Content-Type: application/json.

Định Dạng Phản Hồi

Tất cả phản hồi trả về JSON. Phản hồi thành công bao gồm dữ liệu trực tiếp. Phản hồi lỗi tuân theo định dạng này:

{
  "error": {
    "message": "Human-readable error message",
    "type": "invalid_request_error",
    "code": "invalid_api_key"
  }
}

Mã Trạng Thái HTTP

Mã	Mô tả
`200`	Thành công
`400`	Yêu cầu không hợp lệ — kiểm tra tham số của bạn
`401`	Không được phép — khóa API không hợp lệ hoặc thiếu
`403`	Bị cấm — không đủ quyền hạn
`404`	Không tìm thấy — endpoint hoặc mô hình không hợp lệ
`429`	Giới hạn tốc độ — giảm tốc hoặc nâng cấp gói của bạn
`500`	Lỗi máy chủ — thử lại với thời gian chờ tăng dần
`502`	Lỗi cổng — lỗi nhà cung cấp upstream
`503`	Dịch vụ không khả dụng — gián đoạn tạm thời

Siêu Dữ Liệu Phản Hồi OpenModex

Mỗi phản hồi đều bao gồm trường openmodex tùy chọn với siêu dữ liệu về định tuyến và hiệu suất:

{
  "id": "chatcmpl-abc123",
  "choices": [...],
  "usage": {...},
  "openmodex": {
    "request_id": "req_abc123",
    "model_used": "gpt-4o-2024-08-06",
    "provider": "openai",
    "cache_hit": false,
    "routing_strategy": "cost_optimized",
    "fallback_used": false,
    "latency_ms": 1250
  }
}

Tính Idempotent

Đối với yêu cầu POST, bạn có thể truyền header Idempotency-Key để đảm bảo cùng một yêu cầu không bị xử lý hai lần:

curl https://api.openmodex.com/v1/chat/completions \
  -H "Authorization: Bearer omx_sk_..." \
  -H "Idempotency-Key: my-unique-key-123" \
  -H "Content-Type: application/json" \
  -d '...'

Khóa idempotent có hiệu lực trong 24 giờ.

Tổng quan

Trò chuyện

Hoàn thành

Nhúng

Mô hình

URL Gốc

Xác Thực

Các Endpoint

Định Dạng Yêu Cầu

Định Dạng Phản Hồi

Mã Trạng Thái HTTP

Siêu Dữ Liệu Phản Hồi OpenModex

Tính Idempotent

​URL Gốc

​Xác Thực

​Các Endpoint

​Định Dạng Yêu Cầu

​Định Dạng Phản Hồi

​Mã Trạng Thái HTTP

​Siêu Dữ Liệu Phản Hồi OpenModex

​Tính Idempotent

URL Gốc

Xác Thực

Các Endpoint

Định Dạng Yêu Cầu

Định Dạng Phản Hồi

Mã Trạng Thái HTTP

Siêu Dữ Liệu Phản Hồi OpenModex

Tính Idempotent