dokkaiv0.1.0
API Reference

Stream a job's progress (SSE)

Server-Sent Events mirroring a job's state on every update.

GET/instances/jobs/{job_id}/eventsany

Streams a single job's progress as Server-Sent Events (text/event-stream). Emits the current state on connect, then again whenever updated_at changes. Event type is job for in-progress updates and done for the terminal state, after which the stream closes.

An unknown job_id returns a plain 404 (not a stream).

Path parameters

job_iduuidrequired
The job to stream.

Responses

200An SSE stream (event: <type>\ndata: <json>)
json
event: job
data: {"id":"b0dc2159-...","status":"running","stage":"describe","done":120,"total":1739}

event: done
data: {"id":"b0dc2159-...","status":"succeeded","stage":"done"}