JA ▾
API キーを取得
  1. NSFW Video API
  2. Open WebUIにはAPIがありますか? はい、2つの方向で

OpenWebUIにはAPIがありますか? はい、2つの方向があります

openwebuiにはAPIがありますか? はい、この質問には2つの意味があります。Open WebUIは独自のAPIを公開しており、モデルバックエンドとして他のAPIも使用できます。このページでは両方を説明し、それらがどのように連携するかを示します。

更新

サーバーキューブを挟んで双方向の矢印で結ばれた2つのゲートウェイ。Open WebUI独自のAPIと外部バックエンドを示しています

人々が意味する2つの異なるAPI

誰かがOpen WebUIにAPIがあるかどうかを尋ねるとき、2つの方向のいずれについて尋ねている可能性があります。これらを混同すると、セットアップガイドが混乱する主な原因となるため、まずそれらを分離することが役立ちます。

  • インバウンド: プログラムがOpen WebUIにリクエストを送信します。チャット、モデル、ファイルのエンドポイントを持つサーバーとして機能し、アプリ内で生成したAPI キーで保護されます。
  • アウトバウンド: Open WebUIはチャットウィンドウが応答相手を持てるように、モデルサーバーにリクエストを送信します。これは管理者設定で構成する接続です。

したがって、短い答えは両方ともはいです。プロジェクトはOpenAIスタイルのチャットエンドポイントを持つAPIを文書化しており、OpenAIプロトコルを話す任意のサーバーとの接続をサポートしています。正確なパスやキーの処理などの詳細はバージョン間で変更される可能性があるため、実行しているリリースのドキュメントを確認してください。

このサイトはアウトバウンド側でモデルを提供します。単一のモデルID uncensoredを持つ、OpenAI互換のテキストAPIホスティングサービスです。これはOpen WebUIではなく、Open WebUIを代わりに実行するものでもありません。Open WebUIはあなたがホストするソフトウェアです。

Open WebUI独自のAPIの使用

Open WebUIでは、ログインしたユーザーがアカウント設定からAPIキーを作成できます。そのキーを使って、スクリプトからエンドポイントを呼び出すことができます。チャットエンドポイントはOpenAIの形状に従っているため、既存のクライアントコードをそれに向けることができることが多いです。執筆時点でのプロジェクトが文書化しているルートは/api/chat/completionsです。お使いのバージョンで確認してください。

# Open WebUI running locally on port 3000, key created in Settings > Account
curl http://localhost:3000/api/chat/completions \
  -H "Authorization: Bearer $OPENWEBUI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"uncensored","messages":[{"role":"user","content":"Summarize this scene in one line."}]}'

ここでモデル名は、Open WebUIに登録されている任意のモデルです。このAPIをバックエンドとして接続した場合、その名前は uncensored です。このリクエストのキーはOpen WebUIキーであり、モデルAPIキーではありません。これらは2つの別々の資格情報で、2つの別々の役割を持っています。

なぜインバウンドAPIを使用するのか? プログラムの背後でOpen WebUIの追加機能(保存されたナレッジコレクション、ユーザーごとのアカウント、モデルプリセットなど)を使用したい場合、ブラウザなしでそれらにアクセスしたい場合に役立ちます。

バックエンドとして外部APIの使用

もう一方の方向が、ほとんどの人が必要とするものです。Open WebUIにはOpenAI互換の接続用のセクションがあり、URLとキーを入力します。このサービスの場合、値は次の通りです。

  • URL: https://api.nsfwvideo.top/v1
  • キー: キーページからのもの
  • モデル: uncensored、GET /v1/modelsを通じて自動的に検出されます

ステップバイステップ:管理者設定を開き、接続に移動し、OpenAI API接続を追加し、URLとキーを貼り付け、保存し、新しいチャットでモデルを選択します。コマンドラインで開始する場合は、コンテナ起動時に環境変数 OPENAI_API_BASE_URL と OPENAI_API_KEY を設定してください。

docker run -d -p 3000:8080 \
  -e OPENAI_API_BASE_URL=https://api.nsfwvideo.top/v1 \
  -e OPENAI_API_KEY=$API_KEY \
  -v open-webui:/app/backend/data \
  ghcr.io/open-webui/open-webui:main

Open WebUIは、初回起動時に多くの設定をデータベースに保存することに注意してください。後で環境変数を変更しても何も起こらない場合、代わりに管理パネルで接続を編集してください。curlで検証したい場合、バックエンドが期待するリクエスト形式は クイックスタート にあります。

2つをチェーンする

両方の方向を同時に使用できます。アプリケーションはOpen WebUIキーを使用してOpen WebUIのインバウンドAPIを呼び出し、Open WebUIはチャットを構成したバックエンドに転送し、返信が戻ってきます。この構成は以下の状況で意味があります:チームがアカウント付きのOpen WebUIを実行しており、スクリプトがプリセットを共有したい場合、または人間とプログラムの両方のペルソナ設定を保持する1つの場所が必要な場合です。

これにより、1つの経由地が追加されます。すべてのリクエストは、モデルAPIに到達する前にOpen WebUIサーバーを通過するため、実行、パッチ適用、セキュリティ確保を維持するものが1つ増えます。レート制限も分かりにくい方法で積み重なります。バックエンドキーは、フルキーに対して8つの同時リクエストと1分あたり300リクエストを許可しますが、あなたのOpen WebUIインスタンスを通過するすべてのユーザーとスクリプトはその利用枠を共有します。バックエンドがHTTP 429、エラーコードrate_limitedまたはconcurrencyで応答した場合、失敗は通常Open WebUIと呼び出し元にエラーとして表示されます。

Open WebUIをスキップしてAPIに直接呼び出すべき場合

アウトライン、ショットの説明、ドラフトナレーションなど、テキストを生成するスクリプトが必要なだけの場合、Open WebUIは不要です。このサービスは通常のOpenAI互換エンドポイントなので、標準SDKが直接アクセスします。

import os
from openai import OpenAI

client = OpenAI(base_url="https://api.nsfwvideo.top/v1", api_key=os.environ["API_KEY"])

resp = client.chat.completions.create(
    model="uncensored",
    messages=[
        {"role": "system", "content": "You write concise shot lists for short films."},
        {"role": "user", "content": "Shot list for a ninety second chase through a night market."},
    ],
    temperature=0.7,
)
print(resp.choices[0].message.content)

直接呼び出しにより、SSEを介したストリーミング、ツール呼び出し、JSONモード、および中間レイヤーなしで利用可能なすべてのサンプリングパラメータが得られます。対話型チャットインターフェース、履歴、アカウント、プリセットを人々向けに提供したい場合は、Open WebUIがより良い選択です。バッチ処理にはスクリプトがより良い選択です。APIはテキストのみを生成します。動画、画像、オーディオはレンダリングしないため、動画プロジェクトでは、他のツールのためのスクリプトやプロンプトなどの書かれた部分を提供します。 ビデオパイプラインページ でその使用法について詳しく説明しています。

クイック判断ガイド

  • あなた自身またはチームのためのチャットウィンドウが欲しい場合: Open WebUIを実行し、アウトバウンド接続を追加します。
  • スクリプトがOpen WebUIプリセットまたはアカウントを再利用したい場合: Open WebUIキーを使用してそのインバウンドAPIを使用します。
  • バッチテキスト生成が欲しい場合: OpenAI SDKを使用してモデルAPIに直接呼び出し、余分なレイヤーをスキップします。
  • 画像や音声が必要である場合: Open WebUIまたはこのテキストAPIのいずれもそれらを単独で生成しません。そのステップのために別のツールを接続してください。

どちらのパスを選択しても、モデル側の事実は同じです:プロンプトと返信で共有される100,000トークンのコンテキストウィンドウ、利用可能な関数呼び出しとJSON モード、および未成年者が関与する性的コンテンツに対する厳格なルール。

いずれのAPIを公開する場合のセキュリティノート

両方のキーを秘密として扱ってください。Open WebUIキーは、作成したユーザーがインスタンス内で実行できるすべての操作を付与します。モデルAPIキーはあなたの前払い残高を使用します。いずれのキーもクライアント側のコードや公開リポジトリに貼り付けないでください。

  • Open WebUIが自分のマシン以外から到達可能な場合は、HTTPSの背後に配置してください。
  • スクリプトごとに別のOpen WebUIキーを作成し、1つを取り消しても他のものが壊れないようにしてください。
  • モデルAPIキーがログやスクリーンショットに表示された場合は、ローテーションしてください。
  • バックエンドの X-Balance-USD レスポンスヘッダーを監視して、呼び出しごとの消費額を確認してください。

プライバシーについて、このAPIに送信されたプロンプトはトレーニングに使用されません。Open WebUI自体はチャット履歴をサーバー上の独自のデータベースに保存するため、ホスティングの選択が誰がそれを読み取れるかを決定します。

このセットアップの実行コスト

Open WebUIはあなたがホストする無料ソフトウェアです。コストはサーバーとトークンです。トークンは、前払いクレジットから、1M入力あたり$0.15、1M出力あたり$0.50で請求されます。3,000の入力トークンと500の出力トークンでチャットターンを行うと:3,000 x $0.15 / 1M = 入力用$0.00045、500 x $0.50 / 1M = 出力用$0.00025、合計$0.0007です。そのようなターン1,000回で$0.70かかります。

チャージは$20から$500までの任意の整数金額で、$50以上で+5%、$100以上で+10%、$200以上で+15%が追加されます。支払いには暗号資産、TRC20上のUSDTまたはBase上のUSDCを使用します。失敗または拒否されたリクエストは請求されず、クレジットは期限切れになりません。新規ユーザーは、ワンクリックで支払い情報なしで7日間の$0.50無料トライアルを取得できます。詳細は料金ページをご覧ください。

コンテンツに関する注意事項:このモデルは、法的な成人向け利用に対してコンテンツ拒否なしで回答するようにチューニングされています。未成年者を含む性的コンテンツは常に禁止されています。

質問と回答

Open WebUIには独自のAPIがありますか?

はい。アカウント設定からAPI キーを作成し、OpenAIスタイルのチャットルートを含むエンドポイントを呼び出すことができます。正確なパスはご利用のバージョンのドキュメントでご確認ください。

Open WebUIは外部のOpenAI互換APIを使用できますか?

はい。管理設定の「接続」に、ベースURLとキーを追加してください。このサービスの場合、URLは https://api.nsfwvideo.top/v1 で、モデルは uncensored です。

Open WebUIのキーとモデルのAPI キーは同じですか?

いいえ。最初のキーはOpen WebUIサーバーへの呼び出しを認可します。2番目のキーはモデルAPIへの呼び出しを認可し、残高を使用します。

このAPIを使用するためにOpen WebUIは必要ですか?

いいえ。OpenAI SDKまたはHTTPクライアントのいずれでも直接呼び出すことができます。Open WebUIは単なる便利なチャットインターフェースに過ぎません。

キーはフォームに記入するだけで入手可能です

アカウントを作成し、キーをコピーし、ベースURLを変更します。これでセットアップは完了です。

API キーを取得