キャラクターAPI統合クイックスタート
このクイックスタートガイドでは、標準のOpenAI SDKを使用してキャラクターAPIを数分で動作させる方法を示します。ベースURLの設定、APIキーの挿入、そして最初の制限なしリクエストの送信を行います。
SDKをインストール
お好みの言語用の公式クライアントライブラリをインストールすることから始めましょう。これにより、提供されるOpenAI互換エンドポイントとの互換性が確保されます。ライブラリは直列化とリトライロジックを処理します。
Pythonではpipを使用します。Node.jsではnpmを使用します。このステップは数秒で完了し、続くコードサンプル用の環境を設定します。
ベース URL の構成
SDKクライアントを無制限モデルにアクセスするためのエンドポイントにポイントしてください。ベースURLは HTTPS://api.apicharacter.com/v1 です。これは設定ファイル内のデフォルトのOpenAI URLに置き換わります。
この変更を行わないと、リクエストが失敗するか間違ったサービスに到達します。クライアントインスタンスの初期化時に1回設定するだけで済みます。
APIキーを設定
キーを環境変数またはクライアント設定に注入します。すべてのリクエストで認証が必要であり、これはプリペイドクレジットの使用状況を追跡するためです。キーはuncensored LLMエンドポイントへのアクセス権限を付与します。
この値を安全に保管してください。これはアカウントの唯一の認証情報として機能します。基本アクセスには電話番号や追加の確認は必要ありません。
最初のリクエストを行う
接続性を確認するために、シンプルなチャット完了を送信します。モデルIDは「uncensored」です。これにより、アプリケーションを構築する前に認証とベースURLが正しいことが確認されます。
標準的なcURLリクエストの例は以下の通りです。
curl https://api.apicharacter.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "set my name to Alex"}]
}'
ストリーミングレスポンスの処理
チャットインターフェースのレイテンシ削減のためにストリーミングを有効にします。リクエストで stream パラメータを true に設定してください。SDK は生成されるたびにトークンをイテレートします。
これはレスポンシブなユーザーエクスペリエンスにとって重要です。Server-Sent Eventsを介して到着する部分的なチャンクを処理してください。
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)
制限、エラー、コンテキスト
サービス中断を避けるための制約を理解しましょう。100,000トークンのコンテキストウィンドウが得られます。指定がない限り、最大出力は16,000トークンです。
レートリミットは1分間あたり300リクエストです。401エラーは無効なキー、402は残高ゼロ、429はレートリミット到達を意味します。本番環境でのスケーリング時にこれらを考慮してください。
Python
from openai import OpenAI
client = OpenAI(base_url="https://api.apicharacter.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)Node.js
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.apicharacter.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);FAQ
キャラクターAPIキーの取得方法
Googleまたはメールアドレスでダッシュボードにサインアップ。電話番号の確認なしでAPIキーが即座に表示されます。必要に応じて新しいキーを生成でき、古いキーを置き換えることができます。
これはopenai互換APIですか?
はい、標準的なchat-completions形式に従っています。ベースURLとAPIキーを変更するだけです。ほとんどのOpenAI SDKは、わずかな設定変更でそのまま動作します。
402エラーが発生した場合どうなりますか?
これは、前払いのクレジットが枯渇したことを意味します。サービス再開のため暗号通貨でチャージしてください。エラーと拒否はクレジットを消費しないため、実際の使用量に対してのみ支払います。
キーを即座に取得
サインアップしてキーを取得し、ベースURLを更新するだけ。これだけです。