Engagement Email

Preview Kai-written emails

Writes Kai emails for a few sample recipients with the saved Kai config. Nothing is sent or stored; the model calls are billed as AI usage.

POST

https://api.gleap.io/v3/engagement/emails/{engagementEmailId}/kai/sample

Authorizations

Authorizationstring · headerrequired

Bearer authentication header of the form Bearer <token>.

Path parameters

engagementEmailIdstringrequired

Headers

projectstringrequired

Bodyapplication/jsonrequired

contactIdsstring[]

Contacts of this project to write for (max 5). Without them Kai picks recent contacts from the audience.

countnumber<double>

How many samples (default 3, max 5).

Response

application/json

Updated November 1, 2026

curl --request POST \
  --url 'https://api.gleap.io/v3/engagement/emails/{engagementEmailId}/kai/sample' \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>' \
  --header 'Content-Type: application/json' \
  --data '{
  "count": 0
}'

No example in the spec.