仕様の概要
すでに OpenAI にアクセスするコードをお持ちの場合、OpenAI 互換 API 仕様の要点は次の通りです:ベース URL を変更し、キーを変更し、モデルを uncensored に設定します。リクエストボディとレスポンスボディは chat completions の形式に従うため、SDK は変更なしで解析できます。
| 項目 | 内容 |
|---|---|
| ベース URL | https://api.unrestrictedaiapi.com/v1 |
| 認証 | Authorization: Bearer YOUR_KEY |
| エンドポイント | POST /v1/chat/completions、GET /v1/models |
| モデル ID | uncensored |
| コンテキスト長 | 100,000 トークン(プロンプトと補完を含む) |
| 最大リクエストボディ | 8 MB |
| 出力 | テキストのみ |
このモデルは、独立したプロバイダが運用する単一のオープンウェイトモデルで、法的な成人利用においてコンテンツ拒否なしで回答するようにチューニングされています。どのモデルベンダーの公式エンドポイントでもなく、ベンダー間のルーティングも行いません。そのため、モデル ID が 1 つだけで、モデルリストが短いのです。
エンドポイント
GET /v1/models
キーで利用可能なモデルを返します。キーとベース URL が正しいことを確認する最も安価な方法であり、多くの UI クライアントはドロップダウンを埋めるためにこれを呼び出します。
curl https://api.unrestrictedaiapi.com/v1/models \
-H "Authorization: Bearer $KEY"
POST /v1/chat/completions
唯一の生成エンドポイントです。messagesオブジェクトの配列(role(system、user、assistant、tool)と content を持つ)と、モデル、および任意のサンプリングオプションを送信します。最小限の呼び出し例:
curl https://api.unrestrictedaiapi.com/v1/chat/completions \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [
{"role": "system", "content": "Answer in one sentence."},
{"role": "user", "content": "What is a base URL?"}
]
}'
返信には、生成されたテキストが choices[0].message.content に、トークン数が usage に含まれます。これらのカウントが課金の基準となります。
提供されていないもの:レガシーな completions エンドポイント、embeddings、画像、音声、動画エンドポイント、ファインチューニング、ファイルエンドポイント。これらを呼び出すクライアントはエラーを受信するため、デフォルトでこれらを使用するツールでそれらの機能を無効にしてください。
リクエストパラメータ
以下のパラメータは受け入れられ、モデルに渡されます:
- サンプリング用の
temperatureとtop_p。 - 1 つ以上のストップシーケンス用の
stop。 - 他の条件をすべて同じに保った場合の再現可能なサンプリング用の
seed。 - 反復を減らすための
presence_penaltyとfrequency_penalty。 - オプションの
max_tokens。これを省略すると、completion は 100,000 トークンのウィンドウの残りをすべて使用できます。 - サーバー送信イベント用の
stream。 - 関数呼び出しのために
toolsとtool_choiceを使用します。 - JSON モード用の
response_formatと{"type":"json_object"}。
実用的な注意点を2つ示します。まず、ウィンドウはプロンプトと補完を合算してカウントするため、90,000トークンのプロンプトでは回答に約10,000トークンしか残りません。第二に、ボディの制限は8 MBですが、これはテキスト100,000トークンに必要な容量をはるかに超えるため、メッセージに大きなエンコード済みペイロードを埋め込んだ場合にのみ到達します。
ストリーミング
stream: true を設定すると、レスポンスはサーバー送信イベントとして到着します。各イベントは delta に次のテキストの断片を含む JSON チャンクであり、使用量はストリームの末尾で報告されます。SDK はフレーム構造を隠蔽しますが、生プロトコルでは、ストリームが閉じるまで data: で始まる行を読み取ります。
from openai import OpenAI
client = OpenAI(base_url="https://api.unrestrictedaiapi.com/v1", api_key="YOUR_KEY")
with client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "List five HTTP status codes."}],
stream=True,
) as stream:
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
キャパシティプランニングに影響するルールが 1 つあります。ストリーミングリクエストは、最初のトークンではなくストリームが終了するまで同時実行スロットを保持します。クライアントが読み込み中に停止すると、スロットが使用中のままになります。必ずストリームを閉じるか終了させ、クライアントのタイムアウトを設定してください。
ツール呼び出しとJSONモード
関数呼び出し
JSON スキーマパラメータを持つ関数定義のリストとして tools を渡します。モデルが関数を呼び出すと判断した場合、メッセージには tool_calls が含まれます。これは stream がオンの場合もストリーミングされます。関数を実行し、role: "tool" と対応する tool_call_id を持つメッセージとして結果を送ります。特定の関数を強制するか、モデルに判断を任せるために tool_choice を使用します。
{
"model": "uncensored",
"messages": [{"role": "user", "content": "Weather in Oslo?"}],
"tools": [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Current weather for a city",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"]
}
}
}]
}
モデルは引数を提案しますが、何も実行しません。ユーザー入力と同様に、アクションを起こす前に検証してください。
JSON モード
単一の有効な JSON オブジェクトを要求するには "response_format": {"type": "json_object"} を追加します。他の OpenAI 互換実装と同様に、プロンプトで必要なキーをモデルに伝えてください(例:"title と tags というキーを持つオブジェクトを返してください")。結果は必ず try ブロックで解析し、長いオブジェクトが切り捨てられないよう max_tokens を余裕を持って設定してください。
制限、ヘッダー、エラー
| キーの種類 | 同時リクエスト | 1分あたりのリクエスト数 |
|---|---|---|
| フルキー | 8 | 300 |
| トライアルキー | 2 | 60 |
すべてのレスポンスには X-Request-Id(support に連絡する際に引用してください)、X-Balance-USD(残高クレジット)、X-RateLimit-Limit-Requests、X-RateLimit-Limit-Concurrency が含まれます。
制限を超えると、API は HTTP 429 を返します。エラーコードはケースを区別します:
rate_limited:1分あたりのリクエスト数が多すぎます。リクエストを減らすか、負荷を分散してください。concurrency:同時に実行中のリクエストが多すぎます。クライアント側でキューに入れてください。Retry-After: 5ヘッダーを伴う 429:一時的な過負荷。5 秒待ってから再試行してください。
import time
import httpx
def post_with_retry(payload, key, tries=4):
# payload example: {"model": "uncensored", "messages": [...]}
for attempt in range(tries):
r = httpx.post(
"https://api.unrestrictedaiapi.com/v1/chat/completions",
headers={"Authorization": "Bearer " + key},
json=payload,
timeout=120,
)
if r.status_code == 429:
wait = int(r.headers.get("Retry-After", 2 ** attempt))
time.sleep(wait)
continue
return r
return r
失敗または拒否されたリクエストには課金されません。
ロール、履歴、レスポンスオブジェクト
API はステートレスです。以前のリクエストを記憶しないため、会話とはあなたが毎回送信する messages 配列としてのみ存在します。典型的な履歴は、動作を設定する 1 つの system メッセージで始まり、その後に交互に user と assistant メッセージが続きます。関数呼び出しが行われる場合、tool メッセージがそれらの間に現れ、それぞれが tool_call_id によって応答する呼び出しにリンクされます。
これには2つの結果があります。1つ目はコストです:ターンごとに履歴全体が入力として課金されるため、長いチャットではメッセージごとにコストが増加します(質問が短くても)。2つ目は制御です。履歴は自由に編集、トリム、書き換えできます。最も古いターンを削除したり、要約に置き換えたり、修正された assistant メッセージを挿入したりするのは通常の操作であり、モデルは送信されたものを真実として扱います。
戻り値から3つの項目を読み取ります。choices[0].messageにはテキストまたはツール呼び出しが含まれます。choices[0].finish_reasonは生成が停止した理由を示します:自然な終了、トークン制限の到達、またはツール呼び出しです。usageにはプロンプト、補完、合計のトークン数が含まれます。finish_reasonでトークン制限に到達したと表示された場合、テキストは切り捨てられているため、制限を引き上げるか、フォローアップのターンでモデルに継続を依頼してください。
簡易互換性チェックリスト
このエンドポイント向けにクライアントをリリースする前に、以下のチェックを実行してください。これにより、統合の問題のほとんどを数分で検出できます。
- キーを使用して
GET /v1/modelsを呼び出し、uncensoredが含まれるリストが返されることを確認します。 - オプションなしでプレーンなチャットリクエストを送信し、
usageブロックを含む通常の返信が返されることを確認します。 stream: trueで繰り返し、クライアントがストリームの終了と最終的な使用量データを処理できることを確認します。- ツールを使用する場合、
toolメッセージを含むフォローアップリクエストを含む、ツール呼び出しの往復を1回、エンドツーエンドで送信します。 - トライアルキーで同時に 10 件のリクエストを送信し、2 番目の同時リクエストに続く 429 にコードが対処できることを確認します。
- すべての呼び出しに対して
X-Request-Idをログに記録し、後で任意の異常な結果を追跡できるようにします。
これら 6 つのすべてに合格すれば、クライアントは実際のトラフィックに対応する準備ができています。
フルOpenAIプラットフォームとの違い
互換性はチャットプロトコルを指し、プラットフォーム全体を指すわけではありません。テキストチャット以外の機能は存在せず、一部の動作はプロトコルではなくモデル由来です。モデル名は固定されており、回答のスタイルは以前使用した任意のモデルとは異なる可能性があります。同じseedでのサンプリングは、プロンプトとパラメータが同じである間にのみ再現可能です。
変更できないコンテンツルールは、未成年者を含む性的コンテンツがブロックされることです。それ以外では、モデルは法的な成人利用に対して拒否(応答拒否)を回避するように調整されており、プロンプトはトレーニングには使用されません。
5つの言語のコード例はクイックスタートをご覧ください。制限のないモデルのプロンプト手法については制限なしモデルのプロンプトをお読みください。アカウント関連の料金は料金表に記載されています:入力トークン100万トークンあたり$0.15、出力トークン100万トークンあたり$0.50で、クレジットの有効期限はありません。ドキュメントには短縮版の仕様書が記載されています。
