mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-04-07 00:15:23 +02:00
117 lines
3.2 KiB
JavaScript
117 lines
3.2 KiB
JavaScript
/**
|
|
* OpenAI-compatible API routes for LibreChat agents.
|
|
*
|
|
* Provides a /v1/chat/completions compatible interface for
|
|
* interacting with LibreChat agents remotely via API.
|
|
*
|
|
* Usage:
|
|
* POST /v1/chat/completions - Chat with an agent
|
|
* GET /v1/models - List available agents
|
|
* GET /v1/models/:model - Get agent details
|
|
*
|
|
* Request format:
|
|
* {
|
|
* "model": "agent_id_here",
|
|
* "messages": [{"role": "user", "content": "Hello!"}],
|
|
* "stream": true
|
|
* }
|
|
*/
|
|
const express = require('express');
|
|
const { PermissionTypes, Permissions } = require('librechat-data-provider');
|
|
const {
|
|
generateCheckAccess,
|
|
createRequireApiKeyAuth,
|
|
createRemoteAgentAuth,
|
|
createCheckRemoteAgentAccess,
|
|
} = require('@librechat/api');
|
|
const {
|
|
OpenAIChatCompletionController,
|
|
ListModelsController,
|
|
GetModelController,
|
|
} = require('~/server/controllers/agents/openai');
|
|
const { getEffectivePermissions } = require('~/server/services/PermissionService');
|
|
const { configMiddleware } = require('~/server/middleware');
|
|
const { getAppConfig } = require('~/server/services/Config');
|
|
const db = require('~/models');
|
|
|
|
const router = express.Router();
|
|
|
|
const apiKeyMiddleware = createRequireApiKeyAuth({
|
|
validateAgentApiKey: db.validateAgentApiKey,
|
|
findUser: db.findUser
|
|
});
|
|
|
|
const requireRemoteAgentAuth = createRemoteAgentAuth({
|
|
apiKeyMiddleware,
|
|
findUser: db.findUser,
|
|
updateUser: db.updateUser,
|
|
getAppConfig,
|
|
});
|
|
|
|
const checkRemoteAgentsFeature = generateCheckAccess({
|
|
permissionType: PermissionTypes.REMOTE_AGENTS,
|
|
permissions: [Permissions.USE],
|
|
getRoleByName: db.getRoleByName,
|
|
});
|
|
|
|
const checkAgentPermission = createCheckRemoteAgentAccess({
|
|
getAgent: db.getAgent,
|
|
getEffectivePermissions,
|
|
});
|
|
|
|
router.use(requireRemoteAgentAuth);
|
|
router.use(configMiddleware);
|
|
router.use(checkRemoteAgentsFeature);
|
|
|
|
/**
|
|
* @route POST /v1/chat/completions
|
|
* @desc OpenAI-compatible chat completions with agents
|
|
* @access Private (API key auth required)
|
|
*
|
|
* Request body:
|
|
* {
|
|
* "model": "agent_id", // Required: The agent ID to use
|
|
* "messages": [...], // Required: Array of chat messages
|
|
* "stream": true, // Optional: Whether to stream (default: false)
|
|
* "conversation_id": "...", // Optional: Conversation ID for context
|
|
* "parent_message_id": "..." // Optional: Parent message for threading
|
|
* }
|
|
*
|
|
* Response (streaming):
|
|
* - SSE stream with OpenAI chat.completion.chunk format
|
|
* - Includes delta.reasoning for thinking/reasoning content
|
|
*
|
|
* Response (non-streaming):
|
|
* - Standard OpenAI chat.completion format
|
|
*/
|
|
router.post('/chat/completions', checkAgentPermission, OpenAIChatCompletionController);
|
|
|
|
/**
|
|
* @route GET /v1/models
|
|
* @desc List available agents as models
|
|
* @access Private (API key auth required)
|
|
*
|
|
* Response:
|
|
* {
|
|
* "object": "list",
|
|
* "data": [
|
|
* {
|
|
* "id": "agent_id",
|
|
* "object": "model",
|
|
* "name": "Agent Name",
|
|
* "provider": "openai",
|
|
* ...
|
|
* }
|
|
* ]
|
|
* }
|
|
*/
|
|
router.get('/models', ListModelsController);
|
|
|
|
/**
|
|
* @route GET /v1/models/:model
|
|
* @desc Get details for a specific agent/model
|
|
* @access Private (API key auth required)
|
|
*/
|
|
router.get('/models/:model', GetModelController);
|
|
|
|
module.exports = router;
|