v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

Retrieve an agent's health profile

Returns an aggregate health profile for the specified agent, including an overall status, a numeric health score, recent activity metrics, and a list of recommended remediation actions.

The health check is computed on demand at request time. The checked_at timestamp in the response reflects when the evaluation ran. Use this endpoint to surface diagnostics about tool availability, model configuration, and runtime activity in dashboards or monitoring workflows.

The authenticated caller must own the agent or hold sufficient permissions within its owning org or team. When called under a developer app scope, the caller must hold the app scope for the target app.

get/api/v1/agents/{agent}/health

Path parameters

agentstring required

ID (agi_...) or lookup_key of the agent to evaluate.

Response

Successful response

activityobject required

Timestamps for the agent's most recent and next scheduled activity, used to surface last-run and upcoming-run information.

checked_atstring date-time required

When the health profile was last computed (ISO 8601).

checksobject[] required

Renderable health check results. Each object includes at minimum key, label, status, and summary fields.

countsobject required

Action counts broken down by dependency area and resolution status, used to render progress indicators per category.

recentobject required

Recent execution metrics for the agent, including run counts and failure counts over a recent time window.

scoreinteger required

Normalized health score from 0 (fully degraded) to 100 (fully healthy), derived from the weight and status of all health actions.

statusstring required

Overall health status of the agent. One of "ok", "warning", or "critical".

Example response

{
  "activity": {},
  "agent": {
    "acl": {
      "add": [
        {
          "actions": [
            "read",
            "write"
          ],
          "principal": "string",
          "principal_type": "user"
        }
      ],
      "grants": [
        {
          "actions": [
            "read",
            "write"
          ],
          "principal": "string",
          "principal_type": "user"
        }
      ],
      "remove": [
        {
          "principal": "string",
          "principal_type": "user"
        }
      ]
    },
    "app": "dap_0aBcDeFgHiJkLmNoPqRsTu",
    "created_at": "2024-01-01T00:00:00Z",
    "default_model": "claude-3-7-sonnet-latest",
    "email": "user@example.com",
    "id": "agi_0aBcDeFgHiJkLmNoPqRsTu",
    "identity": "You are a helpful assistant that answers questions about ArchAstro products.",
    "last_applied_template_config": "cfg_0aBcDeFgHiJkLmNoPqRsTu",
    "lookup_key": "string",
    "metadata": {
      "key": "value"
    },
    "name": "Example Name",
    "org": "org_0aBcDeFgHiJkLmNoPqRsTu",
    "org_name": "Example Name",
    "originator": "deploy-pipeline",
    "phone_number": "+15555550123",
    "sandbox": "dsb_0aBcDeFgHiJkLmNoPqRsTu",
    "source_solution": {
      "solution": {
        "category_keys": [
          "string"
        ],
        "created_at": "2024-01-01T00:00:00Z",
        "description": "An example description.",
        "id": "id_0aBcDeFgHiJkLmNoPqRsTu",
        "kind": "Solution",
        "latest_solution": "id_0aBcDeFgHiJkLmNoPqRsTu",
        "latest_version": "1.0.0",
        "lookup_key": "string",
        "metadata": {
          "key": "value"
        },
        "name": "Example Name",
        "org": "org_0aBcDeFgHiJkLmNoPqRsTu",
        "org_logo": {
          "file": "fil_0aBcDeFgHiJkLmNoPqRsTu",
          "height": 600,
          "media": "med_0aBcDeFgHiJkLmNoPqRsTu",
          "mime_type": "application/json",
          "refresh_url": "https://example.com",
          "url": "https://example.com",
          "width": 800
        },
        "org_name": "Example Name",
        "org_slug": "example-slug",
        "owners": [
          "string"
        ],
        "readme_url": "https://example.com",
        "solution_id": "01234567-89ab-cdef-0123-456789abcdef",
        "solution_version": "1.2.0",
        "tag_keys": [
          "string"
        ],
        "template_kind": "AgentTemplate",
        "templates": [
          {
            "description": "An example description.",
            "display_name": "Example Name",
            "id": "id_0aBcDeFgHiJkLmNoPqRsTu",
            "kind": "AgentTemplate",
            "lookup_key": "string",
            "name": "Example Name",
            "readme_url": "https://example.com",
            "virtual_path": "string"
          }
        ],
        "updated_at": "2024-01-01T00:00:00Z",
        "upgrade_available": true,
        "virtual_path": "string"
      },
      "template": {
        "created_at": "2024-01-01T00:00:00Z",
        "description": "An example description.",
        "display_name": "Example Name",
        "id": "id_0aBcDeFgHiJkLmNoPqRsTu",
        "kind": "agent_tool_template",
        "lookup_key": "string",
        "name": "Example Name",
        "updated_at": "2024-01-01T00:00:00Z",
        "virtual_path": "string"
      }
    },
    "team": "tem_0aBcDeFgHiJkLmNoPqRsTu",
    "updated_at": "2024-01-01T00:00:00Z",
    "user": "usr_0aBcDeFgHiJkLmNoPqRsTu"
  },
  "checked_at": "2024-01-01T00:00:00Z",
  "checks": [
    {}
  ],
  "counts": {},
  "health_actions": [
    {
      "agent": "agi_0aBcDeFgHiJkLmNoPqRsTu",
      "app": "dap_0aBcDeFgHiJkLmNoPqRsTu",
      "created_at": "2024-01-01T00:00:00Z",
      "depends_on": [
        "string"
      ],
      "description": "An example description.",
      "id": "aha_0aBcDeFgHiJkLmNoPqRsTu",
      "kind": "env_var",
      "last_verified_at": "2024-01-01T00:00:00Z",
      "last_verifier_message": "string",
      "org": "org_0aBcDeFgHiJkLmNoPqRsTu",
      "params": {
        "key": "value"
      },
      "required": true,
      "sort_order": 1,
      "source": "setup",
      "status": "pending",
      "title": "Example Title",
      "updated_at": "2024-01-01T00:00:00Z",
      "verify_config": {}
    }
  ],
  "recent": {},
  "score": 85,
  "status": "ok"
}