クイックスタート：AIガールフレンドAPIを統合

ベースURLと認証

当APIはOpenAIのchat-completions標準に従っており、既存のクライアントにとって統合は簡単です。すべてのリクエストのAuthorizationヘッダーにAPIキーを含める必要があります。すべてのエンドポイントのベースURLはhttps://api.roleplayapi.com/v1です。公式SDKを使用する場合は、base_url設定を更新してこのアドレスを指し、api_keyとしてキーを提供してください。この設定により、標準ロジックの変更なしでリクエストを当社の専用無検閲エンドポイントに到達させることができます。

補完を送信

/v1/chat/completionsにPOSTリクエストを送信して会話を開始します。モデル識別子はuncensoredです。コンテキストを確立するか、新しい対話を開始するために、messages配列に任意の数のメッセージを渡すことができます。レスポンスにはモデルのテキスト出力が含まれており、ストリーミングするかJSONオブジェクトとして解析できます。このエンドポイントは、キャラクター駆動型アプリに必要なテキスト入力・テキスト出力の相互作用を処理します。

Copycurl https://api.roleplayapi.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."}]
  }'

Python SDK統合

公式のopenaiPythonライブラリを使用して、最小限のボイラープレートでAPIと対話します。クライアントをベースURLとAPIキーで構成します。次に、chat.completions.createをuncensoredモデルIDで呼び出します。このアプローチは既存の型ヒントとエラー処理メカニズムを活用し、HTTP解析よりもアプリケーションロジックに集中できるようにします。レスポンスオブジェクトは生成されたコンテンツに直接アクセスできます。

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.roleplayapi.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 SDK統合

JavaScriptおよびTypeScriptプロジェクトの場合、OpenAI Node SDKはAPI呼び出しのためのクリーンなインターフェースを提供します。カスタムベースURLとシークレットキーを使用してクライアントを初期化します。uncensoredモデルを使用してチャット補完エンドポイントを呼び出します。この方法は、非同期リクエストを効率的に管理する必要があるWebサーバーやエッジ関数に最適です。SDKはJSONペイロードのシリアライズとデシリアライズを自動的に処理します。

Copyimport OpenAI from "openai";

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

ストリーミングを有効化

サーバー送信イベント（SSE）を有効にして知覚されるレイテンシを削減します。リクエストでstreamパラメータをtrueに設定します。APIは単一の完全なレスポンスの代わりにチャンクのストリームを返します。これは、ユーザーが即時のキャラクター応答を期待するチャットインターフェースに特に役立ちます。各チャンクが届次第処理し、UIを逐次更新できます。ストリームはモデルがトークンシーケンスの生成を終了したときに終了します。

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)

制限、エラー、コンテキスト

リクエストはキーごとに1分あたり300件のレート制限の対象となります。これを超えると、APIは429ステータスコードを返します。認証の失敗は401エラーを、前払いクレジットの不足は402エラーを引き起こします。コンテキストウィンドウは、結合されたプロンプトと補完で最大100,000トークンをサポートします。利用可能なモデルを確認する必要がある場合は、GETリクエストを/v1/modelsに送信してください。リクエストボディが8 MBを超えないようにしてください。