Skip to content

Generate a personalized welcome message

GET
/api/intake/welcome-message
curl --request GET \
--url https://example.com/api/intake/welcome-message \
--header 'Authorization: Bearer <token>'

Returns an LLM-generated welcome message for the guided intake flow.

Successful Response

Media type application/json
WelcomeMessageResponse

Initial intake-page payload.

eta_envelope_secs is the cold-start ETA envelope consumed by the frontend ProgressCard fallback path. It is sourced from generation_timing_service.get_fallback_envelope_secs() so it stays aligned with _FALLBACK_AVERAGES — the frontend must never hardcode this value (enforced by test_canvas_intake_envelope_consistency).

object
message
required
Message
string
eta_envelope_secs
required
Eta Envelope Secs
integer
Example generated
{
"message": "example",
"eta_envelope_secs": 1
}