RAKLEdocs
API Reference

Events

Every customer SSE event type, its payload, and terminal semantics.

View as Markdown

The stream emits four event types with a common envelope.

event_typeMeaningTerminal
stageProgress advanced.No
partialIncremental result.No
completedJob done; final result.Yes
failedJob failed; error code.Yes

Common fields:

Prop

Type

stage

Drive a progress indicator from message; treat stage as opaque.

event: stage
id: 2
data: {"event_type":"stage","job_id":"b7c1...","stage":"…","message":"Pricing in progress…","timestamp":"2026-05-15T12:00:02Z"}

partial

result is a subset of the final JobResult.

event: partial
id: 5
data: {"event_type":"partial","job_id":"b7c1...","stage":"…","message":"...","timestamp":"2026-05-15T12:00:05Z","result":{...}}

completed

Terminal. result carries the full JobResult (product_profile, fused_distribution, scenario_forecast, …).

event: completed
id: 9
data: {"event_type":"completed","job_id":"b7c1...","stage":"…","message":"...","timestamp":"2026-05-15T12:00:42Z","result":{"product_profile":{...},"fused_distribution":{"quantiles":{"0.5":812.0},"currency":"USD"},"scenario_forecast":null}}

failed

Terminal. code is a public error code.

event: failed
id: 4
data: {"event_type":"failed","job_id":"b7c1...","stage":null,"message":"Not enough comparable listings to price this item.","timestamp":"2026-05-15T12:00:11Z","code":"insufficient_data"}

Terminal closes the stream

After completed or failed, the server closes the connection. Do not reconnect.