Skip to main content

Pipeline Responses

AssistantPipelineResponse

interface AssistantPipelineResponse {
  mode: "assistant" | "dictation";
  selectionRewrite: boolean;
  selectionPending: boolean;
  selectionContextCleared: boolean;
  selectionContextUsed: boolean;
  transcript: string;
  assistantResponse: string;
  audioBase64: string;
  sttLatencyMs: number;
  aiLatencyMs: number;
  ttsLatencyMs: number;
  totalLatencyMs: number;
}
Complete response from the assistant processing pipeline.
mode
string
Pipeline mode: "assistant" (AI response) or "dictation" (transcription only)
selectionRewrite
boolean
Whether the request was to rewrite selected text
selectionPending
boolean
Selection popup is awaiting user action
selectionContextCleared
boolean
Previously stored selection context was cleared
selectionContextUsed
boolean
Selection context was used in the request
transcript
string
Transcribed text from speech input
assistantResponse
string
AI-generated response text
audioBase64
string
Base64-encoded TTS audio output
sttLatencyMs
number
Speech-to-text processing time in milliseconds
aiLatencyMs
number
AI model inference time in milliseconds
ttsLatencyMs
number
Text-to-speech generation time in milliseconds
totalLatencyMs
number
Total pipeline latency in milliseconds

System Information

AssistantInfoResponse

interface AssistantInfoResponse {
  appVersion: string;
  baseUrl: string;
  sttModel: string;
  aiModel: string;
  piperInstalled: boolean;
  piperPath: string;
  voiceInstalled: boolean;
  voiceModelPath: string;
  coquiInstalled: boolean;
  coquiPythonPath: string;
}
System configuration and installation status.
appVersion
string
Application version number
baseUrl
string
API base URL
sttModel
string
Active STT model name
aiModel
string
Active AI model name
piperInstalled
boolean
Piper TTS installation status
piperPath
string
Path to Piper executable
voiceInstalled
boolean
Voice model installation status
voiceModelPath
string
Path to voice model files
coquiInstalled
boolean
Coqui TTS installation status
coquiPythonPath
string
Path to Python with Coqui

AppUpdateCheckResponse

interface AppUpdateCheckResponse {
  currentVersion: string;
  latestVersion: string;
  available: boolean;
  releaseName: string;
  releaseNotes: string;
  publishedAt: string;
  releaseUrl: string;
  installerDownloadUrl: string;
  installerAssetName: string;
}
Application update availability and details.
currentVersion
string
Currently installed version
latestVersion
string
Latest available version
available
boolean
Whether an update is available
releaseName
string
Name of the latest release
releaseNotes
string
Markdown-formatted release notes
publishedAt
string
ISO 8601 publication timestamp
releaseUrl
string
GitHub release page URL
installerDownloadUrl
string
Direct download URL for installer
installerAssetName
string
Installer file name

Local STT Responses

LocalSttDownloadStatusResponse

interface LocalSttDownloadStatusResponse {
  active: boolean;
  completed: boolean;
  success: boolean;
  model: string;
  repoId: string;
  stage: string;
  message: string;
  currentFile: string;
  downloadedBytes: number;
  totalBytes: number;
  filesCompleted: number;
  filesTotal: number;
  progressPercent: number;
  updatedAtMs: number;
}
Real-time download progress for local STT models.
active
boolean
Download is currently in progress
completed
boolean
Download has finished (success or failure)
success
boolean
Download completed successfully
model
string
Model identifier
repoId
string
Repository ID (e.g., Hugging Face)
stage
string
Current stage (e.g., “downloading”, “extracting”)
message
string
Human-readable status message
currentFile
string
File currently being downloaded
downloadedBytes
number
Bytes downloaded so far
totalBytes
number
Total size in bytes
filesCompleted
number
Number of files completed
filesTotal
number
Total number of files
progressPercent
number
Overall progress (0-100)
updatedAtMs
number
Last update timestamp (milliseconds)

LocalSttHardwareAdviceResponse

interface LocalSttHardwareAdviceResponse {
  cpuName: string;
  logicalCores: number;
  totalRamGb: number;
  nvidiaGpuDetected: boolean;
  gpuName: string;
  gpuVramGb: number;
  performanceTier: string;
  slasshySuggestionModel: string;
  suggestedModels: string[];
  cautionModels: string[];
  selectedModelWarning: string;
  details: string;
}
Hardware detection and model recommendations.
cpuName
string
CPU model name
logicalCores
number
Number of logical CPU cores
totalRamGb
number
Total system RAM in GB
nvidiaGpuDetected
boolean
NVIDIA GPU availability
gpuName
string
GPU model name
gpuVramGb
number
GPU VRAM in GB
performanceTier
string
System performance tier (low/medium/high)
slasshySuggestionModel
string
Primary recommended model
suggestedModels
string[]
List of recommended models
cautionModels
string[]
Models that may have performance issues
selectedModelWarning
string
Warning message if selected model is problematic
details
string
Additional hardware details

LocalSttDownloadResponse

interface LocalSttDownloadResponse {
  model: string;
  provider: string;
  method: string;
  localPath: string;
  details: string;
}
model
string
Downloaded model identifier
provider
string
Model provider (e.g., “huggingface”)
method
string
Download method used
localPath
string
Local filesystem path
details
string
Additional information

LocalSttDeleteResponse

interface LocalSttDeleteResponse {
  model: string;
  repoId: string;
  removed: boolean;
  localPath: string;
  details: string;
}
model
string
Model identifier
repoId
string
Repository ID
removed
boolean
Whether removal was successful
localPath
string
Path that was removed
details
string
Operation details

LocalSttOpenPathResponse

interface LocalSttOpenPathResponse {
  model: string;
  repoId: string;
  localPath: string;
  opened: boolean;
  details: string;
}
model
string
Model identifier
repoId
string
Repository ID
localPath
string
Path to open
opened
boolean
Whether path was opened successfully
details
string
Operation details

LocalSttWarmupResponse

interface LocalSttWarmupResponse {
  model: string;
  provider: string;
  warmed: boolean;
  details: string;
}
model
string
Model identifier
provider
string
Model provider
warmed
boolean
Whether warmup was successful
details
string
Warmup details

LocalSttDeactivateResponse

interface LocalSttDeactivateResponse {
  model: string;
  provider: string;
  deactivated: boolean;
  details: string;
}
model
string
Model identifier
provider
string
Model provider
deactivated
boolean
Whether deactivation was successful
details
string
Deactivation details

LocalSttRuntimeStateResponse

interface LocalSttRuntimeStateResponse {
  loaded: boolean;
  daemonCount: number;
  loadedDaemonCount: number;
  details: string;
}
loaded
boolean
Whether STT runtime is loaded
daemonCount
number
Total number of daemon processes
loadedDaemonCount
number
Number of loaded daemon processes
details
string
Runtime state details

Ollama Responses

OllamaStatusResponse

interface OllamaStatusResponse {
  installed: boolean;
  running: boolean;
  version: string;
  details: string;
}
Ollama installation and runtime status.
installed
boolean
Whether Ollama is installed
running
boolean
Whether Ollama service is running
version
string
Ollama version string
details
string
Additional status information

OllamaPullResponse

interface OllamaPullResponse {
  baseUrl: string;
  model: string;
  ok: boolean;
  status: string;
}
Result of pulling an Ollama model.
baseUrl
string
Ollama server URL
model
string
Model name that was pulled
ok
boolean
Whether pull was successful
status
string
Status message

ProviderModelsResponse

interface ProviderModelsResponse {
  baseUrl: string;
  models: string[];
}
baseUrl
string
Provider API base URL
models
string[]
Available model identifiers

TTS Responses

CoquiStatusResponse

interface CoquiStatusResponse {
  available: boolean;
  pythonPath: string;
  ttsVersion: string;
  cudaAvailable: boolean;
  voiceDir: string;
  voices: string[];
  defaultModel: string;
  error: string;
}
Coqui TTS installation and configuration status.
available
boolean
Whether Coqui TTS is available
pythonPath
string
Path to Python with Coqui installed
ttsVersion
string
Coqui TTS version string
cudaAvailable
boolean
Whether CUDA GPU acceleration is available
voiceDir
string
Directory containing voice models
voices
string[]
Available voice IDs
defaultModel
string
Default Coqui model name
error
string
Error message if unavailable

CoquiSetupResponse

interface CoquiSetupResponse {
  pythonPath: string;
  details: string;
}
pythonPath
string
Path to configured Python
details
string
Setup details

CoquiValidationResponse

interface CoquiValidationResponse {
  ok: boolean;
  details: string;
}
ok
boolean
Whether validation passed
details
string
Validation details or error message

CoquiVoicesResponse

interface CoquiVoicesResponse {
  voiceDir: string;
  voices: string[];
}
voiceDir
string
Voice directory path
voices
string[]
List of available voice IDs

CoquiModelsResponse

interface CoquiModelsResponse {
  models: string[];
}
models
string[]
Available Coqui TTS models

CoquiVoiceCloneResponse

interface CoquiVoiceCloneResponse {
  speakerId: string;
  durationSeconds: number;
  voiceDir: string;
  voices: string[];
  previewAudioBase64: string;
}
Result of voice cloning operation.
speakerId
string
Generated speaker/voice ID
durationSeconds
number
Duration of reference audio used
voiceDir
string
Directory where voice is stored
voices
string[]
Updated list of available voices
previewAudioBase64
string
Base64-encoded preview audio

CoquiVoicePreviewResponse

interface CoquiVoicePreviewResponse {
  audioBase64: string;
  text: string;
}
audioBase64
string
Base64-encoded preview audio
text
string
Text that was synthesized

PiperValidationResponse

interface PiperValidationResponse {
  ok: boolean;
  details: string;
}
ok
boolean
Whether Piper validation passed
details
string
Validation details or error message

RuntimeSetupResponse

interface RuntimeSetupResponse {
  piperPath: string;
  voiceModelPath: string;
}
piperPath
string
Path to Piper executable
voiceModelPath
string
Path to voice model files

VoiceInstallResponse

interface VoiceInstallResponse {
  modelPath: string;
}
modelPath
string
Path where voice model was installed

TtsSetupStatusResponse

interface TtsSetupStatusResponse {
  running: boolean;
  completed: boolean;
  success: boolean;
  stage: string;
  logs: string[];
}
Status of TTS setup process.
running
boolean
Setup is currently running
completed
boolean
Setup has finished
success
boolean
Setup completed successfully
stage
string
Current setup stage
logs
string[]
Setup log messages

Build docs developers (and LLMs) love