@open-wa/integration-voxtral

Source: integrations/voxtral/README.md

The official Easy API plugin for conversational WhatsApp voice notes and live audio calls. Set MISTRAL_API_KEY, install the package next to @open-wa/wa-automate, and add it to your configuration:

export default {
  sessionId: 'voice-assistant',
  host: '127.0.0.1',
  port: 8080,
  dashboard: true,
  licenseKey: process.env.OPENWA_LICENSE_KEY,
  plugins: ['@open-wa/integration-voxtral'],
  pluginConfig: {
    voxtral: {
      mode: 'both',
      agent: {
        instructions: [
          'You are a patient language tutor.',
          'Help the learner practise through short conversations.',
          'Correct mistakes gently and ask one question at a time.',
        ],
      },
    },
  },
};

npx @open-wa/wa-automate --config ./config.js

Open a person in Neo's normal Chat view for voice transcripts, replies, delivery states, call turns, and pause/takeover controls. Open /dashboard/plugins/voxtral to edit the assistant, choose Voice notes, Calls, or Both, preview a voice, and view usage. Its conversation list opens the same Chat feed. Calling requires an OpenWA calling-enabled license. Audio encoding is included through ffmpeg-static; a system FFmpeg installation is not required.

Instructions accept either a string or an array. The plugin handles joining, nested defaults, and environment-key lookup. Dashboard changes are saved as per-session overrides; reset them to return to config.js settings. Credentials are never included in dashboard responses or saved overrides.

Recent conversation text stays in memory for 30 minutes of inactivity by default. Raw audio and call recordings are not saved. Local settings, pause choices, bounded send journals, and usage counters live under .open-wa/plugins/voxtral/. Audio and conversation text used for responses go to your Mistral account.

The plugin page is an ES module supplied by this package. Neo supplies its React instance, BoardUI components, authenticated requests, privacy controls, and the shared call controller. Its chat.js module contributes to the existing Chat toolbar and timeline through the same host, with transcripts attached to their original WhatsApp messages where available.

See the guide and implementation contract.