Skip to main content
Return run status, progress, billing details, and input selections. Poll until completed, failed, or canceled. If blocked, inspect blockedReason and message.

Signature

Method signature on client.trainings:

Parameters

string
required
ID of the training run, with prefix trn..

Returns

Promise<TrainingRun> The configuration, inputs, and current state of one training run.
TrainingRunId
required
ID of the training run, with prefix trn..
TrainingId
required
Training draft ID with prefix trg..
TrainingConfiguration
required
A normalized method-specific Training draft.
TrainingCostEstimateInputSetId
required
The immutable input set used to calculate a Training Cost Estimate.
string
required
SHA-256 fingerprint of the accepted estimate, as 64 lowercase hexadecimal characters.
ModelVersionId
required
Model version ID with prefix mdv..
string
required
Name reserved for the model version this run produces.
string
required
Maximum accepted charge for this run, in US dollars as a decimal string.
"queued" | "running" | "stopping" | "blocked" | "completed" | "failed" | "canceled"
required
Run state: queued, running, stopping, blocked, completed, failed, or canceled; blocked requires resolving the reported reason.
number | null
required
Published model version revision, or null before publication.
object | null
required
Latest training progress while running or stopping; null in other states or when progress is unavailable.
"funds" | "payment" | "billing_review" | null
required
Reason the run is blocked: funds to reserve the budget, payment to settle usage, or billing_review for staff review; otherwise null.
object | null
required
Failure or cancellation details, or null when no error is recorded.
"pending" | "reserved" | "release_pending" | "released" | "settled" | "payment_required" | "resolved" | "reconciliation_required"
required
Billing state: pending before reservation, reserved while funds are held, release_pending or released for returned funds, settled after charging, payment_required for a shortfall, resolved after staff review, or reconciliation_required when charges need review.
string | null
required
Settled charge in US dollars as a decimal string, or null before a charge is recorded.
string | null
required
Current status or billing explanation, or null when none is available.
object
required
Cost estimate accepted for this run.
string
required
Cutoff used to freeze the input rows, as an ISO 8601 timestamp.
object | null
required
Prepared training and validation inputs; null when unavailable or omitted from create and list responses.
string
required
Time the training run was created, as an ISO 8601 timestamp.
string
required
Time the training run was last updated, as an ISO 8601 timestamp.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses: HTTP endpoint: GET /training-runs/{trainingRunId}.