Skip to main content
POST
Attest an agent's identity
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

POST /api/v2/agents/attestIdentity records that you, a person, attest the agent’s current definition and accountable owner, until its next owner review. The body is { id, expectedActiveVersionId? }: send the active version you reviewed (null for none) to refuse the write with 409 conflict when it changed.

Authority

You need agents:manage at the agent’s home org unit, and agents:read there to see the agent. A missing, PERSONAL, unhomed or unreadable agent is the same 404 resource_missing (Agent not found); an unavailable agent store is 500, never 404. Without agents:manage at the home the answer is 403 permission_denied, recorded as a refused request.

A person only

Only a person can attest. Use a Personal key: the attestation names its owner. An External App or a platform key is 403 forbidden, “Identity attestation requires a person; use a Personal key”, with personRequired: true, whatever it holds.

Conflicts

Only an approved definition is attested. An agent whose definition has changes that are not approved yet (an edit to an agent that is not active waits for approval while the row already carries it) is 409 invalid_state: attest it once the change is approved. An agent with no definition hash, no active owner, no owner review date, or a review that is due is 409 invalid_state with the Console’s message. The response never carries the definition hash.

Replay

With an Idempotency-Key, a repeat of the same request within 24 hours returns the recorded answer only while the slug still names the same agent definition, you may still read the agent at its home, and you still hold the route’s permission there (the agent_write replay rule). Otherwise the repeat is 409 conflict and the write never runs twice. See Agent 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.

Headers

Idempotency-Key
string

1–255 printable ASCII characters (0x21–0x7E, no spaces), scoped to the calling credential. A repeat with the same key and request never runs the write again, a 5xx included: once the operation's permissions pass again it answers the identical status and body of the first response (Idempotent-Replayed: true, also sent as Idempotency-Replayed: true), unless the operation's own replay policy withholds it; a first response that was not stored (over 32 KiB, or carrying a one-time secret) answers its first status with only data.id (Idempotency-Replay-Disclosure: id-only) when it named one; otherwise 409 idempotency_result_unavailable; a repeat while the first is still running is 409 idempotency_key_in_flight, and the same key with a different request is 422 idempotency_key_reuse. Honoured for External App JWTs and platform and Personal keys; an External App's static companion key is not protected.

Required string length: 1 - 255

Path Parameters

agentId
string
required

The agent's slug (agentId).

Minimum string length: 1

Body

application/json
expectedActiveVersionId
string | null

The active version you reviewed; a different one is 409 conflict.

Response

Attest an agent's identity

data
object
required
meta
object
required