API ドキュメンテーション

ベースURLと認証

APIは https://api.ollamaapidoc.com/v1。Bearerトークンを Authorization header. ダッシュボードでGoogleまたはメールアドレスで即座にキーを生成。電話番号は不要です。このキーは、ベースURLを設定することで標準的なOpenAI SDKと互換性があります。

最初のリクエスト

POSTリクエストを以下に送信 /v1/chat/completions モデルID uncensored. このエンドポイントはテキスト入力とテキスト出力を処理します。ストリーミング、JSONモード、関数呼び出しをサポートします。まずmodelsエンドポイントをチェックしてクレジットを使わずに接続性をテストできます。

Copycurl https://api.ollamaapidoc.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all installed models"}]
  }'

レスポンスは標準的なOpenAI形式を返します。エラーは適切なHTTPコードを返します。本文内の error 何かが失敗した場合の詳細。ストリーミングレスポンスはServer-Sent Eventsを使用します。

Python SDK統合

公式のOpenAIライブラリをインストールします。ベースURLとAPIキーを使用してクライアントを設定します。チャット完了エンドポイントを呼び出します。コードは標準的なOpenAIの使用法と同じです。これにより、既存プロジェクトへの移行が容易になります。temperatureやtop_pなどのパラメータは、呼び出し時に直接調整できます。

Copyfrom openai import OpenAI

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

レート制限や無効なキーによる例外を処理します。streamをtrueに設定すると、ライブラリはトークンをストリーミングします。このアプローチにより、コードベースはクリーンで互換性のある状態が維持されます。

Node.js SDKのセットアップ

を使用 openai npmパッケージ。カスタムベースURLでクライアントを初期化します。APIキーを渡します。構文はPythonの例に準拠しています。この一貫性はデバッグ時間を短縮します。会話履歴配列に複数のメッセージを送信できます。

Copyimport OpenAI from "openai";

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

レスポンスを注意深く解析します。APIは構造化されたJSONを返します。プロダクションアプリではエラー処理が重要です。ネットワークエラーとAPI固有のエラーを別々にキャッチします。これにより、高トラフィック時にアプリが応答性を維持します。

ストリーミングとJSONモード

streamを stream true に設定します。APIはServer-Sent Events経由でトークンを送信します。リアルタイムで部分的なレスポンスを受信します。これにより長い出力のユーザーエクスペリエンスが向上します。JSON出力を強制することもできます。 response_format. これは構造化データの抽出に役立ちます。

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)

関数呼び出しは類似して動作します。リクエストでツールを定義します。モデルはツール呼び出しを返します。これらの呼び出しをコードで解析します。それらを実行し、結果をモデルに戻します。このループは複雑なワークフローを可能にします。

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

コンテキストウィンドウは100,000トークンです。最大出力は1リクエストあたり16,000トークンです。エラーには、無効なキーの場合の401と、クレジット不足の場合の402が含まれます。レート制限は1分あたり300リクエストで制限されます。アプリでこれらを適切に処理してください。APIはプロンプトをトレーニングに使用しません。プライバシーは維持されます。クレジットの有効期限はありません。