Skip to content

compare_runs

Compare two persisted model-run outputs side-by-side. Resolves run IDs using full UUID or UUID prefix. Both runs must be successful and belong to the same accessible project. Uses base_run_id as the anchor and comparison_run_id as the changed side in returned labels and deltas. Reuses the same diffing engine as compare_branches so result semantics stay aligned.

read-only

NameTypeRequiredDefaultDescription
base_run_idAnnotated[str, Field(description='UUID of the baseline model run to compare from.')]Yes
comparison_run_idAnnotated[str, Field(description='UUID of the comparison model run to compare to.')]Yes
output_name`Annotated[strNone, Field(description=‘Named output to compare between the two runs.’)]`NoNone

Returns a structured object. Top-level fields:

  • base_run_id (string)
  • comparison_run_id (string)
  • project_name (string)
  • base_status (string)
  • comparison_status (string)
  • base_commit_sha (string)
  • comparison_commit_sha (string)
  • base_branch (string)
  • comparison_branch (string)
  • base_run_number (integer)
  • comparison_run_number (integer)
  • base_started_at (string)
  • comparison_started_at (string)
  • base_finished_at (string)
  • comparison_finished_at (string)
  • base_data_snapshot_ref (null)
  • comparison_data_snapshot_ref (null)
  • diff (array<object>)
  • summary (object)
  • output_name (string)

See the response example below for the full payload shape.

{
"name": "compare_runs",
"arguments": {
"base_run_id": "66666666-6666-6666-6666-666666666666",
"comparison_run_id": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
"output_name": "revenue"
}
}
{
"base_run_id": "66666666-6666-6666-6666-666666666666",
"comparison_run_id": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
"project_name": "forecasts",
"base_status": "success",
"comparison_status": "success",
"base_commit_sha": "0123456789abcdef0123456789abcdef01234567",
"comparison_commit_sha": "abc1234def5678901234567890abcdef12345678",
"base_branch": "main",
"comparison_branch": "scenario/aggressive-growth",
"base_run_number": 17,
"comparison_run_number": 18,
"base_started_at": "2026-04-28T10:00:00+00:00",
"comparison_started_at": "2026-04-28T10:05:00+00:00",
"base_finished_at": "2026-04-28T10:00:01.420000+00:00",
"comparison_finished_at": "2026-04-28T10:05:01.590000+00:00",
"base_data_snapshot_ref": null,
"comparison_data_snapshot_ref": null,
"diff": [
{
"metric": "revenue",
"base_value": 100,
"comparison_value": 120,
"absolute_delta": 20,
"pct_delta": 0.2,
"significant": true
}
],
"summary": {
"total_diff": 20,
"rows_compared": 1
},
"output_name": "revenue"
}
  • Module: Scenario Comparison
  • Requires authentication via API token or Auth0 JWT.