Ollama APIドキュメント：エンドポイントリファレンス

ベースURLと認証

すべてのリクエストのベースURLは https://api.ollamaapidocumentation.com/v1。bearerトークンを Authorization ヘッダー。キーはダッシュボードで生成され、すぐに動作します。

• 公式OpenAI SDKまたは互換性のあるクライアントを使用してください。
• ベースURLを上記の値に設定してください。
• ヘッダーにAPIキーを含めてください。

認証は厳格です。キーが欠落または無効な場合、APIは401エラーを返します。これにより、課金のために使用量が正確に追跡されます。

チャット完了エンドポイント: POST /v1/chat/completions

を介してモデルにメッセージを送信 POST /v1/chat/completionsエンドポイントは、 model フィールドは "uncensored" に設定され、 messages 配列。

このエンドポイントはテキスト生成を処理します。画像、音声、ビデオはサポートしていません。応答をストリーミングするか、完全な結果を待機することができます。

402はクレジット不足を示します。リクエストは実際のトークン使用量に基づいて課金されます。クレジットによる拒否は無料です。

モデルリスト：GET /v1/models

を使用して利用可能なモデルを取得します。 GET /v1/models. これはモデルオブジェクトのリストを返します。利用可能な唯一のモデルIDは "uncensored" です。

このエンドポイントは接続の確認に役立ちます。ベースURLが正しいことを確認します。また、モデル名とオブジェクトタイプも表示します。

接続の問題をデバッグするには、こちらを使用してください。

パラメータ: Temperature、Top P、Seed

パラメータを使用して生成を制御します temperature, top_p、および seedThe seed パラメータは決定論的な出力を保証します。デバッグや一貫した結果のために使用してください。

設定 temperature 0から2の間。低い値は応答をより予測可能にします。高い値はランダム性を高めます。 top_p パラメータは累積確率に基づいてトークンをフィルタリングします。

これらのパラメータは、OpenAI APIと同じように機能します。スタイルを正確に制御するために組み合わせることができます。

ストリーミングレスポンスとトークン使用量

streamをtrueに設定してストリーミングを有効にする stream: trueAPIはServer-Sent Events (SSE)を返します。各チャンクには部分的なテキストが含まれます。

最終チャンクにはトークン使用統計が含まれます。これにより、コストを正確に計算できます。トークンは到着次第処理できます。

ストリーミングは知覚レイテンシーを低減します。チャットインターフェースに最適です。サーバーはレスポンスが完了するまでデータを送信し続けます。

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

コンテキストウィンドウは100,000トークンです。これは入力トークンと出力トークンを合わせたものです。1リクエストあたり最大16,000トークンを生成できます。デフォルトの最大出力は2,048トークンです。

レート制限は1分間あたり300リクエストです。8つの同時リクエストが可能です。リクエストボディのサイズは8 MBに制限されます。

エラーには、無効なキーに対する401とレート制限に対する429が含まれます。クレジットエラーは402を返します。これらのエラーは明確で対処可能です。

cURL

Copycurl https://api.ollamaapidocumentation.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list files in the current directory"}]
  }'

Python

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

ストリーミング

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)