API Reference

API Tokens

Function	Description
createAPIToken	Create a new API token for programmatic access
deleteAPIToken	Delete an API token
listAPITokens	List all API tokens for the current user

Applications

Function	Description
createConfiguration	Create a new application configuration
getConfiguration	Get configuration for an application
getExpertApplications	Get applications associated with a specific expert
listApplications	List all available applications
searchApplications	Search applications by name or other criteria
updateApplication	Update an application's configuration or status
updateConfiguration	Update an existing application configuration

Authentication

Function	Description
authenticateUser	Authenticate user with username and password
getSession	Get current session information including user details and token expiry
refreshToken	Refresh the access token using a refresh token
signOutUser	Sign out the current user and invalidate the session
validateToken	Validate the current access token

Categories

Function	Description
createCategory	Create a new category for organizing users or content
deleteCategory	Delete a category by ID
getUserCategories	Get categories assigned to a specific user
listCategories	List all available categories

Chat

Variable	Description
chat	Chat module with completion methods Access via chat.complete() and chat.stream()

Chat Management

Function	Description
addExpertToChat	Add an expert to a chat
deleteChat	Delete a chat
getChat	Get a chat by ID
listChats	List all chats for the current user
removeExpertFromChat	Remove an expert from a chat
updateChat	Update a chat's properties

Company

Function	Description
createModelRegistry	Register a new AI model in the company registry
deleteModelRegistry	Delete a model from the registry
getCompany	Get company information
getCompanyConfiguration	Get company configuration settings
getCompanyLicenses	Get company licenses
getCompanyLogo	Get company logo by company ID
getCompanyModels	Get available AI models for the company
getExpertModelConfig	Get model configuration for a specific expert
getMaintenanceMode	Get current maintenance mode status
setCompanyConfiguration	Set company configuration settings
setMaintenanceMode	Enable or disable maintenance mode
updateCompany	Update company information
updateModelRegistry	Update a model in the registry

Configuration

Name	Description
CyberPod	CyberPod SDK Class - Alternative to global functions
initSDK	Initialize the SDK with full configuration options
setBaseUrl	Set the base URL for API requests (required before any API calls)

Core

Variable	Description
VERSION	SDK version

Dashboard

Function	Description
createMongoDBRecord	Create a MongoDB record
getActiveUsers	Get active users data
getDashboardOverview	Get dashboard overview with summary statistics
getDashboardTaskHistory	Get task history for the dashboard
getDashboardTaskStats	Get task statistics for dashboard
getExpertStats	Get expert usage statistics
getTopOrganizations	Get top organizations by usage
getTotalChats	Get total chats statistics
getUserActivityStats	Get user activity statistics
searchDashboard	Search across dashboard data
updateMongoDBRecord	Update a MongoDB record

Files

Function	Description
deleteFile	Delete a file by ID
downloadFiles	Download one or more files
getExistingFilters	Get existing filter options for file search (file types, date ranges, etc.)
getFileById	Get file information by ID
getFoldersAndFiles	Get folders and files in a hierarchical structure
getTotalFilesCount	Get the total count of files for the current user
getUploadStatus	Get the upload/processing status of a file
moveFileToFolder	Move a file to a different folder
searchFiles	Search files by query and optional filters
shareFiles	Share files with other users
uploadFile	Upload a file to the system

Folders

Function	Description
createFolder	Create a new folder for organizing files
deleteFolder	Delete a folder by ID
deleteFolders	Delete multiple folders at once
listFolders	List folders with optional parent filter and pagination

Graphs

Function	Description
deleteGraph	Delete a graph by ID
expandNodes	Expand nodes in the graph
getChunkStats	Get statistics about chunks in the system
listGraphs	List all graphs for the current user
loadGraph	Load a specific graph by ID
queryGraph	Query the graph
saveGraph	Save a graph with name and data
shareGraph	Share a graph with another user

MCP Servers

Function	Description
createMCPServer	Create a new MCP server configuration
deleteMCPServer	Delete an MCP server
executeMCPTool	Execute an MCP tool
getAllMCPTools	Get all available MCP tools across all servers
getMCPServer	Get MCP server by ID
getMCPServerTools	Get tools available on a specific MCP server
listMCPServers	List all MCP (Model Context Protocol) servers
updateMCPServer	Update an MCP server configuration

Notifications

Function	Description
archiveNotifications	Archive multiple notifications
bulkNotificationAction	Perform bulk actions on notifications (restore or delete multiple)
clearAllNotifications	Clear all notifications (inbox, archived, or both)
deleteNotification	Delete a single notification by ID
getArchivedNotifications	Get archived notifications for the current user
getNotifications	Get inbox notifications for the current user
markNotificationRead	Mark a notification as read or unread
restoreAllNotifications	Restore all archived notifications back to inbox

Other

default

Renames and re-exports CyberPod

Projects

Function	Description
addFilesToProject	Add files to a project
createProject	Create a new project
createProjectChat	Create a new chat within a project
deleteProject	Delete a project
deleteProjectChat	Delete a chat from a project
deleteProjectMemories	Delete all memories associated with a project
getChatMessages	Get messages from a project chat
getProject	Get a project by ID
listProjectChats	List all chats within a project
listProjects	List all projects for the current user
projectChatCompletion	Send a chat completion request in a project context
removeExpertFromProject	Remove an expert from a project
removeFileFromProject	Remove a file from a project
shareProject	Share a project with other users
updateProject	Update a project

Secrets

Function	Description
createSecret	Create a new secret
deleteSecret	Delete a secret
getSecret	Get secret metadata by ID
listSecrets	List all secrets for the current user
resolveSecret	Resolve a secret value by key name
updateSecret	Update an existing secret

Users

Function	Description
addCategoriesToUser	Add categories to a user (admin only)
addExpert	Add expert to current user's profile
createUser	Create a new user (admin only)
deleteAccount	Delete the current user's account
getDeprecatedUsers	Get list of deprecated/deactivated users
getListUsers	Get a simple list of all users
getUser	Get the current authenticated user's profile
getUserActivity	Get user activity logs within a date range
getUserById	Get a user by ID
getUserFiles	Get files belonging to a specific user
listUsers	List all users with pagination and filters (admin only)
resetOwnPassword	Reset own password
resetUserPassword	Reset a user's password (admin only)
updateUser	Update the current user's profile
updateUserById	Update a user by ID (admin only)
updateUserStatus	Update a user's status (admin only)