Welcome π
Welcome to the Vambe AI API documentation. Use this documentation to discover how to send WhatsApp and Webchat messages, manage pipelines and contacts, trigger automations with webhooks, and train assistants with documents and product data.
π Guides vs API Reference
- Guides (like this one) are human-friendly walkthroughs. They explain the why and how with examples, common use cases, and best practices.
- API Reference is auto-generated from the API itself. It's where youβll find every endpoint with request/response formats, curl examples, and try-it buttons.
π§ Key Sections
Hereβs a quick map of whatβs available:
π API Key
How to authenticate your requests securely with your personal key.
π¬ Messages and Conversations
Collection of endpoints grouped by channel
- WhatsApp QR
- WhatsApp API
- Get Messages
- Webchat
π Ecommerce
Upsert and retrieve products for use inside assistant flows and orders.
π Pipelines
Fetch sales or support pipelines to categorize tickets and leads.
π‘ Channels
Fetch or tag contacts by their channel (WhatsApp, Webchat, etc).
π€ Partners
Manage external partner data or onboard new resellers.
π Analytics
Measure contact response times, agent speed, and pending replies.
π Assistant Documents
Train assistants with raw documents you upload programmatically.
π§ Webhooks
Receive notifications on events like messages received or tickets opened.
π Need help getting started? Just head to any section above β or explore the API Reference when you're ready to test requests live.
Happy building! π
Updated 16 days ago