Deskhero Developer Hub
Back to deskhero.com
Tickets

Reply summary

Generates a short customer-facing AI recap of the ticket and its conversation, for a reply that is sent without the quoted history (history_mode NO_HISTORY), and returns it as rich text (an HTML list) without storing anything on the ticket. The call waits for the model and counts against the same per-User AI summary allowance as the internal summary; the caller pastes the result into the reply draft, where it can be edited before sending. A ticket locked by another User (see the lock endpoints) answers 423 Locked and nothing is generated.

POST /api/{tenant:minlength(2)}/v{version:apiVersion}/tickets/reply_summary/{id}
Authorisation
Minimum role: USER

Request arguments

Name Type Source
idInt32
Request body example

Response

Status
200 (OK)
Type
DTO_rich_text
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 401 (Unauthorized), 403 (Forbidden), 404 (NotFound), 409 (Conflict), 423 (Locked), 429 (TooManyRequests)
Response body example
DTO_rich_text
NameTypeReadOnlyDescription
plain_previewStringReadOnlyPlain preview
htmlStringHtml
editorjsDTO_editorjsEditorjs
tiptapDTO_tiptapTiptap
read_minutesInt32Read minutes
DTO_editorjs
NameTypeReadOnlyDescription
timeInt64Time
versionStringVersion
blocksDTO_editorjs_block[]Blocks
DTO_editorjs_block
NameTypeReadOnlyDescription
idStringId
typeStringType
dataObjectData
DTO_tiptap
NameTypeReadOnlyDescription
typeStringType
contentDTO_tiptap_node[]Content
DTO_tiptap_node
NameTypeReadOnlyDescription
typeStringType
attrsDTO_tiptap_attrsAttrs
contentDTO_tiptap_node[]Content
textStringText
marksDTO_tiptap_mark[]Marks
DTO_tiptap_attrs
NameTypeReadOnlyDescription
textAlignStringTextalign
levelInt32 (nullable)Level
checkedBoolean (nullable)Checked
idInt32 (nullable)Id
altStringAlt
titleStringTitle
widthStringWidth
wrapperStyleStringWrapperstyle
containerStyleStringContainerstyle
filesDTO_tiptap_file_ref[]Files
hrefStringHref
targetStringTarget
colspanInt32 (nullable)Colspan
rowspanInt32 (nullable)Rowspan
colorStringColor
textStringText
nameStringFor emoji
nativeStringFor emoji
DTO_tiptap_file_ref
NameTypeReadOnlyDescription
idInt32Id
labelStringLabel
DTO_tiptap_mark
NameTypeReadOnlyDescription
typeStringType
attrsDTO_tiptap_attrsAttrs

Generated Sep 15, 2026 19:45