/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Draft a Support Handoff

Draft a Support Handoff

Prepare the Send to support form for a doc-site reader's conversation, with a drafted summary.

POST/v1/projects/{projectId}/chat/handoff/summaryTry it

The first of the two Send to support steps: returns what the form shows the reader before anything is sent — a summary of the conversation for them to edit, where it will go, the transcript that will be attached, and whether their memory can be attached. Nothing is sent or stored. The second step is Send to Support. See Send to support.

Public (no API key required) and scoped to the project and the visitorId: a reader can only draft from their own conversation.

Note

On your doc site this endpoint is also served same-origin at POST /_chat/handoff/summary. The project comes from the site's hostname, so the path takes no projectId.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.

Request Body

NameDescription
visitorId:stringbodyRequired
The anonymous visitor identifier (1–100 chars) that owns the conversation.
sessionId:stringbodyRequired
The conversation's UUID.

Response — 200 OK

NameDescription
summary:string
A draft for the reader to edit: two or three first-person sentences on what they're trying to do, what they tried and what still isn't working. Written by the model from the last 12 messages. If the model fails, it's the reader's last question. If your organization's monthly AI query quota is used up, it's an empty string and the reader writes their own.
to:string
Where the handoff goes: the support email address, or the <project name> support team when only the webhook is set up.
transcript:object
label describes what will be attached — the message count and how many distinct pages the answers cite. messages is the conversation, oldest first, at most 100 messages, with attached code blocks left out of the reader's messages.
memoryAvailable:boolean
true when the project keeps memory, the reader has it on, and something is remembered. Only then can the reader choose to attach it with includeMemory.

Usage

A draft that calls the model counts as one AI query against your organization's monthly quota, like an answer.

Rate Limits

PerLimit
Visitor5 drafts an hour
Client IP15 drafts an hour — only for requests through your doc site
Project100 drafts an hour

A request is only counted once the conversation is found to be the visitor's. Over a limit, the response is 429 with a Retry-After header. If the limits can't be checked, the request is refused with 429 rather than let through — see Agent mode action limits.

Error Responses

StatusCodeWhen
400validation_errorvisitorId or sessionId missing or malformed
403FORBIDDENThe site is private (password, invite-only or SSO) and the request didn't come through the doc site ("Ask from the docs site")
404NOT_FOUNDThe project doesn't exist, or the conversation isn't this visitor's in this project
409HANDOFF_UNAVAILABLEThe project has no usable support destination: no support email that belongs to a verified member of your organization, and the support.handoff webhook is off or no endpoint subscribes to it
429RATE_LIMITEDA limit above was reached, or the limits could not be checked. retryAfterSeconds says when to try again
500internal_errorThe form could not be prepared
Was this page helpful? Yes No
Request
bashJavaScriptPythonGoRubyPHPJavaC#bash
curl -X POST https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/chat/handoff/summary \
-H "Content-Type: application/json" \
-d '{
"visitorId": "vis_9f8e7d",
"sessionId": "b2e9a1c4-5d3f-4e7a-9b08-6c2f1d4e8a93"
}'
Responseapplication/json
200OK
{
"data": {
"summary": "I'm trying to point my apex domain at my docs. I added the CNAME the docs describe, but verification still fails after a day.",
"to": "support@acme.dev",
"transcript": {
"label": "Transcript · 4 messages · 2 sources",
"messages": [
{ "role": "user", "content": "How do I add a custom domain?" },
{ "role": "assistant", "content": "Add the domain under **Settings › Domains** [guides/custom-domains#Add a domain]…" }
]
},
"memoryAvailable": true
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext