Agents API (ベータ版)
OpenAI互換およびOpen Responses APIエンドポイントを介してLibreChatエージェントにプログラムでアクセスする
ベータ機能
Agents APIは現在ベータ版です。安定版リリースに向けて開発を進める中で、endpoint、リクエスト/レスポンスの形式、および動作が変更される可能性があります。
LibreChatは、2つのAPI互換インターフェースを通じてエージェントを公開しており、外部アプリケーション、スクリプト、サービスがプログラムからエージェントとやり取りできるようになっています。
概要
Agents APIは、2つのインターフェースを提供します:
- OpenAI互換のChat Completions —
POST /api/agents/v1/chat/completions - Open Responses API —
POST /api/agents/v1/responses
どちらもAPIキーによって認証され、ストリーミングレスポンスをサポートしているため、OpenAI SDKや同様のツールを既に使用している既存のワークフローにLibreChatエージェントを簡単に統合できます。
LibreChatは、エージェントを提供するための主要なAPIフレームワークとしてOpen Responsesを採用しています。Chat Completions endpointは既存のOpenAI互換ツールとの後方互換性を提供しますが、Open Responses endpointは将来の方向性を表しています。
Agents API を有効にする
Agents APIは、remoteAgentsインターフェース設定によって制限されています。すべての権限はデフォルトでfalseに設定されています。
interface:
remoteAgents:
use: true
create: true利用可能なすべてのオプションについては、Interface Configuration — remoteAgents を参照してください。
注: 管理者ユーザーには、すべてのリモートエージェント権限がデフォルトで有効になっています。
API Key Management
remoteAgents.use および remoteAgents.create が有効になると、ユーザーは LibreChat UI から API キーを生成できるようになります。これらのキーは、Agents API へのリクエストを認証するために使用されます。
認証
Agents APIは、個別または組み合わせて使用できる2つの認証方法をサポートしています。
API Key
APIキー認証はデフォルトで有効になっています。remoteAgents.use および remoteAgents.create が有効になったら、LibreChat UIからAPIキーを生成してください。
Authorization: Bearer <YOUR_API_KEY>OIDC Bearer Token
インフラストラクチャにすでにOIDCプロバイダーが存在するマシン間(M2M)のシナリオでは、LibreChat APIキーを使用せずに、OIDC Bearerトークンで直接認証を行うことができます。
librechat.yaml で OIDC 認証を設定します:
endpoints:
agents:
remoteApi:
auth:
apiKey:
enabled: false
oidc:
enabled: true
issuer: https://auth.example.com/realms/myrealm
# jwksUri is optional and auto-discovered from issuer if omitted
audience: my-client-id次に、OIDCアクセストークンを使用してAPIを呼び出します:
curl -X POST https://your-librechat-instance/api/agents/v1/responses \
-H "Authorization: Bearer YOUR_OIDC_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"model": "agent_abc123", "input": "Hello!"}'OIDCトークンは、LibreChatに既に存在するユーザーのものである必要があります。照合にはまず sub クレームが使用され、次に email、preferred_username、または upn が順次フォールバックとして使用されます。
すべての設定オプションについては、Agents Endpoint - remoteApi を参照してください。
Endpoints
Chat Completions (OpenAI互換)
POST /api/agents/v1/chat/completionsLibreChat インスタンスを指定することで、あらゆる OpenAI 互換 SDK を使用できます。model パラメータはエージェント ID に対応しています。
curlを使用した例:
curl -X POST https://your-librechat-instance/api/agents/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "agent_abc123",
"messages": [
{"role": "user", "content": "Hello, what can you help me with?"}
],
"stream": true
}'OpenAI SDK (Python) を使用した例:
from openai import OpenAI
client = OpenAI(
base_url="https://your-librechat-instance/api/agents/v1",
api_key="YOUR_API_KEY"
)
response = client.chat.completions.create(
model="agent_abc123",
messages=[{"role": "user", "content": "Hello!"}],
stream=True
)
for chunk in response:
print(chunk.choices[0].delta.content, end="")モデルの一覧表示
GET /api/agents/v1/models利用可能なエージェントをモデルとして返します。APIキーでどのアージェントにアクセスできるかを確認するのに便利です。
Open Responses API
POST /api/agents/v1/responsesOpen Responses endpointは、OpenAIが主導し、オープンソースAIコミュニティによって構築されたオープン推論標準であるOpen Responses specificationに従っています。これは、推論、ツール使用、構造化出力、およびストリーミングセマンティックイベントをネイティブでサポートする、エージェントワークフロー向けに設計されています。
curl -X POST https://your-librechat-instance/api/agents/v1/responses \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "agent_abc123",
"input": "What is the weather today?"
}'トークン使用量の追跡
すべての Agents API リクエストは、ユーザーの残高に対してトークン使用量を追跡します(トークンの消費が設定されている場合)。入力トークンと出力トークンの両方がカウントされ、それらをサポートするプロバイダー(OpenAI、Anthropic)のキャッシュトークンも含まれます。
ロードマップ
- Open Responses をプライマリインターフェースとして採用 — Open Responses endpoint を拡張し、エージェントループ、ツールオーケストレーション、およびストリーミングセマンティックイベントの完全なサポートを計画しています。
- Anthropic Messages API — 将来的に、追加のインターフェースとして Anthropic Messages API 形式のサポートを追加する可能性があります。
関連ドキュメント
- Agents — エージェントの作成と設定
- インターフェース設定 — remoteAgents — アクセス制御設定
- Token Usage — トークン消費と残高の設定
- Open Responses Specification — オープンな推論標準
このガイドはいかがでしたか?