Read pipeline progress

Read each document target's stage state, unit counts, warnings, and failure reasons.

Read documents[].targets[].stages in a job response to understand what is happening for one file and language. Stages appear after the engine configuration is captured at start; the array can be empty before that.

Each entry contains stage, status, and units. A progress excerpt:

json
{
  "stage": "humanEdit",
  "status": { "_tag": "Running" },
  "units": { "finished": 3, "total": 8 }
}

Here, three of the target's eight units have completed or skipped human review. Inspect the review to see which units still require a decision.

Stage identifiers #

IdentifierWork
preEditRefine source text before translation.
localizeProduce the target translation.
rephraseRefine target phrasing.
qualityGateFind errors and use their severity to decide whether human review is required.
humanEditWait for internal or external review.
postEditRefine reviewed output.
contentLengthAdjust wording toward configured length limits.
backTranslationCheck meaning through reverse translation and correction.

Configure stages on the engine. Only enabled stages retained at job start are listed.

Stage status #

status._tagMeaning and additional fields
PendingWork has not begun.
PlanningWork is being prepared.
WaitingWaiting for preceding work.
RunningWork is active; human review can remain here while decisions are pending.
CompletedFinished; includes finishedAt.
CompletedWithWarningsFinished with retained warnings; includes finishedAt and nonempty warnings.
SkippedNo execution was needed; includes finishedAt and nonempty reasons.
CancelledWork stopped; includes finishedAt and nonempty reasons.
FailedStage failure; includes finishedAt and nonempty messages.

finishedAt is an ISO timestamp. units.finished counts completed or skipped units, and units.total counts the target's units. Before document preparation, both can be zero. These are content-unit counts, not model-request counts, elapsed time, or a billing estimate.

Decide whether to accept an output #

A required translation failure prevents the affected output from completing. Optional stages can retain preceding text with warnings. Consequently, a completed job still needs its stage warnings checked if your publication policy depends on review, length, or another quality requirement.

A human-review timeout can preserve AI-generated text without a human approval. Later stages can also modify a person's wording. Read the review policy and verify the final downloaded file before publishing.

The API returns progress here. Use Studio's run view to investigate the model attempts and detailed execution behind a stage.