Know of an official OpenAPI document? Contribute it →
For Agents
Send WhatsApp text, template, and media messages and manage contacts, contact groups, and canned replies through Swiftchats. Designed for outbound messaging workflows.
Use for: Send a WhatsApp text message to a customer, Send a WhatsApp template message for an order update, Add a new contact to my Swiftchats workspace, Create a contact group for a marketing segment
Not supported: Does not handle SMS, voice calls, or email - use Swiftchats for outbound WhatsApp text, template, and media messaging plus contact and group management only.
Jentic publishes the only available OpenAPI specification for Swiftchats, keeping it validated and agent-ready. Swiftchats is a WhatsApp Business messaging product from Axis96 that exposes APIs for managing contacts, contact groups, and canned replies, and for sending text, template, and media messages. The API uses HTTP bearer authentication and is suited to teams that need programmatic outbound WhatsApp messaging plus contact-list management.
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Swiftchats, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Faxis96.com%2Faxis96" | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Faxis96.com%2Faxis96" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
What an agent can do with Swiftchats API.
Send WhatsApp text messages, template messages, and media messages to a contact
Create, list, update, and delete WhatsApp contacts in the Swiftchats workspace
Manage contact groups for segmenting recipients into reusable lists
Create and manage canned replies for repeatable agent responses
Authenticate via HTTP bearer tokens scoped to a Swiftchats workspace
Patterns agents use Swiftchats API for, with concrete tasks.
★ Transactional WhatsApp Notifications
E-commerce and service teams can send order updates, appointment reminders, and shipping notifications over WhatsApp by calling /api/send/template with a pre-approved Meta template. Swiftchats handles the WhatsApp Business API plumbing so the integrating app only needs to map data into the template's variables. Suited to operational notifications where templated content is required.
POST /api/send/template with the customer's number and an order_update template populated with order id and ETA
Contact List and Segment Management
Marketing operators can build and maintain WhatsApp contact lists and groups for segmented sends. The /api/contacts and /api/contact-groups endpoints support full CRUD on contacts and groups by uuid. Useful for keeping the messaging audience in sync with a CRM or e-commerce store.
POST /api/contact-groups with a name and member uuids to create a 'high-value-customers' group, then verify membership via GET /api/contact-groups
Media-Rich Marketing Sends
Marketing teams can send WhatsApp media messages - images, documents, or videos - via /api/send/media for promotions and product launches. Combined with canned replies on /api/canned-replies, agents can keep response handling consistent. Suitable for campaigns where rich media drives conversion.
POST /api/send/media with a contact uuid and an image URL to deliver a promotional image to the recipient
Agent-Driven WhatsApp Outreach via Jentic
A customer-success agent can send personalised WhatsApp messages and manage contact groups through Jentic without holding the Swiftchats bearer token. Jentic exposes the send, contacts, and groups operations as discoverable tools the agent can chain. Suited to outbound-comms copilots and re-engagement campaigns.
Search Jentic for 'send a whatsapp message', load POST /api/send, and execute it to message a contact with a personalised follow-up
15 endpoints — jentic publishes the only available openapi specification for swiftchats, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
/api/send
Send a WhatsApp text message
/api/send/template
Send a WhatsApp template message
/api/send/media
Send a WhatsApp media message
/api/contacts
List contacts
/api/contacts
Create a contact
/api/contact-groups
List contact groups
/api/canned-replies
List canned replies
/api/send
Send a WhatsApp text message
/api/send/template
Send a WhatsApp template message
/api/send/media
Send a WhatsApp media message
/api/contacts
List contacts
/api/contacts
Create a contact
/api/contact-groups
List contact groups
/api/canned-replies
List canned replies
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Swiftchats by hand means handling its bearer auth against swiftchats.axis96.xyz and dealing with Meta's WhatsApp Business template approvals before you can send. Through Jentic you install once, import Swiftchats from the API Directory, store the token once, and your agent calls it.
Permission scoping
Swiftchats carries the recipient and message content in the request body rather than in a URL path segment, so scoping is by operation. You limit the agent to the operations it needs, such as POST /api/send for text or GET /api/contacts to read the list, and operations like deleting a contact or a contact group stay out unless you add them.
Credential isolation
Your Swiftchats bearer token is stored once, encrypted, by your own Jentic One instance and attached to the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'send a whatsapp message' or 'create a contact group', and Jentic returns the matching Swiftchats operation with its input schema so the agent calls the right endpoint without reading the docs.
Alternatives and complements available in the Jentic catalogue.
Specific to using Swiftchats API through Jentic.
Why is there no official OpenAPI spec for Swiftchats?
Swiftchats does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Swiftchats via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Swiftchats API use?
Swiftchats uses HTTP bearer authentication - the Authorization header carries a workspace-scoped bearer token. Through Jentic, the token is stored encrypted in the vault and attached to each request automatically.
Can I send WhatsApp template messages with the Swiftchats API?
Yes. POST /api/send/template sends a Meta-approved WhatsApp template; POST /api/send sends free-form text, and POST /api/send/media sends image, document, or video media messages.
How do I manage WhatsApp contact groups through Swiftchats?
Use the /api/contact-groups endpoints to create, list, update, and delete groups by uuid. Group membership pairs with the /api/contacts endpoints for full segment management.
What are the rate limits for the Swiftchats API?
Swiftchats messaging is ultimately gated by Meta's WhatsApp Business platform tier limits and any Swiftchats plan-level quotas. The OpenAPI spec does not declare numeric per-endpoint limits, so check your WhatsApp Business tier and Swiftchats plan.
How do I send a WhatsApp message through Jentic?
Search Jentic for 'send a whatsapp message', load POST /api/send, and execute it with the recipient and message body. Jentic injects the bearer token from the vault automatically.
Can I limit what my agent is allowed to do with the Swiftchats API?
Yes. Because Swiftchats carries the recipient and message content in the request body rather than in the URL path, you scope access by operation in your own self-hosted Jentic One instance, where your rules decide which operations and credentials the agent may use. You can allow just the operations the agent needs, such as POST /api/send to send text or GET /api/contacts to read the contact list, while operations like deleting a contact or a contact group stay unavailable unless you explicitly add them. The bearer token is attached at execution time by your instance, so the agent acts only within the operations you have granted.
GET STARTED