Skip to content
AGH RuntimeAPI Reference

Observe

AGH Observe HTTP endpoints.

Audience
Operators running durable agent work
Focus
API Reference guidance shaped for scanability, day-two clarity, and operator context.
GET/api/observe/tasks/dashboard

Query Parameters

scope?string

Filter by task scope

Value in"global" | "workspace"
workspace?string

Filter by workspace path, name, or ID

owner_kind?string

Filter by owner kind

Value in"human" | "agent_session" | "automation" | "extension" | "network_peer" | "pool"
owner_ref?string

Filter by owner reference

network_channel?string

Filter by network channel

origin_kind?string

Filter by task origin kind

Value in"cli" | "web" | "uds" | "http" | "automation" | "extension" | "network" | "agent_session" | "daemon"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/observe/tasks/dashboard"
{
  "dashboard": {
    "active_runs": {
      "claimed": 0,
      "items": [
        {
          "age_ms": 0,
          "attempt": 0,
          "error": "string",
          "health_status": "string",
          "last_activity_at": "2019-08-24T14:15:22Z",
          "latest_event_seq": 0,
          "max_attempts": 0,
          "network_channel": "string",
          "run_id": "string",
          "run_status": "queued",
          "scope": "global",
          "session_id": "string",
          "stuck": true,
          "task_id": "string",
          "task_identifier": "string",
          "task_owner": {
            "kind": "human",
            "ref": "string"
          },
          "task_priority": "low",
          "task_status": "draft",
          "task_title": "string",
          "workspace_id": "string"
        }
      ],
      "queued": 0,
      "running": 0,
      "starting": 0,
      "total": 0
    },
    "cards": {
      "blocked": {
        "awaiting_approval": 0,
        "awaiting_dependencies": 0,
        "health_status": "string",
        "tasks": 0
      },
      "failed": {
        "failed_runs": 0,
        "forced_stops": 0,
        "health_status": "string",
        "tasks": 0
      },
      "in_progress": {
        "active_runs": 0,
        "claimed_runs": 0,
        "health_status": "string",
        "queued_runs": 0,
        "running_runs": 0,
        "starting_runs": 0,
        "tasks": 0
      },
      "latency": {
        "claim_latency_ms": {
          "average_ms": 0,
          "maximum_ms": 0,
          "samples": 0
        },
        "start_latency_ms": {
          "average_ms": 0,
          "maximum_ms": 0,
          "samples": 0
        }
      }
    },
    "freshness": {
      "age_ms": 0,
      "has_live_work": true,
      "latest_activity_at": "2019-08-24T14:15:22Z",
      "observed_at": "2019-08-24T14:15:22Z",
      "stale": true,
      "stale_after_ms": 0,
      "status": "string"
    },
    "health": {
      "active_orphan_runs": 0,
      "queue_backlog": true,
      "status": "string",
      "stuck_runs": 0
    },
    "queue": {
      "backlog_status": "string",
      "backlog_threshold_ms": 0,
      "backlog_warning": true,
      "depth": [
        {
          "count": 0,
          "network_channel": "string",
          "oldest_queue_age_ms": 0,
          "oldest_queued_at": "2019-08-24T14:15:22Z"
        }
      ],
      "oldest_queue_age_ms": 0,
      "oldest_queued_at": "2019-08-24T14:15:22Z",
      "total": 0
    },
    "status_breakdown": [
      {
        "count": 0,
        "share_percent": 0,
        "status": "draft"
      }
    ],
    "totals": {
      "active_runs": 0,
      "awaiting_approval_tasks": 0,
      "blocked_tasks": 0,
      "canceled_runs": 0,
      "canceled_tasks": 0,
      "claimed_runs": 0,
      "completed_runs": 0,
      "completed_tasks": 0,
      "dependency_blocked_tasks": 0,
      "draft_tasks": 0,
      "failed_runs": 0,
      "failed_tasks": 0,
      "in_progress_tasks": 0,
      "pending_tasks": 0,
      "queued_runs": 0,
      "ready_tasks": 0,
      "running_runs": 0,
      "runs_total": 0,
      "starting_runs": 0,
      "tasks_total": 0
    }
  }
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
Empty
GET/api/observe/tasks/inbox

Query Parameters

scope?string

Filter by task scope

Value in"global" | "workspace"
workspace?string

Filter by workspace path, name, or ID

owner_kind?string

Filter by owner kind

Value in"human" | "agent_session" | "automation" | "extension" | "network_peer" | "pool"
owner_ref?string

Filter by owner reference

lane?string

Filter by inbox lane

Value in"my_work" | "approvals" | "failed_runs" | "blocked" | "archived"
unread?boolean

Return only unread inbox items

query?string

Filter by task title or identifier

limit?integer

Maximum number of inbox items to return

Formatint32

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/observe/tasks/inbox"
{
  "inbox": {
    "archived_total": 0,
    "groups": [
      {
        "count": 0,
        "items": [
          {
            "approval_policy": "none",
            "approval_state": "not_required",
            "blocking_reason": "string",
            "lane": "my_work",
            "latest_activity_at": "2019-08-24T14:15:22Z",
            "run": {
              "attempt": 0,
              "claim_token_hash": "string",
              "claimed_at": "2019-08-24T14:15:22Z",
              "claimed_by": {
                "kind": "human",
                "ref": "string"
              },
              "coordination_channel": {
                "allowed_message_kinds": [
                  "status"
                ],
                "channel": "string",
                "display_name": "string",
                "id": "string",
                "last_activity_at": "2019-08-24T14:15:22Z",
                "purpose": "string",
                "run_id": "string",
                "task_id": "string",
                "workflow_id": "string",
                "workspace_id": "string"
              },
              "coordination_channel_id": "string",
              "ended_at": "2019-08-24T14:15:22Z",
              "error": "string",
              "failure_kind": "string",
              "heartbeat_at": "2019-08-24T14:15:22Z",
              "id": "string",
              "lease_until": "2019-08-24T14:15:22Z",
              "max_attempts": 0,
              "previous_run_id": "string",
              "queued_at": "2019-08-24T14:15:22Z",
              "session_id": "string",
              "started_at": "2019-08-24T14:15:22Z",
              "status": "queued",
              "task_id": "string"
            },
            "task": {
              "effective_paused": true,
              "id": "string",
              "identifier": "string",
              "latest_event_seq": 0,
              "owner": {
                "kind": "human",
                "ref": "string"
              },
              "paused": true,
              "paused_by_task_id": "string",
              "priority": "low",
              "scope": "global",
              "status": "draft",
              "title": "string",
              "workspace_id": "string"
            },
            "triage": {
              "actor": {
                "kind": "human",
                "ref": "string"
              },
              "archived": true,
              "dismissed": true,
              "last_seen_activity_at": "2019-08-24T14:15:22Z",
              "read": true,
              "task_id": "string",
              "updated_at": "2019-08-24T14:15:22Z"
            }
          }
        ],
        "lane": "my_work",
        "unread_count": 0
      }
    ],
    "total": 0,
    "unread_total": 0
  }
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
Empty