Skip to main content

WhatsApp integration for Agntrick agents

Project description

agntrick-whatsapp

WhatsApp integration for Agntrick agents.

Installation

pip install agntrick-whatsapp

Or with the core package:

pip install agntrick[whatsapp]

Features

  • WhatsApp Channel: Bidirectional communication via personal WhatsApp account
  • Router Agent: Routes messages to different specialist modes based on commands
  • Audio Transcription: Transcribe voice messages using Groq Whisper API
  • Contact Filtering: Privacy-focused with allowed contacts only

Requirements

System Dependencies

The WhatsApp channel uses neonize which requires:

  • libmagic: For file type detection
    • macOS: brew install libmagic
    • Ubuntu/Debian: sudo apt-get install libmagic1
    • Fedora: sudo dnf install file-devel

Audio Transcription (Optional)

For audio transcription, you need:

  • ffmpeg: For audio format conversion

    • macOS: brew install ffmpeg
    • Ubuntu/Debian: sudo apt-get install ffmpeg
    • Fedora: sudo dnf install ffmpeg
  • Groq API Key: Set GROQ_AUDIO_API_KEY or GROQ_API_KEY environment variable

Quick Start

1. Create Configuration

Create a whatsapp.yaml configuration file:

model: claude-sonnet-4-6
mcp_servers: ["fetch", "web-forager"]

privacy:
  allowed_contact: "+1234567890"  # Your phone number

channel:
  storage_path: ~/storage/whatsapp

features:
  text_messages: true
  media_messages: true
  group_messages: false
  typing_indicators: true

audio_transcriber:
  model: whisper-large-v3-turbo
  timeout: 60.0

2. Run the WhatsApp Agent

import asyncio
from pathlib import Path
import yaml
from agntrick_whatsapp import WhatsAppChannel, WhatsAppRouterAgent
from agntrick_whatsapp.config import WhatsAppAgentConfig

async def main():
    # Load configuration from YAML
    config_path = Path(__file__).parent / "whatsapp.yaml"
    with open(config_path) as f:
        config_dict = yaml.safe_load(f)

    config = WhatsAppAgentConfig.model_validate(config_dict)

    # Create channel
    channel = WhatsAppChannel(
        storage_path=config.get_storage_path(),
        allowed_contact=config.privacy.allowed_contact,
    )

    # Create router agent
    agent = WhatsAppRouterAgent(
        channel=channel,
        model_name=config.model,
        mcp_servers_override=config.mcp_servers,
        audio_transcriber_config=config.audio_transcriber,
    )

    # Start listening
    await agent.start()

asyncio.run(main())

Commands

The router agent supports the following commands:

Command Description
/learn <topic> Learning/tutorial mode
/youtube <url> YouTube video analysis
(default) General assistant mode

Examples

  • /learn Python decorators - Get a step-by-step tutorial on Python decorators
  • /youtube https://youtube.com/watch?v=xyz - Analyze a YouTube video
  • What's the weather in Tokyo? - General question

Audio Transcription

Voice messages are automatically transcribed using Groq's Whisper API:

from agntrick_whatsapp import AudioTranscriber

transcriber = AudioTranscriber()
result = await transcriber.transcribe_audio("/path/to/voice.ogg")
print(result)

Configuration Reference

PrivacyConfig

Field Type Required Description
allowed_contact str Yes Phone number to allow messages from
log_filtered_messages bool No Log filtered messages for debugging

FeatureFlags

Field Type Default Description
text_messages bool true Enable text messages
media_messages bool true Enable media messages
group_messages bool false Enable group messages
presence_updates bool true Enable presence updates
typing_indicators bool true Send typing indicators

AudioTranscriberConfig

Field Type Default Description
model str whisper-large-v3-turbo Groq Whisper model
timeout float 60.0 Request timeout in seconds
config_file str? None Optional config file path

Troubleshooting

neonize Import Error

RuntimeError: neonize dependency is unavailable

Install system dependencies (libmagic) and reinstall:

brew install libmagic  # macOS
pip install agntrick-whatsapp --force-reinstall

QR Code Not Appearing

  1. Check storage path permissions
  2. Delete existing session: rm -rf ~/storage/whatsapp
  3. Restart the agent

Audio Transcription Fails

  1. Verify Groq API key: echo $GROQ_AUDIO_API_KEY
  2. Check ffmpeg: ffmpeg -version
  3. Check file size (max 25MB)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agntrick_whatsapp-0.3.4.tar.gz (266.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agntrick_whatsapp-0.3.4-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

Details for the file agntrick_whatsapp-0.3.4.tar.gz.

File metadata

  • Download URL: agntrick_whatsapp-0.3.4.tar.gz
  • Upload date:
  • Size: 266.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for agntrick_whatsapp-0.3.4.tar.gz
Algorithm Hash digest
SHA256 3d5d40b84160b180f3a67d030b918c4e3207db3178cf9d4d9f4a35dc86b79d09
MD5 d026134179dfe9f880ba61e1c5f80b0d
BLAKE2b-256 02532bf23be7e71fc07806a68a5085d18c3405d8b037f31f9ea8083ce5dce0d8

See more details on using hashes here.

Provenance

The following attestation bundles were made for agntrick_whatsapp-0.3.4.tar.gz:

Publisher: release.yml on jeancsil/agntrick

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file agntrick_whatsapp-0.3.4-py3-none-any.whl.

File metadata

File hashes

Hashes for agntrick_whatsapp-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 84ab7f27b17d51834c5418dff1a7e4c1548fde9f88a478ed3257b5ba64114530
MD5 eac21d427a6eacd0e8bb01028eb4a0ff
BLAKE2b-256 537d9bba42c151826694a00e7bd31ff59e1480aefbb7b841be88a034a502ca58

See more details on using hashes here.

Provenance

The following attestation bundles were made for agntrick_whatsapp-0.3.4-py3-none-any.whl:

Publisher: release.yml on jeancsil/agntrick

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page