Get an AI summary of a WhatsApp group conversation

Returns an AI summary of a WhatsApp group conversation over a date range, split into topics, with the members who messaged in that range.

Before you call

  • Chat Summary must be enabled for your organization, otherwise the request fails with 403.
  • groupId is the clientCustomGroupId you gave the group; you must have access to view that group.
  • startDate and endDate are inclusive UTC days; endDate must be on or after startDate, and the range at most 7 days.

How it works

  • The response has startDate, endDate, chatType, groupName, memberCount, members (id, name, customerNumber), chatMessagesCount, callsCount and summaries.
  • members lists only the group members who sent a message in the range.
  • A summary is saved per exact date range and served again until a message in that range is added, edited or deleted, or a call transcription changes.
  • Only a newly generated summary is charged to your AI credits; a saved summary, or a range with no messages, costs nothing.
  • Fails with 422 if your organization is out of AI credits, and 404 if the group cannot be found.

Rate limit

  • 10 requests per minute.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Unique identifier for the group

date
required

Inclusive start of the range (UTC). Example: 2026-06-15

date
required

Inclusive end of the range (UTC). Must be on or after startDate, and at most 7 days from it. Example: 2026-06-21

Responses

400

Invalid parameters, or the date range is inverted or longer than 7 days

401

Missing or invalid API key, or insufficient permissions for this group

403

The chat-summary feature is not enabled for this organization

404

Group not found for the given groupId

422

Insufficient AI credits

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json