archive_commentary

Soft-delete a commentary row by stamping archived_at / archived_by. Idempotent: archiving an already-archived row is a no-op that returns the existing row unchanged. Archived rows are hidden from list_commentary by default; pass include_archived=true to that tool to surface them. Archiving does NOT bump the version or append a version row (the trail tracks text edits, not lifecycle). Hard delete is intentionally not exposed; use this for retention-friendly archival. Returns: commentary (object) — the archived row including archived_at and archived_by.

Parameters

Name	Type	Required	Default	Description
commentary_id	str	Yes	—

Returns

Returns a structured object. Top-level fields:

• commentary (object)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "archive_commentary",
  "arguments": {
    "commentary_id": "ffffffff-ffff-ffff-ffff-ffffffffffff"
  }
}

Response

{
  "commentary": {
    "commentary_id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
    "tenant_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "project_name": "forecasts",
    "run_id": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
    "output_name": "revenue",
    "author_id": "22222222-2222-2222-2222-222222222222",
    "text": "Revenue beat plan by 12% in March, mostly from SaaS expansion.",
    "version": 1,
    "archived_at": "2026-04-28T10:10:00+00:00",
    "archived_by": "22222222-2222-2222-2222-222222222222",
    "created_at": "2026-04-28T10:00:00+00:00",
    "updated_at": "2026-04-28T10:00:00+00:00"
  }
}

Notes

• Module: Run Commentary
• Requires authentication via API token or Auth0 JWT.