ベースURLと認証
当社のAPIは標準的なOpenAI chat-completionsインターフェースに従っています。統合するには、クライアント設定を更新して、当社の固有なベースURLと有効なcodex apiキーを設定してください。このキーはダッシュボードでのサインアップ時に生成されます。エンドポイントは標準およびストリーミングリクエストの両方を受け付けるため、OpenAI互換の構造を想定するほとんどのコーディングエージェントにとってそのまま置き換え可能です。
認証はAuthorizationヘッダーに依存します。キーをBearerトークンとして含めてください。プロキシやカスタムエージェントフレームワークを使用している場合は、標準のHTTPヘッダーを尊重していることを確認してください。このサービスは独立しており、他のベンダーを経由したりモデルを集約したりしません。あなたは当社の無検閲LLMに直接接続しています。
チャット完了を送信
まず単純なテキストリクエストでテストしてください。これにより、認証とベースURLが正しいことを確認できます。エンドポイントはuserやassistantなどのロールを持つメッセージのリストを受け付けます。モデルIDは常にuncensoredです。このリクエストは標準的な完了レスポンスを返します。複雑なプロンプトに進む前に、エージェントがJSON構造を解析できることを確認してください。
ペイロードが8 MBのボディ制限内に収まるようにしてください。大きなコンテキストウィンドウがサポートされていますが、総トークン数（入力と出力の合計）は100,000トークン未満に維持する必要があります。これらの制限を超えると、サーバーはエラーを返します。接続を確認するために小さなテストから始めてください。
curl https://api.getcodexapi.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
}'ストリーミング（SSE）を有効化
リアルタイムのトークン生成が必要なコーディングエージェントの場合は、ストリーミングを有効にしてください。リクエストボディでstreamパラメータをtrueに設定します。サーバーは単一のJSONオブジェクトの代わりにサーバー送信イベント（SSE）のシーケンスを返します。各イベントにはレスポンスの部分的なチャンクが含まれます。これによりユーザーの知覚レイテンシが削減され、エージェントはトークンが到着するたびに処理できます。
ストリーミングは料金やトークンカウントを変更しません。総入力トークンと出力トークンに対して引き続き課金されます。クライアントコードでSSEストリームを処理して、最終レスポンスを累積するか増分的に処理してください。これは中間結果が有用なコード生成に最適です。
stream = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Tell the story in second person."}],
stream=True,
)
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="", flush=True)ツール呼び出しを使用
当社のモデルは関数呼び出しをサポートしており、エージェントが外部ツールを実行できます。関数をtoolsパラメータで定義してください。モデルは関数が必要と判断した場合、プレーンテキストの代わりにツール呼び出しを含むレスポンスを返します。エージェントはこのレスポンスを解析してツールを実行し、結果を会話に戻す必要があります。
この機能は、コードの実行、データベースの照会、ライブデータの取得が必要なコーディングエージェントに不可欠です。ツールスキーマは標準的なOpenAI形式に従います。エージェントがモデルとツール実行ロジック間のラウンドトリップを正しく処理することを確認してください。これにより、生テキストを構造化されたツール結果に置き換えることで、コンテキストウィンドウを効率的に維持できます。
from openai import OpenAI
client = OpenAI(base_url="https://api.getcodexapi.com/v1", api_key="YOUR_KEY")
resp = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)利用可能なモデルを確認
GET /v1/models エンドポイントを使用して、利用可能なモデルを確認してください。このエンドポイントは、ID や作成日を含むモデルオブジェクトのリストを返します。当 API が提供するモデルは 1 つのみです：uncensored。複数のベンダーを統合するプロキシリレーとは異なり、最適化された LLM のための専用エンドポイントを提供しています。これにより、コーディングタスクに対して一貫した動作と予測可能なパフォーマンスが保証されます。
このエンドポイントにクエリを送信して、クライアントが正しいサービスに接続されていることを確認してください。標準的なメタデータフィールドが返されます。モデル選択を手動で管理する必要はありません。クライアントはすべてのチャット完了でuncensoredモデルIDを要求するだけです。これにより統合が簡素化され、ルーティングエラーを回避できます。
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.getcodexapi.com/v1", apiKey: process.env.API_KEY });
const resp = await client.chat.completions.create({
model: "uncensored",
messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);レート制限と制約
中断を避けるために使用状況を監視してください。APIはキーごとに1分あたり300リクエストの制限を適用します。これを超えると、429 Too Many Requestsエラーが発生します。リクエストボディのサイズは8 MBに制限されています。これらの制約は、高スループットのエージェントの安定したパフォーマンスを保証します。大量のバッチを処理している場合は、クライアントのリクエスト頻度を調整してください。
認証エラーはキーが無効な場合に401ステータスを返します。クレジットが不足している場合は402ステータスになります。リクエストを送信する前に、前払い残高が正であることを確認してください。クレジットは期限切れにならないため、都合の良い時にチャージできます。codex apiキーはいつでも再生成でき、古いキーは即時無効化されます。キーを安全に保管してください。
