Get alignment

Get the current state of an alignment. Poll until status is completed, failed, or cancelled.

GET/v1/alignments/{alignmentId}

Authorization

Authorizationstringrequired

Send a Modaic bearer token in the Authorization header.

Parameters

alignmentIdUUIDrequired

Alignment ID.

Response

idUUIDrequired

repositoryIdUUIDrequired

statusqueued | running | completed | failed | cancelledrequired

phasequeued | optimizing | done | failed | cancelledrequired

branchstringrequired

sourceCommitShastringrequired

resultCommitShastring | nullrequired

resultAlignmentResult | nullrequired

A completed result contains status: "completed", improved, bestCandidate, initialScore, bestScore, usage, optional metrics, and nullable artifactPath.

progressAlignmentProgress | nullrequired

stage is one of starting, optimizing, scoring, finishing, committing, or done. metricCalls / maxMetricCalls is the useful progress fraction when both values are present; the run may finish before reaching the maximum.

errorobject | nullrequired

createdAtISO 8601 datetimerequired

updatedAtISO 8601 datetimerequired

startedAtISO 8601 datetime | nullrequired

finishedAtISO 8601 datetime | nullrequired

Was this page helpful?