Endpoint
Returns a list of all backend functions discovered and loaded by the NAVAI runtime. These functions are dynamically discovered from your codebase based on NAVAI_FUNCTIONS_FOLDERS configuration.
Authentication
No authentication required. This endpoint is public by default.
No special headers required.
Query Parameters
None.
Response
Array of function definitions available for executionNormalized function name in snake_case lowercase format
Human-readable description of the function
Source file path and export name in format path/to/file.ts#exportName
Array of warning messages from runtime discovery and function loading. Empty if no issues occurred.
Example Request
curl http://localhost:3000/navai/functions
Example Response
{
"items": [
{
"name": "secret_password",
"description": "Call exported function default.",
"source": "src/ai/functions-modules/security.ts#default"
},
{
"name": "get_weather",
"description": "Fetch current weather data for a location.",
"source": "src/ai/functions-modules/weather.ts#getWeather"
},
{
"name": "send_email",
"description": "Send an email notification.",
"source": "src/features/notifications/voice-functions/email.ts#sendEmail"
}
],
"warnings": []
}
Example Response with Warnings
{
"items": [
{
"name": "example_function",
"description": "Call exported function default.",
"source": "src/ai/functions-modules/example.ts#default"
}
],
"warnings": [
"Function name collision: 'getUser' already exists, renamed to 'get_user_2'",
"Configured folders matched nothing, falling back to default: src/ai/functions-modules"
]
}
Error Responses
500 - Runtime Loading Error
{
"error": "Failed to load functions runtime: ..."
}
Function Discovery
Functions are discovered from directories specified in NAVAI_FUNCTIONS_FOLDERS environment variable or registration options.
Supported Folder Patterns
- Folder:
src/ai/functions-modules
- Recursive folder:
src/ai/functions-modules/...
- Wildcard:
src/features/*/voice-functions
- Explicit file:
src/ai/functions-modules/security.ts
- CSV list:
src/ai/functions-modules,...
Default Folder
If no configuration is provided, defaults to src/ai/functions-modules.
Excluded Paths
By default, these patterns are excluded:
node_modulesdist- Hidden files/folders (starting with
.)
- TypeScript declaration files (
*.d.ts)
Export-to-Function Mapping
The runtime transforms module exports into callable functions:
1. Exported Function
Creates one function tool.
// src/ai/functions-modules/weather.ts
export default function getWeather(location: string) {
return { temperature: 72, condition: "sunny" };
}
{
"name": "get_weather",
"source": "src/ai/functions-modules/weather.ts#default"
}
2. Exported Class
Creates one function per callable instance method.
// src/ai/functions-modules/database.ts
export class DatabaseClient {
query(sql: string) { /* ... */ }
insert(data: object) { /* ... */ }
}
[
{
"name": "database_client_query",
"source": "src/ai/functions-modules/database.ts#DatabaseClient.query"
},
{
"name": "database_client_insert",
"source": "src/ai/functions-modules/database.ts#DatabaseClient.insert"
}
]
3. Exported Object
Creates one function per callable member.
// src/ai/functions-modules/utils.ts
export const utils = {
formatDate: (date: Date) => { /* ... */ },
parseJson: (json: string) => { /* ... */ }
};
[
{
"name": "utils_format_date",
"source": "src/ai/functions-modules/utils.ts#utils.formatDate"
},
{
"name": "utils_parse_json",
"source": "src/ai/functions-modules/utils.ts#utils.parseJson"
}
]
Name Normalization
- Function names are converted to snake_case lowercase
- Unsafe characters are removed
- Name collisions append suffix:
_2, _3, etc.
- Warnings are emitted for all renames
Runtime Behavior
- Function runtime is lazy-loaded on first request
- Runtime is cached in-memory after initial load
- File changes require process restart to take effect
- Both
GET /navai/functions and POST /navai/functions/execute share the same runtime instance
Configuration
Control function discovery with RegisterNavaiExpressRoutesOptions:
registerNavaiExpressRoutes(app, {
includeFunctionsRoutes: true, // Enable functions routes
functionsListPath: "/navai/functions", // Custom path
functionsBaseDir: process.cwd(), // Base directory for scanning
functionsFolders: "src/ai/functions-modules", // Folders to scan
includeExtensions: ["ts", "js", "mjs"], // File extensions
exclude: ["node_modules", "dist"] // Exclude patterns
});
Environment Variables
NAVAI_FUNCTIONS_FOLDERS: Comma-separated list of folders/patterns to scanNAVAI_FUNCTIONS_BASE_DIR: Base directory for relative paths (default: process.cwd())
Implementation
Implemented in packages/voice-backend/src/index.ts:282-296 via registerNavaiExpressRoutes.