Skip to content

Get model runs

GET /api/v1/predictive-models/runs/{runId}: request fields and declared response contract.

GET/api/v1/predictive-models/runs/{runId}

Authorization
PermissiondataPipelines.read
Workspace scoperequired
Scope targetworkspace

Parameters

Path parameters
FieldTypeRequiredNullableDefault
runIdstringrequirednon-null—

Query parameters: none.

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.runIdstringrequirednon-null—
data.companyIdstringrequirednon-null—
data.workspaceIdstringrequirednon-null—
data.workUnitIdstringrequirednon-null—
data.status"requested" | "waiting_capacity" | "preparing" | "starting" | "running" | "cancel_requested" | "succeeded" | "failed" | "cancelled" | "blocked"requirednon-null—
data.revisionintegerrequirednon-null—
data.refsobjectrequirednon-null—
data.refs.objectiveIdstringrequirednon-null—
data.refs.dataDefinitionIdstringrequirednon-null—
data.refs.projectKeystringrequirednon-null—
data.refs.projectVersionintegerrequirednon-null—
data.refs.executorKindstringrequirednon-null—
data.refs.resourceClassstringrequirednon-null—
data.refs.maxSpendUsdMicrosintegerrequirednon-null—
data.refs.deadlineAtstringrequirednon-null—
data.refs.executorConfigRefstringoptionalnon-null—
data.admissionAttemptintegerrequirednon-null—
data.receiptobjectoptionalnon-null—
data.receipt.workUnitIdstringrequirednon-null—
data.receipt.revisionstringrequirednon-null—
data.receipt.poolsarrayrequirednon-null—
data.receipt.expiresAtEpochSecondsintegerrequirednon-null—
data.receipt.policyobjectoptionalnon-null—
data.receipt.policy.envelopeIdstringrequirednon-null—
data.receipt.policy.pinnedAtstringrequirednon-null—
data.receipt.policy.limitsobjectrequirednon-null—
data.reservationExpiresAtstringoptionalnon-null—
data.blockedReasonstringoptionalnon-null—
data.supervisorKeystringoptionalnon-null—
data.createdAtstringrequirednon-null—
data.updatedAtstringrequirednon-null—
data.statusUpdatedAtstringrequirednon-null—

Declared failures

Declared failures
ACCESS_DENIED403 — not retryable
CORE_ERROR500 — not retryable
GOVERNANCE_DENIED403 — not retryable
VALIDATION_ERROR400 — not retryable
VALIDATION_INPUT_ERROR400 — not retryable

Readback

This method returns the current state it read.

  • predictiveModels.runs.read

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

GET /api/v1/predictive-models/runs/{runId} HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>