Sử dụng Codex với CometAPI

Sử dụng hướng dẫn này để chạy Codex với CometAPI làm model provider. Tài liệu tham khảo chính thức:

Điều kiện tiên quyết

Yêu cầu	Chi tiết
OS	macOS, Linux, Windows PowerShell gốc, hoặc Windows với WSL
Git	Khuyến nghị 2.23+
Codex	Cài đặt ứng dụng Codex hoặc Codex CLI từ Khởi động nhanh Codex
CometAPI API key	Lấy một khóa từ bảng điều khiển CometAPI
Model ID	Sử dụng một model ID từ trang Models

Chọn cách thiết lập

Chúng tôi cung cấp hai tùy chọn để giúp bạn cấu hình Codex nhanh chóng.

Tùy chọn 1: Cấu hình Codex thủ công (khuyến nghị)

Chỉnh sửa trực tiếp tệp ~/.codex/config.toml ở cấp người dùng. Đây là cách đáng tin cậy nhất, đặc biệt với người dùng Windows và WSL.

Tùy chọn 2: Cấu hình bằng script

Chạy script thiết lập như một lối tắt. Script sẽ ghi cùng cấu hình provider và lưu CometAPI API key cho Codex.

Cấu hình Codex thủ công

Codex đọc các mặc định provider cá nhân từ tệp ~/.codex/config.toml ở cấp người dùng. Hãy cấu hình provider CometAPI tại đó, không phải trong tệp .codex/config.toml của dự án. Codex bỏ qua các thiết lập provider và provider-auth trong các tệp cấu hình dự án. Thiết lập được khuyến nghị sử dụng một provider có tên cometapi và xác thực dựa trên lệnh. Cách này giúp giữ CometAPI tách biệt với provider OpenAI tích hợp sẵn, không yêu cầu kế thừa biến môi trường từ shell, và không thay thế ~/.codex/auth.json.

macOS / Linux / WSL
Windows PowerShell

Lưu CometAPI API key của bạn vào một tệp key cục bộ:

mkdir -p "$HOME/.codex"
printf "%s\n" "$COMETAPI_KEY" > "$HOME/.codex/cometapi_key"
chmod 600 "$HOME/.codex/cometapi_key"

Thêm cấu hình này vào ~/.codex/config.toml:

model_provider = "cometapi"
model = "your-model-id"

[model_providers.cometapi]
name = "CometAPI"
base_url = "https://api.cometapi.com/v1"
wire_api = "responses"

[model_providers.cometapi.auth]
command = "sh"
args = ["-c", "cat \"$HOME/.codex/cometapi_key\""]

Lưu CometAPI API key của bạn vào thư mục home Codex trên Windows:

New-Item -ItemType Directory -Force "$HOME\.codex" | Out-Null
Set-Content -NoNewline -Path "$HOME\.codex\cometapi_key" -Value $env:COMETAPI_KEY

Thêm cấu hình này vào $HOME\.codex\config.toml:

model_provider = "cometapi"
model = "your-model-id"

[model_providers.cometapi]
name = "CometAPI"
base_url = "https://api.cometapi.com/v1"
wire_api = "responses"

[model_providers.cometapi.auth]
command = "powershell.exe"
args = [
  "-NoProfile",
  "-Command",
  "$p=Join-Path $HOME '.codex/cometapi_key'; (Get-Content -Raw $p).Trim()",
]

Codex gốc trên Windows sử dụng $HOME\.codex, thường là C:\Users\<user>\.codex. WSL sử dụng ~/.codex của bản phân phối Linux. Hãy chỉnh sửa thư mục tương ứng với môi trường nơi tác nhân Codex chạy.

Sử dụng xác thực bằng biến môi trường

Nếu bạn muốn giữ CometAPI API key trong một biến môi trường, hãy dùng env_key thay cho khối [model_providers.cometapi.auth]. Chỉ sử dụng cấu hình provider này khi COMETAPI_KEY có sẵn trong môi trường khởi chạy Codex:

model_provider = "cometapi"
model = "your-model-id"

[model_providers.cometapi]
name = "CometAPI"
base_url = "https://api.cometapi.com/v1"
wire_api = "responses"
env_key = "COMETAPI_KEY"

Không kết hợp env_key với [model_providers.cometapi.auth]. Codex chỉ hỗ trợ một phương thức xác thực cho mỗi provider tùy chỉnh.

Chạy script thiết lập

Script thiết lập là tùy chọn. Nó ghi cùng một cấu hình provider cometapi vào ~/.codex/config.toml, lưu trữ CometAPI API key của bạn trong ~/.codex/cometapi_key, tạo bản sao lưu trước khi thay đổi tệp, và xác minh cấu hình bằng codex exec khi Codex CLI khả dụng. Với macOS, Linux hoặc WSL, hãy chạy trình cài đặt tương tác:

sh -c "$(curl -fsSL https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.sh)"

Với thiết lập không tương tác, truyền API key một cách tường minh:

curl -fsSL https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.sh | sh -s -- --key "$COMETAPI_KEY"

Với PowerShell gốc trên Windows, hãy chạy trình cài đặt tương tác:

powershell -c "irm 'https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.ps1' | iex"

Với thiết lập Windows không tương tác, truyền API key một cách tường minh:

powershell -c "& ([scriptblock]::Create((irm 'https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.ps1'))) -Key $env:COMETAPI_KEY"

Theo mặc định, script không thay thế ~/.codex/auth.json và không xóa đăng nhập ChatGPT. Chỉ dùng --force-auth-json hoặc -ForceAuthJson nếu bạn muốn script quản lý đăng nhập Codex bằng API key thông qua auth.json.

Chọn hoặc thay đổi model ID

Sử dụng một model ID từ trang Models. Trong cấu hình thủ công, thay đổi giá trị model trong ~/.codex/config.toml. Với macOS, Linux hoặc WSL, truyền --model khi bạn chạy script thiết lập:

curl -fsSL https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.sh | sh -s -- --key "$COMETAPI_KEY" --model your-model-id

Với PowerShell gốc trên Windows, truyền -Model khi bạn chạy script thiết lập:

powershell -c "& ([scriptblock]::Create((irm 'https://raw.githubusercontent.com/cometapi-dev/integrations/main/codex/setup.ps1'))) -Key $env:COMETAPI_KEY -Model 'your-model-id'"

Script sử dụng CODEX_HOME khi nó được thiết lập. Nếu không, nó sẽ ghi vào ~/.codex của môi trường hiện tại.

Xác minh thiết lập

Để xác minh thiết lập bằng Codex CLI, hãy chạy lệnh chỉ đọc này từ bất kỳ dự án cục bộ nào:

codex exec --ephemeral --skip-git-repo-check --sandbox read-only --color never "Reply exactly with: COMETAPI_CODEX_OK"

Nếu Codex CLI không khả dụng trong PATH, hãy mở ứng dụng Codex và gửi một prompt ngắn từ một dự án cục bộ.

Khắc phục sự cố

Codex vẫn sử dụng provider OpenAI mặc định

Xác nhận rằng model_provider = "cometapi" có trong tệp ~/.codex/config.toml ở cấp người dùng.

API key đã thay đổi

Cập nhật ~/.codex/cometapi_key, hoặc chạy lại script thiết lập với giá trị $COMETAPI_KEY đã được cập nhật.

Script PowerShell bị lỗi trong quá trình kiểm tra trước khi chạy

Sử dụng các bước PowerShell gốc thủ công trên Windows, sau đó chạy lệnh xác minh.

Thiết lập shell qua pipe không yêu cầu API key

Sử dụng --key "$COMETAPI_KEY", đặt COMETAPI_KEY, hoặc chạy lệnh tương tác sh -c "$(curl ...)".

Kết nối bị hết thời gian chờ hoặc dùng sai base URL

Xác nhận rằng base_url là https://api.cometapi.com/v1 trong ~/.codex/config.toml.

Không tìm thấy model

Kiểm tra trang Models để xem các model ID khả dụng.

Thiết lập Windows ảnh hưởng đến sai môi trường

Chỉnh sửa $HOME\.codex cho chế độ Windows gốc, hoặc chỉnh sửa ~/.codex bên trong WSL cho chế độ agent WSL.

Đăng nhập ChatGPT đã thay đổi

Không sử dụng --force-auth-json hoặc -ForceAuthJson trừ khi bạn muốn chế độ đăng nhập bằng API-key.

Tổng quan

Tác nhân lập trình AI

Tác nhân AI

Ứng dụng chat AI

Dịch thuật và ngôn ngữ

Nền tảng tự động hóa

Quan sát và đánh giá

Framework AI

Điều kiện tiên quyết

Chọn cách thiết lập

Tùy chọn 1: Cấu hình Codex thủ công (khuyến nghị)

Tùy chọn 2: Cấu hình bằng script

Cấu hình Codex thủ công

Sử dụng xác thực bằng biến môi trường

Chạy script thiết lập

Chọn hoặc thay đổi model ID

Xác minh thiết lập

Khắc phục sự cố

​Điều kiện tiên quyết

​Chọn cách thiết lập

Tùy chọn 1: Cấu hình Codex thủ công (khuyến nghị)

Tùy chọn 2: Cấu hình bằng script

​Cấu hình Codex thủ công

​Sử dụng xác thực bằng biến môi trường

​Chạy script thiết lập

​Chọn hoặc thay đổi model ID

​Xác minh thiết lập

​Khắc phục sự cố

Điều kiện tiên quyết

Chọn cách thiết lập

Cấu hình Codex thủ công

Sử dụng xác thực bằng biến môi trường

Chạy script thiết lập

Chọn hoặc thay đổi model ID

Xác minh thiết lập

Khắc phục sự cố