Skip to main content
GET
Get an agent's readiness
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/agents/getReadiness?id=<agentId> returns one agent’s “Ready to run” report, as the Console’s agent detail checklist shows it.

Authority

You need agents:read at the agent’s home org unit. A missing, PERSONAL, unhomed or unreadable agent is the same 404 resource_missing (Agent not found); an unavailable agent store is 500. id is required once.

What it returns

  • status: ready, attention or blocked.
  • checks: each readiness check with its outcome (pass, fail or not_applicable), whether a failure blocksDispatch, the governance gate whose rule it applies, its code and message, and action: the kind of fix that clears a failed check (for example seat_worker, assign_owner or attest_identity), or null.
  • autonomy: the agent’s autonomy rung, posture and consequence.

What is withheld

A fix names only its kind. The person a fix would suggest, the worker, seat, suggested positions and Jobs, and the definition hash an attestation would sign are never returned, the same rule the governance accountability read follows. People make those fixes in the Console. For owner and attestation findings, see Get an agent’s accountability.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

agentId
string
required

The agent's slug (agentId) or definition id.

Minimum string length: 1

Response

Get an agent's readiness

data
object
required
meta
object
required