@realtimex/sdk 1.7.28 → 2.0.1

package/skills/realtimex-moderator-sdk/references/api-reference/mcp.md

@@ -1,50 +0,0 @@
-# sdk.mcp — MCP Server Tools
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `MCPModule` *(extends ApiModule)*
-
-### Methods
-
-```ts
-super(realtimexUrl, appId, appName, apiKey): void
-
-// List configured MCP servers.
-async getServers(provider: 'local' | 'remote' | 'all' = 'all'): Promise<MCPServer[]>
-
-// List available tools for a specific MCP server.
-async getTools(serverName: string, provider: 'local' | 'remote' = 'local'): Promise<MCPTool[]>
-
-// Execute a tool on an MCP server.
-async executeTool(serverName: string, toolName: string, args: Record<string, any> = {}, provider: 'local' | 'remote' = 'local'): Promise<any>
-```
-
-## `MCPServer`
-
-```ts
-name: string
-display_name: string
-description: string | null
-server_type: string
-enabled: boolean
-provider: 'local' | 'remote'
-tags: string[]
-```
-
-## `MCPTool`
-
-```ts
-name: string
-description: string | null
-```
-
-## `MCPToolResult`
-
-```ts
-success: boolean
-server: string
-tool: string
-provider: string
-result: any
-error?: string
-```

package/skills/realtimex-moderator-sdk/references/api-reference/port.md

@@ -1,21 +0,0 @@
-# sdk.port — Port Management
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `PortModule`
-
-### Methods
-
-```ts
-// Get suggested port from environment (RTX_PORT) or default
-getSuggestedPort(): number
-
-// Check if a port is available on a specific host
-async isPortAvailable(port: number): Promise<boolean>
-
-// Find an available port starting from the suggested port
-async findAvailablePort(startPort?: number, maxAttempts: number = 100): Promise<number>
-
-// Get a ready-to-use port
-async getPort(): Promise<number>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/stt.md

@@ -1,15 +0,0 @@
-# sdk.stt — Speech-to-Text
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `STTModule` *(extends ApiModule)*
-
-### Methods
-
-```ts
-// Get available STT providers and their models.
-async listProviders(): Promise<STTProvider[]>
-
-// Listen to microphone and transcribe speech to text.
-async listen(options: STTListenOptions): Promise<STTResponse>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/task.md

@@ -1,62 +0,0 @@
-# sdk.task — Task Lifecycle Reporting
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `TaskModule`
-
-### Methods
-
-```ts
-// Configure callback signing behavior.
-configureContract(config: { callbackSecret?: string; signCallbacksByDefault?: boolean }): void
-
-// Claim a task before processing.
-async claim(taskUuid: string, options: TaskEventOptions = {}): Promise<TaskStatusResponse>
-
-// Alias for claim()
-async claimed(taskUuid: string, options: TaskEventOptions = {}): Promise<TaskStatusResponse>
-
-// Mark task as processing.
-async start(taskUuid: string, machineIdOrOptions?: string | TaskEventOptions): Promise<TaskStatusResponse>
-
-// Report incremental task progress.
-async progress(taskUuid: string, progressData: Record<string, unknown> = {}, options: TaskEventOptions = {}): Promise<TaskStatusResponse>
-
-// Mark task as completed with result.
-async complete(taskUuid: string, result: Record<string, unknown> = {}, machineIdOrOptions?: string | TaskEventOptions): Promise<TaskStatusResponse>
-
-// Mark task as failed with error.
-async fail(taskUuid: string, error: string, machineIdOrOptions?: string | TaskEventOptions): Promise<TaskStatusResponse>
-
-// Mark task as canceled.
-async cancel(taskUuid: string, reason?: string, options: TaskEventOptions = {}): Promise<TaskStatusResponse>
-```
-
-## `TaskStatusResponse`
-
-```ts
-success: boolean
-task_uuid: string
-status: string
-event_id?: string
-attempt_id?: string
-event_type?: ContractEventType | string
-deduplicated?: boolean
-duplicate?: boolean
-message?: string
-```
-
-## `TaskEventOptions`
-
-```ts
-machineId?: string
-attemptId?: string | number
-eventId?: string
-timestamp?: string
-callbackUrl?: string
-callbackSecret?: string
-sign?: boolean
-userEmail?: string
-activityId?: string
-tableName?: string
-```

package/skills/realtimex-moderator-sdk/references/api-reference/tts.md

@@ -1,18 +0,0 @@
-# sdk.tts — Text-to-Speech
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `TTSModule`
-
-### Methods
-
-```ts
-// Request a single permission from Electron via internal API
-async speak(text: string, options: TTSOptions = {}): Promise<ArrayBuffer>
-
-// Generate speech from text with streaming (yields decoded audio chunks)
-async *speakStream(text: string, options: TTSOptions = {}): AsyncGenerator<TTSChunk>
-
-// List available TTS providers with configuration options
-async listProviders(): Promise<TTSProvider[]>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-acpauth.md

@@ -1,21 +0,0 @@
-# sdk.v1.acpAuth — v1 Acp Auth
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1AcpAuthModule`
-
-### Methods
-
-```ts
-// @see GET /v1/acp/auth/profiles
-async listProfiles(): Promise<unknown>
-
-// @see POST /v1/acp/auth/profiles
-async createProfile(): Promise<unknown>
-
-// @see GET /v1/acp/auth/status
-async getStatus(): Promise<unknown>
-
-// @see DELETE /v1/acp/auth/profiles/{id}
-async deleteProfile(id: string): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-acpcommands.md

@@ -1,15 +0,0 @@
-# sdk.v1.acpCommands — v1 Acp Commands
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1AcpCommandsModule`
-
-### Methods
-
-```ts
-// @see POST /v1/acp/command
-async createCommand(): Promise<unknown>
-
-// @see POST /v1/acp/command/permission-decision
-async permissionDecision(): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-admin.md

@@ -1,48 +0,0 @@
-# sdk.v1.admin — v1 Admin
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1AdminModule`
-
-### Methods
-
-```ts
-// Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.
-async getIsMultiUserMode(): Promise<unknown>
-
-// Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.
-async listUsers(): Promise<unknown>
-
-// Create a new user with username and password. Methods are disabled until multi user mode is enabled via the UI.
-async createUser(body?: Record<string, unknown>): Promise<unknown>
-
-// Update existing user settings. Methods are disabled until multi user mode is enabled via the UI.
-async updateUser(id: string, body?: Record<string, unknown>): Promise<unknown>
-
-// Delete existing user by id. Methods are disabled until multi user mode is enabled via the UI.
-async deleteUser(id: string): Promise<unknown>
-
-// List all existing invitations to instance regardless of status. Methods are disabled until multi user mode is enabled via the UI.
-async listInvites(): Promise<unknown>
-
-// Create a new invite code for someone to use to register with instance. Methods are disabled until multi user mode is enabled via the UI.
-async createInvite(body?: Record<string, unknown>): Promise<unknown>
-
-// Deactivates (soft-delete) invite by id. Methods are disabled until multi user mode is enabled via the UI.
-async deleteInvite(id: string): Promise<unknown>
-
-// Retrieve a list of users with permissions to access the specified workspace.
-async listWorkspaceUsers(workspaceId: string): Promise<unknown>
-
-// Overwrite workspace permissions to only be accessible by the given user ids and admins. Methods are disabled until multi user mode is enabled via the UI.
-async updateUsers(workspaceId: string, body?: Record<string, unknown>): Promise<unknown>
-
-// Set workspace permissions to be accessible by the given user ids and admins. Methods are disabled until multi user mode is enabled via the UI.
-async workspacesManageUsers(workspaceSlug: string, body?: Record<string, unknown>): Promise<unknown>
-
-// All chats in the system ordered by most recent. Methods are disabled until multi user mode is enabled via the UI.
-async workspaceChats(body?: Record<string, unknown>): Promise<unknown>
-
-// Update multi-user preferences for instance. Methods are disabled until multi user mode is enabled via the UI.
-async createPreference(body?: Record<string, unknown>): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-auth.md

@@ -1,18 +0,0 @@
-# sdk.v1.auth — v1 Auth
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1AuthModule`
-
-### Methods
-
-```ts
-// Verify the attached Authentication header contains a valid API token.
-async getAuth(): Promise<unknown>
-
-// Relay external browser auth callbacks back to the local Electron renderer. Localhost only; keyed by OAuth state.
-async externalCallback(): Promise<unknown>
-
-// Poll for a relayed external browser auth callback by OAuth state. Localhost only.
-async getExternalCallback(state: string): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-channels.md

@@ -1,78 +0,0 @@
-# sdk.v1.channels — v1 Channels
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1ChannelsModule`
-
-### Methods
-
-```ts
-// List configured channel plugins without exposing encrypted plugin configuration.
-async listPlugins(): Promise<unknown>
-
-// Create a channel plugin. The request may include provider credentials in config, but credentials are never returned.
-async createPlugin(body?: Record<string, unknown>): Promise<unknown>
-
-// Get editable non-secret channel plugin configuration.
-async getConfig(id: string): Promise<unknown>
-
-// Update a channel plugin. Config values are encrypted before storage.
-async updatePlugin(id: string, body?: Record<string, unknown>): Promise<unknown>
-
-// Delete a channel plugin and stop any running plugin instance.
-async deletePlugin(id: string): Promise<unknown>
-
-// Enable and start a channel plugin.
-async pluginsStart(id: string): Promise<unknown>
-
-// Disable and stop a channel plugin.
-async pluginsStop(id: string): Promise<unknown>
-
-// Test channel provider credentials without saving a plugin.
-async pluginsTest(body?: Record<string, unknown>): Promise<unknown>
-
-// Get runtime status for all running channel plugins.
-async getStatus(): Promise<unknown>
-
-// Start a QR login flow for Zalo personal or WhatsApp plugins.
-async pluginsQrLoginStart(id: string, body?: Record<string, unknown>): Promise<unknown>
-
-// Poll QR login status for Zalo personal or WhatsApp plugins.
-async getState(id: string): Promise<unknown>
-
-// Cancel a QR login flow for Zalo personal or WhatsApp plugins.
-async pluginsQrLoginCancel(id: string): Promise<unknown>
-
-// Log out a QR-authenticated Zalo personal or WhatsApp plugin and clear stored credentials.
-async pluginsLogout(id: string): Promise<unknown>
-
-// Update safe channel policies for Zalo personal or WhatsApp plugins without overwriting credentials.
-async pluginsPolicies(id: string, body?: Record<string, unknown>): Promise<unknown>
-
-// Search a Zalo personal friends directory.
-async listDirectoryFriends(id: string): Promise<unknown>
-
-// Search a Zalo personal groups directory.
-async listDirectoryGroups(id: string): Promise<unknown>
-
-// List pending pairing codes for a channel plugin.
-async listPluginPairingCodes(id: string): Promise<unknown>
-
-// Generate a pairing code for a channel plugin.
-async pluginsPairingCodes(id: string, body?: Record<string, unknown>): Promise<unknown>
-
-// Approve a channel pairing code.
-async pairingCodesApprove(id: string): Promise<unknown>
-
-// Reject a channel pairing code.
-async pairingCodesReject(id: string): Promise<unknown>
-
-// List channel users for a plugin.
-async listPluginUsers(id: string): Promise<unknown>
-
-// Set authorization for a channel user.
-async pluginsUsersAuthorization(id: string, userId: string, body?: Record<string, unknown>): Promise<unknown>
-
-// Remove a channel user from a plugin.
-async deleteUser(id: string, userId: string): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-credentials.md

@@ -1,27 +0,0 @@
-# sdk.v1.credentials — v1 Credentials
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1CredentialsModule`
-
-### Methods
-
-```ts
-// @see POST /v1/credentials
-async createCredential(): Promise<unknown>
-
-// @see GET /v1/credentials
-async listCredentials(): Promise<unknown>
-
-// @see GET /v1/credentials/{id}
-async getCredential(id: string): Promise<unknown>
-
-// @see PUT /v1/credentials/{id}
-async replaceCredential(id: string): Promise<unknown>
-
-// @see DELETE /v1/credentials/{id}
-async deleteCredential(id: string): Promise<unknown>
-
-// @see POST /v1/credentials/{id}/restore
-async restore(id: string): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-customthemes.md

@@ -1,24 +0,0 @@
-# sdk.v1.customThemes — v1 Custom Themes
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1CustomThemesModule`
-
-### Methods
-
-```ts
-// @see GET /v1/custom-themes
-async listCustomThemes(): Promise<unknown>
-
-// @see GET /v1/custom-themes/{id}
-async getCustomTheme(id: string): Promise<unknown>
-
-// @see POST /v1/custom-themes/{id}
-async updateCustomTheme(id: string): Promise<unknown>
-
-// @see DELETE /v1/custom-themes/{id}
-async deleteCustomTheme(id: string): Promise<unknown>
-
-// @see POST /v1/custom-themes/new
-async createCustomTheme(): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-desktopbrowser.md

@@ -1,39 +0,0 @@
-# sdk.v1.desktopBrowser — v1 Desktop Browser
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1DesktopBrowserModule`
-
-### Methods
-
-```ts
-// List RealTimeX Browser sessions available in the Electron desktop app.
-async listSessions(): Promise<unknown>
-
-// Create a named RealTimeX Browser session in the Electron desktop app.
-async createSession(body?: Record<string, unknown>): Promise<unknown>
-
-// Get a specific RealTimeX Browser session by session name.
-async getSession(sessionName: string): Promise<unknown>
-
-// Delete a named RealTimeX Browser session from the Electron desktop app.
-async deleteSession(sessionName: string): Promise<unknown>
-
-// Create a RealTimeX Browser tab, optionally launching the browser session if needed.
-async createTab(body?: Record<string, unknown>): Promise<unknown>
-
-// Get a RealTimeX Browser tab snapshot by tab reference.
-async getTab(tabRef: string): Promise<unknown>
-
-// Close an existing RealTimeX Browser tab.
-async deleteTab(tabRef: string): Promise<unknown>
-
-// Evaluate JavaScript in a specific RealTimeX Browser tab.
-async evaluateTab(tabRef: string, body?: Record<string, unknown>): Promise<unknown>
-
-// Focus an existing RealTimeX Browser tab.
-async focusTab(tabRef: string, body?: Record<string, unknown>): Promise<unknown>
-
-// Navigate an existing RealTimeX Browser tab to a new URL.
-async navigateTab(tabRef: string, body?: Record<string, unknown>): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-desktopembed.md

@@ -1,24 +0,0 @@
-# sdk.v1.desktopEmbed — v1 Desktop Embed
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1DesktopEmbedModule`
-
-### Methods
-
-```ts
-// @see GET /v1/desktop-public-embed/status
-async getStatus(): Promise<unknown>
-
-// @see POST /v1/desktop-public-embed/exposures
-async createExposure(): Promise<unknown>
-
-// @see POST /v1/desktop-public-embed/exposures/{exposureId}/heartbeat
-async exposuresHeartbeat(exposureId: string): Promise<unknown>
-
-// @see GET /v1/desktop-public-embed/exposures/{exposureId}
-async getExposure(exposureId: string): Promise<unknown>
-
-// @see DELETE /v1/desktop-public-embed/exposures/{exposureId}
-async deleteExposure(exposureId: string): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-desktopruntimesessions.md

@@ -1,33 +0,0 @@
-# sdk.v1.desktopRuntimeSessions — v1 Desktop Runtime Sessions
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1DesktopRuntimeSessionsModule`
-
-### Methods
-
-```ts
-// Open the shared terminal launcher in the Electron desktop app.
-async openLauncher(body?: Record<string, unknown>): Promise<unknown>
-
-// Launch a local PTY-backed shell terminal in the Electron desktop app.
-async launchTerminalShell(body?: Record<string, unknown>): Promise<unknown>
-
-// Launch a local PTY-backed CLI agent terminal in the Electron desktop app.
-async launchTerminalCliAgent(body?: Record<string, unknown>): Promise<unknown>
-
-// List desktop PTY-backed runtime sessions currently known to the Electron app.
-async listRuntimeSessions(): Promise<unknown>
-
-// Fetch one desktop PTY-backed runtime session by runtime session ID or PTY session ID.
-async getRuntimeSession(sessionId: string): Promise<unknown>
-
-// Close an existing desktop runtime session.
-async deleteRuntimeSession(sessionId: string): Promise<unknown>
-
-// Write input to an existing desktop runtime session. Use `message` to submit a CLI turn or `input` for raw PTY data.
-async write(sessionId: string, body?: Record<string, unknown>): Promise<unknown>
-
-// Approve or deny a pending desktop runtime session action.
-async permission(sessionId: string, body?: Record<string, unknown>): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-document.md

@@ -1,39 +0,0 @@
-# sdk.v1.document — v1 Document
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1DocumentModule`
-
-### Methods
-
-```ts
-// Upload a new file to RealTimeX to be parsed and prepared for embedding.
-async uploadLink(body?: Record<string, unknown>): Promise<unknown>
-
-// Upload a file by specifying its raw text content and metadata values without having to upload a file.
-async rawText(body?: Record<string, unknown>): Promise<unknown>
-
-// List of all locally-stored documents in instance
-async listDocuments(): Promise<unknown>
-
-// Get all documents stored in a specific folder.
-async getFolder(folderName: string): Promise<unknown>
-
-// Check available filetypes and MIMEs that can be uploaded.
-async listAcceptedFileTypes(): Promise<unknown>
-
-// Get the known available metadata schema for when doing a raw-text upload and the acceptable type of value for each key.
-async getMetadataSchema(): Promise<unknown>
-
-// Get a single document by its unique RealTimeX document name
-async getDocument(docName: string): Promise<unknown>
-
-// Create a new folder inside the documents storage directory.
-async createFolder(body?: Record<string, unknown>): Promise<unknown>
-
-// Remove a folder and all its contents from the documents storage directory.
-async deleteRemoveFolder(): Promise<unknown>
-
-// Move files within the documents storage directory.
-async moveFiles(body?: Record<string, unknown>): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-embed.md

@@ -1,27 +0,0 @@
-# sdk.v1.embed — v1 Embed
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1EmbedModule`
-
-### Methods
-
-```ts
-// List all active embeds
-async getEmbed(): Promise<unknown>
-
-// Get all chats for a specific embed
-async listChats(embedUuid: string): Promise<unknown>
-
-// Get chats for a specific embed and session
-async getChat(embedUuid: string, sessionUuid: string): Promise<unknown>
-
-// Create a new embed configuration
-async createEmbed(body?: Record<string, unknown>): Promise<unknown>
-
-// Update an existing embed configuration
-async updateEmbed(embedUuid: string, body?: Record<string, unknown>): Promise<unknown>
-
-// Delete an existing embed configuration
-async deleteEmbed(embedUuid: string): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-openai.md

@@ -1,21 +0,0 @@
-# sdk.v1.openAI — v1 Open A I
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1OpenAIModule`
-
-### Methods
-
-```ts
-// Get all available "models" which are workspaces you can use for chatting.
-async listModels(): Promise<unknown>
-
-// Execute a chat with a workspace with OpenAI compatibility. Supports streaming as well. Model must be a workspace slug from /models.
-async chatCompletions(body?: Record<string, unknown>): Promise<unknown>
-
-// Get the embeddings of any arbitrary text string. This will use the embedder provider set in the system. Please ensure the token length of each string fits within the context of your embedder model.
-async createEmbedding(body?: Record<string, unknown>): Promise<unknown>
-
-// List all the vector database collections connected to RealTimeX. These are essentially workspaces but return their unique vector db identifier - this is the same as the workspace slug.
-async listVectorStores(): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-sttapi.md

@@ -1,12 +0,0 @@
-# sdk.v1.sttApi — v1 Stt Api
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1SttApiModule`
-
-### Methods
-
-```ts
-// @see POST /v1/stt/groq/transcribe
-async groqTranscribe(body?: Record<string, unknown>): Promise<unknown>
-```

package/skills/realtimex-moderator-sdk/references/api-reference/v1-system.md

@@ -1,36 +0,0 @@
-# sdk.v1.system — v1 System
-
-> Auto-generated from `@realtimex/sdk` source · v**1.7.28** · 2026-06-02
-
-## `V1SystemModule`
-
-### Methods
-
-```ts
-// Dump all settings to file storage
-async getEnvDump(): Promise<unknown>
-
-// Get all current system settings that are defined.
-async getSystem(): Promise<unknown>
-
-// Number of all vectors in connected vector database
-async getVectorCount(): Promise<unknown>
-
-// Update a system setting or preference.
-async updateEnv(body?: Record<string, unknown>): Promise<unknown>
-
-// Export all of the chats from the system in a known format. Output depends on the type sent. Will be send with the correct header for the output.
-async listExportChats(): Promise<unknown>
-
-// Permanently remove documents from the system.
-async deleteRemoveDocument(): Promise<unknown>
-
-// Returns a health check object with server uptime and version.
-async getHealth(): Promise<unknown>
-
-// Returns a health check object with server uptime and version.
-async getHealthVersion2(): Promise<unknown>
-
-// Returns a health check object with server uptime and version.
-async getHealthVersion3(): Promise<unknown>
-```