Agents API (Beta)

LibreChat stellt Ihre Agents über zwei API-kompatible Schnittstellen bereit, wodurch externe Anwendungen, Skripte und Dienste programmatisch mit Ihren Agents interagieren können.

Übersicht

Die Agents API bietet zwei Schnittstellen:

• OpenAI-kompatible Chat Completions — POST /api/agents/v1/chat/completions
• Open Responses API — POST /api/agents/v1/responses

Beide werden über API-Keys authentifiziert und unterstützen Streaming-Antworten, was es einfach macht, LibreChat-Agenten in bestehende Workflows zu integrieren, die bereits OpenAI SDKs oder ähnliche Tools verwenden.

LibreChat führt Open Responses als primäres API-Framework für die Bereitstellung von Agenten ein. Während der Chat Completions endpoint Abwärtskompatibilität mit bestehenden OpenAI-kompatiblen Tools bietet, stellt der Open Responses endpoint die zukünftige Ausrichtung dar.

Aktivieren der Agents API

Die Agents API ist hinter der remoteAgents Schnittstellenkonfiguration geschützt. Alle Berechtigungen sind standardmäßig auf false gesetzt.

interface:
  remoteAgents:
    use: true
    create: true

Siehe Interface Configuration — remoteAgents für alle verfügbaren Optionen.

Hinweis: Admin-Benutzer haben standardmäßig alle Berechtigungen für Remote-Agents aktiviert.

API Key Management

Sobald remoteAgents.use und remoteAgents.create aktiviert sind, können Benutzer API-Schlüssel über die LibreChat-Benutzeroberfläche generieren. Diese Schlüssel authentifizieren Anfragen an die Agents API.

Authentifizierung

Die Agents API unterstützt zwei Authentifizierungsmethoden, die unabhängig voneinander oder zusammen verwendet werden können.

API-Schlüssel

Die API-Schlüssel-Authentifizierung ist standardmäßig aktiviert. Generieren Sie API-Schlüssel über die LibreChat-Benutzeroberfläche, sobald remoteAgents.use und remoteAgents.create aktiviert sind.

Authorization: Bearer <YOUR_API_KEY>

OIDC Bearer Token

Für Machine-to-Machine-Szenarien, bei denen Ihre Infrastruktur bereits über einen OIDC-Anbieter verfügt, können Sie sich direkt mit OIDC-Bearer-Tokens ohne einen LibreChat API-Key authentifizieren.

Konfigurieren Sie die OIDC-Authentifizierung in librechat.yaml:

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

Rufen Sie dann die API mit Ihrem OIDC-Zugriffstoken auf:

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!"}'

Siehe Agents Endpoint - remoteApi für alle Konfigurationsoptionen.

Endpoints

Chat Completions (OpenAI-kompatibel)

POST /api/agents/v1/chat/completions

Verwenden Sie ein beliebiges OpenAI-kompatibles SDK, indem Sie es auf Ihre LibreChat-Instanz verweisen. Der model-Parameter entspricht einer Agenten-ID.

Beispiel mit 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
  }'

Beispiel mit 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="")

Modelle auflisten

GET /api/agents/v1/models

Gibt verfügbare Agents als Modelle zurück. Nützlich, um herauszufinden, welche Agents mit Ihrem API-Schlüssel zugänglich sind.

Open Responses API

POST /api/agents/v1/responses

Der Open Responses endpoint folgt der Open Responses specification, einem offenen Inferenzstandard, der von OpenAI initiiert und von der Open-Source-KI-Community entwickelt wurde. Er ist für agentenbasierte Workflows konzipiert und bietet native Unterstützung für Reasoning, Tool-Nutzung, strukturierte Ausgaben und das Streaming semantischer Ereignisse.

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?"
  }'

Token-Nutzungsverfolgung

Alle Agents API-Anfragen erfassen die Token-Nutzung basierend auf dem Guthaben des Benutzers (sofern die Token-Abrechnung konfiguriert ist). Sowohl Eingabe- als auch Ausgabe-Token werden gezählt, einschließlich Cache-Token für Anbieter, die diese unterstützen (OpenAI, Anthropic).

Roadmap

• Open Responses als primäre Schnittstelle — Wir planen, den Open Responses endpoint mit vollständiger Unterstützung für agentische Schleifen, Tool-Orchestrierung und semantische Streaming-Ereignisse zu erweitern.
• Anthropic Messages API — Wir werden möglicherweise in Zukunft die Unterstützung für das Anthropic Messages API-Format als zusätzliche Schnittstelle hinzufügen.

Zugehörige Dokumentation

• Agents — Erstellen und Konfigurieren von Agents
• Interface-Konfiguration — remoteAgents — Einstellungen zur Zugriffskontrolle
• Token Usage — Konfiguration von Token-Verbrauch und Guthaben
• Open Responses Specification — Der offene Inferenzstandard