Skip to content
Documentation
GOCUX / Documentationapi reference

Reference: stream work-order progress

Observe updates for the same durable operation.

Observe updates for the same durable operation.

Practical procedure

  1. Open /work-orders/{work_order_id}/events after recording the task identity.
  2. Parse complete SSE events and associate each update with the known task.
  3. After a disconnect, read current task state before deciding whether to reconnect or stop.

Use a governed work order

A GoCux work order records an outcome, context and acceptance criteria. Use it for durable work that needs the optional Cloud Worker, rather than assuming that every chat turn starts a background job. Select the project and data classification when creating the request. Keep the returned work-order identity so progress, decisions and attachments remain tied to the same operation.

Contract example

Developer examples below describe routes on an authorized, configured GoCux control-plane base URL. They are request shapes or operation references, not claims that a particular public hostname exposes the API. Use the workspace for the corresponding human workflow; availability and permissions depend on the actual deployment.

Operation reference for this workflow

GET /work-orders/{work_order_id}/events

Inspect the result

A recorded or accepted work order is not proof of completed execution. Read its state, progress and attachments through the task views. Review the output against the acceptance criteria before using it. If a structured result was requested, inspect its validation state separately from the narrative answer.

What to keep explicit

A dropped stream is not permission to resubmit the original work under a new identity. Preserve partial progress and inspect the recorded task outcome.

Handle incomplete and refused work

A missing worker or an unavailable dispatch ledger can refuse durable execution while normal chat remains independent. Reuse an operation key only for the same request. After a lost response, reconcile the original operation rather than blindly dispatching new work. A configured maxCost is recorded as context; the work-order schema does not claim it is an enforced monetary ceiling.

Bring this workflow into your workspace.

Set the scope. Review the evidence. Approve the steps that need it.

Open the workspace

Keep exploring