Search Modaic documentation

Find a Modaic guide or API reference

ReferenceAPIbatch decisions

Get batch decision

Get the current state of a batch decision. Poll until status is completed, failed, or cancelled.

GET/v1/batch-decisions/{batchDecisionId}

Authorization

Authorizationstringrequired

Send a Modaic bearer token in the Authorization header.

Parameters

batchDecisionIdUUIDrequired

Batch decision ID.

Response

idUUIDrequired
repositoryIdUUIDrequired
statusqueued | running | completed | failed | cancelledrequired
phasequeued | deciding | done | failed | cancelledrequired
branchstringrequired
sourceCommitShastringrequired
progressobjectrequired

Integer total, completed, and failed counts.

resultobject | nullrequired
errorobject | nullrequired
createdAtISO 8601 datetimerequired
updatedAtISO 8601 datetimerequired
startedAtISO 8601 datetime | nullrequired
finishedAtISO 8601 datetime | nullrequired

Retrieve the decisions produced by the batch through each example's decision history.

Was this page helpful?