Codex SDK

Codex SDK dùng để tích hợp Codex vào ứng dụng, công cụ nội bộ hoặc quy trình tự động hóa của bạn. Sao chép Base URL, API Key và tên mô hình từ bảng điều khiển, rồi truyền các giá trị kết nối khi khởi tạo Codex.

Dùng Base URL, API Key và tên mô hình hiển thị trong bảng điều khiển. Không sao chép các giá trị này từ ảnh chụp màn hình, tài liệu cũ hoặc cấu hình của người khác.

Điều kiện cần có

Bạn đã hoàn tất Tạo tài khoản.
Bạn đã hoàn tất Lấy API Key.
Node.js 18 trở lên đã được cài đặt.
Codex CLI đã được cài đặt và codex --version hoạt động.
Bạn có một dự án TypeScript hoặc JavaScript.

API Key là thông tin nhạy cảm. Không đặt API Key trong mã frontend, không commit vào kho mã và không in ra log.

Trường hợp sử dụng

Codex SDK hữu ích khi bạn cần đưa Codex vào một quy trình kỹ thuật hiện có.

Trường hợp	Phù hợp để làm gì
Tự động hóa CI/CD	Kích hoạt kiểm tra mã, phân tích nguyên nhân gốc, đề xuất sửa lỗi hoặc báo cáo có cấu trúc trong pipeline.
Tự động review mã	Chạy tác vụ review trong GitHub Actions, GitLab CI/CD, Azure DevOps Pipelines hoặc Jenkins, rồi đăng kết quả thành comment trên mã.
Công cụ phát triển nội bộ	Thêm Codex vào nền tảng nội bộ để tạo kế hoạch migration, phân tích kho mã hoặc chẩn đoán lỗi build.
Trợ lý kỹ thuật trong ứng dụng	Khởi tạo thread Codex từ ứng dụng của bạn và để Codex xử lý tác vụ kỹ thuật nhiều bước.
Quy trình đầu ra có cấu trúc	Yêu cầu Codex trả về JSON schema, rồi gọi SCM, Slack, hệ thống ticket hoặc API nội bộ.

Nếu bạn chỉ muốn dùng 4096bytes trong terminal cục bộ, hãy bắt đầu với Codex CLI. Dùng SDK khi bạn cần điều khiển Codex bằng mã.

Cài đặt SDK

Cài Codex SDK trong dự án của bạn.

npm install @openai/codex-sdk

Codex SDK gọi Codex CLI cục bộ. Nếu Codex CLI chưa được cài đặt, hãy cài trước:

npm install -g @openai/codex

Sau khi cài đặt, kiểm tra lệnh:

codex --version

Nếu bạn dùng pnpm hoặc yarn, dùng lệnh tương ứng.

pnpm add @openai/codex-sdk

yarn add @openai/codex-sdk

Sao chép giá trị kết nối

Mở API Keys

Mở bảng điều khiển và vào API Keys.

Chọn API Key

Tìm API Key bạn muốn dùng với SDK, rồi bấm Use key.

Sao chép giá trị SDK

Sao chép Base URL, API Key và tên mô hình hiển thị trong bảng điều khiển. Thay mọi placeholder trong ví dụ bằng giá trị hiện tại trong bảng điều khiển.

Cấu hình biến môi trường

Lưu API Key, Base URL và tên mô hình trong biến môi trường phía máy chủ.

export CODEX_API_KEY="YOUR_4096BYTES_API_KEY"
export CODEX_BASE_URL="YOUR_BASE_URL"
export CODEX_MODEL="YOUR_MODEL_NAME"

Nếu môi trường của bạn dùng tệp .env, viết:

CODEX_API_KEY=YOUR_4096BYTES_API_KEY
CODEX_BASE_URL=YOUR_BASE_URL
CODEX_MODEL=YOUR_MODEL_NAME

Khởi tạo Codex

Tạo một phiên bản Codex trong mã phía máy chủ. Truyền apiKey và baseUrl vào constructor.

import { Codex } from "@openai/codex-sdk";

const apiKey = process.env.CODEX_API_KEY;
const baseUrl = process.env.CODEX_BASE_URL;
const model = process.env.CODEX_MODEL;

if (!apiKey || !baseUrl || !model) {
  throw new Error("Missing CODEX_API_KEY, CODEX_BASE_URL, or CODEX_MODEL");
}

const codex = new Codex({
  apiKey,
  baseUrl,
});

const thread = codex.startThread({
  model,
});

const result = await thread.run("Mô tả mục đích của dự án này trong một câu.");

console.log(result.finalResponse);

Đặt CODEX_API_KEY là API Key bạn đã tạo trong bảng điều khiển. Sao chép CODEX_BASE_URL và CODEX_MODEL từ bảng điều khiển.

Kiểm tra kết nối

Bắt đầu bằng một prompt chỉ đọc.

const result = await thread.run("Chỉ trả lời ok. Không sửa bất kỳ tệp nào.");

Khi phản hồi hoạt động, hãy kết nối SDK vào quy trình thật của bạn.

Ví dụ review mã

Cookbook chính thức của OpenAI trình bày một quy trình review mã tự động. Quy trình kích hoạt Codex trong CI/CD runner, để Codex đọc diff của PR, yêu cầu đầu ra JSON schema có cấu trúc, rồi gọi SCM API để đăng comment inline. Bạn có thể dùng mẫu này cho:

Review PR tự động.
Quy trình review cho repository on-premise hoặc SCM không phải GitHub.
Tạo ticket, gửi thông báo Slack hoặc cập nhật dashboard chất lượng nội bộ từ kết quả có cấu trúc.

Hãy bắt đầu bằng tác vụ review chỉ đọc. Khi đầu ra đã ổn định, hãy kết nối bước đăng comment, tạo ticket hoặc các hành động khác làm thay đổi trạng thái bên ngoài. Ví dụ chính thức: Build Code Review with the Codex SDK. Để xem thêm cách dùng SDK, hãy đọc tài liệu chính thức của OpenAI: Codex SDK.

Sự cố thường gặp

Nên dùng Base URL nào

Dùng Base URL hiện tại hiển thị trong bảng điều khiển. Không sao chép địa chỉ cố định từ tài liệu, ảnh chụp màn hình hoặc cấu hình cũ.

Nên dùng tên mô hình nào

Dùng tên mô hình hiển thị trong bảng điều khiển. Sao chép đầy đủ giá trị, bao gồm chữ hoa, chữ thường, dấu gạch nối và hậu tố phiên bản.

Có thể gọi từ frontend trình duyệt không

Không khuyến nghị. Mã frontend sẽ làm lộ API Key. Hãy gọi SDK từ mã phía máy chủ, job backend hoặc môi trường tự động hóa được kiểm soát.

Xác thực thất bại

Kiểm tra API Key đã được sao chép đầy đủ, tiến trình chạy có đọc được biến môi trường và Base URL thuộc cùng tài khoản hoặc môi trường trong bảng điều khiển.

Bắt đầu nhanh

Ứng dụng khách

SDK

Điều kiện cần có

Trường hợp sử dụng

Cài đặt SDK

Sao chép giá trị kết nối

Cấu hình biến môi trường

Khởi tạo Codex

Kiểm tra kết nối

Ví dụ review mã

Sự cố thường gặp

​Điều kiện cần có

​Trường hợp sử dụng

​Cài đặt SDK

​Sao chép giá trị kết nối

​Cấu hình biến môi trường

​Khởi tạo Codex

​Kiểm tra kết nối

​Ví dụ review mã

​Sự cố thường gặp

Điều kiện cần có

Trường hợp sử dụng

Cài đặt SDK

Sao chép giá trị kết nối

Cấu hình biến môi trường

Khởi tạo Codex

Kiểm tra kết nối

Ví dụ review mã

Sự cố thường gặp