Overview
Retrieve the complete details of a WhatsApp AI Agent using its unique Agent ID. This endpoint returns the agent configuration, including prompts, assigned WhatsApp number, knowledge bases, AI model settings, and conversation configuration.Prerequisites
- Bearer Token authentication
- Valid WhatsApp Agent ID
Request
string
required
Bearer token for authenticated workspace access.
string
required
Unique identifier of the WhatsApp AI Agent.
Response
boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Human-readable success message.
object
Complete configuration of the WhatsApp AI Agent.
string
Unique identifier of the WhatsApp Agent.
string
Display name of the WhatsApp Agent.
string
WhatsApp Business Phone Number assigned to the agent.
string
Primary instruction prompt that defines the AI agent’s behavior.
string
Message automatically sent when a new WhatsApp conversation begins.
array[string]
Knowledge Base IDs associated with the WhatsApp Agent.
string
AI model used to generate responses.
number
Controls the creativity of AI-generated responses.
string
Current status of the WhatsApp Agent.
string
Timestamp when the agent was created.
string
Timestamp when the agent was last updated.
Error Handling
This endpoint returns the complete configuration of a WhatsApp Agent, making it useful for editing, auditing, or displaying agent settings.
You can use the returned Agent ID with:
PUT /api/whatsapp/update-whatsapp-agent/{agentId}to update the agent.DELETE /api/whatsapp/delete-whatsapp-agent/{agentId}to permanently remove the agent.

