Draft a Support Handoff
Prepare the Send to support form for a doc-site reader's conversation, with a drafted summary.
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.
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
projectIdRequest Body
visitorIdsessionIdResponse — 200 OK
summarytothe <project name> support team when only the webhook is set up.transcriptlabel 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.memoryAvailabletrue 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
| Per | Limit |
|---|---|
| Visitor | 5 drafts an hour |
| Client IP | 15 drafts an hour — only for requests through your doc site |
| Project | 100 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
| Status | Code | When |
|---|---|---|
| 400 | validation_error | visitorId or sessionId missing or malformed |
| 403 | FORBIDDEN | The site is private (password, invite-only or SSO) and the request didn't come through the doc site ("Ask from the docs site") |
| 404 | NOT_FOUND | The project doesn't exist, or the conversation isn't this visitor's in this project |
| 409 | HANDOFF_UNAVAILABLE | The 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 |
| 429 | RATE_LIMITED | A limit above was reached, or the limits could not be checked. retryAfterSeconds says when to try again |
| 500 | internal_error | The form could not be prepared |