Skip to main content

Get Intake Deflection Suggestions

GET 
/api/support/intake/deflect

Before a ticket is opened: given what the person is about to ask, returns the help-docs sections and their organisation's previously resolved tickets that may already answer it. Results are cached briefly per query, so calling it as they type is fine.

Environment intake token

Called by another SKU environment (beta, demo, dev) on behalf of its users: authenticate with that environment's intake token and the origin headers described below — not with a Personal Access Token or a session.

Query parameters

  • q (string, required, 3–500 characters) — the question or problem, free text

Response fields (data)

  • docs[] (array, up to 3, best match first) — title, url, snippet (max 240 characters) and score (a rank-derived confidence)
  • tickets[] (array, up to 3, most recently updated first) — id, subject, status (resolved or closed) and resolved_at, limited to tickets this caller can see

The prior-ticket half needs both a mapped production tenant and a SKU.io account holding the requester's address; without either, tickets is an empty array and the docs half still answers. The shape never changes.

Authentication: the environment token as Authorization: Bearer, plus the X-Support-* identity headers described on the Intake folder. There is no session and no tenant context. An unknown token, or a token presented with another environment, is refused with 403; incomplete identity headers are 422.

Request​

Responses​

OK

Response Headers
    Content-Type