Open
Conversation
Rewrite the interface reference page to match the structure used by Slack and Telegram docs. Add missing initialization parameters (workflow, prefix, tags), fix the get_router method signature, and add Session Management, Media Support, Reasoning Support, and Troubleshooting sections. Update all six usage examples to match the actual cookbook code: - basic.py: fix model class (OpenAIChat not OpenAIResponses), remove stale WHATSAPP_WEBHOOK_URL env var - image_generation_tools.py: fix model class, remove debug_mode - reasoning_agent.py: fix import (ReasoningTools not ThinkingTools), match actual tool params from cookbook - image_generation_model.py: update Gemini model ID to match cookbook - agent_with_media.py: update Gemini model ID to match cookbook - agent_with_user_memory.py: fix import (WebSearchTools not HackerNewsTools), match actual cookbook code
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the WhatsApp interface documentation and examples to align with the structure and (intended) behavior documented for other AgentOS interfaces, focusing on correcting stale snippets and expanding the reference coverage.
Changes:
- Reworks the WhatsApp interface reference page with updated initialization params, endpoint details, and new sections (sessions/media/reasoning/troubleshooting).
- Updates WhatsApp usage examples to reflect current imports/models/tooling and removes stale environment variables.
- Refreshes example descriptions and key-feature lists to match updated snippets.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| agent-os/interfaces/whatsapp/introduction.mdx | Expanded/modernized WhatsApp interface reference (setup, params, endpoints, sessions/media/reasoning, troubleshooting). |
| agent-os/usage/interfaces/whatsapp/basic.mdx | Updates basic WhatsApp agent example to OpenAIChat and removes stale env var usage. |
| agent-os/usage/interfaces/whatsapp/image-generation-tools.mdx | Updates tool-based image generation example to OpenAIChat, removes stale params/env var references, and refreshes feature bullets. |
| agent-os/usage/interfaces/whatsapp/image-generation-model.mdx | Updates model-based image generation example (Gemini model id) and removes stale params/env var references. |
| agent-os/usage/interfaces/whatsapp/reasoning-agent.mdx | Updates reasoning agent example imports/toolkit usage and simplifies YFinanceTools usage; refreshes description/features. |
| agent-os/usage/interfaces/whatsapp/agent-with-media.mdx | Updates media-capable agent example (Gemini model id), imports, and feature bullets. |
| agent-os/usage/interfaces/whatsapp/agent-with-user-memory.mdx | Updates memory example imports/tooling (WebSearchTools), fixes snippet text, and refreshes env vars/feature bullets. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - Health/status of the interface. | ||
| - Health/status check for the interface. | ||
| - Returns `{"status": "available"}`. |
| ReasoningTools(add_instructions=True), | ||
| YFinanceTools(), | ||
| ], | ||
| instructions="Use tables to display data. When you use thinking tools, keep the thinking brief.", |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Bring the WhatsApp interface documentation up to parity with Slack and Telegram docs. The existing pages had stale code snippets, missing parameters, and lacked several reference sections.
Interface Reference (
agent-os/interfaces/whatsapp/introduction.mdx)Rewritten to match the Slack/Telegram structure:
workflow,prefix,tagsget_routermethod signature (removed non-existentuse_asyncparam)wa:{phone_number})Usage Examples (6 files updated)
All examples updated to match the actual cookbook source code:
basic.mdxOpenAIChatnotOpenAIResponses), removed staleWHATSAPP_WEBHOOK_URLenv varimage-generation-tools.mdxdebug_modefrom snippetreasoning-agent.mdxReasoningToolsnotThinkingTools), matched actual tool paramsimage-generation-model.mdxmodels/gemini-2.5-flash-imageagent-with-media.mdxgemini-3-flash-previewagent-with-user-memory.mdxWebSearchToolsnotHackerNewsTools), matched actual cookbook codeType of Change
Checklist