Skip to content

Configuration

Persyk is configured via a JSON file. A JSON Schema file is automatically created alongside your settings, enabling autocomplete and validation in editors like VS Code.

Settings are stored in the application data directory:

PlatformPath
macOS~/Library/Application Support/persyk/settings.json
Windows%APPDATA%\persyk\settings.json
Linux~/.config/persyk/settings.json

Note: Persyk has only been tested on macOS. If you encounter issues on Windows or Linux, please open an issue.

Press CmdOrControl+, from the system tray menu to open the settings file in your default editor.

Settings are not automatically applied when you save the file. To reload settings after editing:

  • Press CmdOrControl+R from the system tray menu

Note: If you notice unexpected behavior after changing settings, try restarting the app. If issues persist, please create an issue describing the behavior.

For detailed information on all available configuration options, see the Configuration Reference Page (autogenerated from the JSON schema).

{
"$schema": "./settings.schema.json",
"providers": {
"openai": {
"type": "openai-compatible",
"baseUrl": "https://api.openai.com/v1",
"apiKey": "sk-..."
},
"local-whisper": {
"type": "openai-compatible",
"baseUrl": "http://localhost:8000/v1",
"apiKey": null
}
},
"transcription": {
"enabled": true,
"provider": "openai",
"model": "whisper-1",
"copyToClipboard": true,
"notifications": true,
"requestOptions": {
"language": "en",
"prompt": "Technical discussion about software development",
"temperature": 0
},
"formatting": {
"enabled": true,
"provider": "openai",
"model": "gpt-4o-mini",
"prompt": "Clean up this transcription:\n\n{{TRANSCRIPTION}}"
}
},
"webhooks": {
"transcription-complete": {
"enabled": true,
"url": "https://your-service.com/webhook",
"headers": {
"Authorization": "Bearer your-token"
}
}
}
}