Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Agents API (Beta)

通过兼容 OpenAI 和 Open Responses API 的端点以编程方式访问 LibreChat 智能体

测试版功能

Agents API 目前处于测试阶段。随着我们向稳定版本迭代,endpoint、请求/响应格式以及行为可能会发生变化。

LibreChat 通过两个兼容 API 的接口公开您的智能体,允许外部应用程序、脚本和服务以编程方式与您的智能体进行交互。

概述

Agents API 提供了两个接口:

  • 兼容 OpenAI 的聊天补全 (Chat Completions)POST /api/agents/v1/chat/completions
  • Open Responses APIPOST /api/agents/v1/responses

两者均通过 API keys 进行身份验证并支持流式响应,这使得将 LibreChat 智能体集成到已使用 OpenAI SDK 或类似工具的现有工作流程中变得非常简单。

LibreChat 正在采用 Open Responses 作为其服务智能体的首选 API 框架。虽然 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.useremoteAgents.create,用户即可从 LibreChat UI 生成 API 密钥。这些密钥用于对发送至 Agents API 的请求进行身份验证。

Endpoints

聊天补全 (OpenAI-compatible)

POST /api/agents/v1/chat/completions

通过将任何兼容 OpenAI 的 SDK 指向您的 LibreChat 实例来使用它。model 参数对应于一个 agent 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/responses

Open Responses endpoint 遵循 Open Responses specification,这是一个由 OpenAI 发起并由开源 AI 社区构建的开放推理标准。它专为代理工作流设计,原生支持推理、工具使用、结构化输出以及流式语义事件。

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 Usage Tracking

所有 Agents API 请求都会根据用户的余额跟踪令牌使用情况(如果已配置令牌消费)。输入和输出令牌都会被计算在内,包括支持缓存令牌的提供商(OpenAI、Anthropic)的缓存令牌。

路线图

  • Open Responses 作为主要接口 — 我们计划扩展 Open Responses endpoint,以全面支持代理循环(agentic loops)、工具编排以及流式语义事件。
  • Anthropic Messages API — 我们未来可能会增加对 Anthropic Messages API 格式的支持,作为一种额外的接口。

这篇指南怎么样?