OpenAI互換APIドキュメント

クイックスタート: OpenAI SDK で接続

キーで認証し、クライアントを当ベースURLにポイントすることから始めましょう。このセットアップはPythonおよびNode.jsの公式OpenAI SDKと連携し、同じクライアントコードを当サービスに対して実行できることを保証します。ダッシュボードから有効なAPIキーと、正しいエンドポイント設定が必要です。

Copycurl https://api.openaiapicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current UTC timestamp in ISO 8601 format"}]
  }'

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.openaiapicompatible.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)

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.openaiapicompatible.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);

チャット完了エンドポイント

単一のチャットエンドポイントにテキストを送信して、直接テキスト出力を取得します。POST /v1/chat/completionsを使用してプロンプトを処理し、生成されたテキストを返します。これは、複雑なルーティングや追加のサービス呼び出しを必要としない、ほとんどのLLMアプリケーションのコアインタラクションです。

Copystream = 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)

SSEによるストリーミング

サーバー送信イベントを使用してリアルタイムでトークンを受信し、レイテンシを低減します。リクエストでstreamパラメータをtrueに設定してストリーミングを有効にします。最終チャンクにはトークン使用量データが含まれており、モデルがテキストを生成する際にコストを正確に追跡できます。このアプローチにより、長い出力でもUIが応答性を維持します。

Function Calling & JSON Mode

ツールを使用して構造化出力を強制し、信頼性の高いプログラムによる相互作用を実現します。toolsパラメータを使用して関数スキーマを定義し、response_formatをjson_objectに設定して厳格なJSON準拠を実現します。当社のUncensoredモデルは、有効な機能的リクエストを拒否することなく、複雑な指示やエッジケースを処理します。

レート制限とパラメータ

サービス中断を避けるために、厳格なキーごとの制限に対して使用状況を監視してください。1分あたり300リクエスト、キーあたり8つの同時リクエストが許可されており、ボディの制限は8 MBです。401（無効なキー）、402（クレジットなし）、429（レート制限）などのエラーは、特定のアカウント状態を示します。

コンテキストウィンドウ & 制約

100,000トークンのウィンドウを使用して、入力と出力の両方を効率的に処理します。生成長を制御するためにmax_tokensを設定し、指定しない場合は2,048にデフォルト設定されます。当社のモデルは他のベンダーのプロキシではなく独自サーバーで動作するため、特定のユースケースに対して一貫したパフォーマンスが保証されます。