The object is everything inside data. The field names below are relative to it: attributes.name is data.attributes.name in the response.
Fields
string
required
Resource type. Always agent.
string
required
Agent ID (agt_*).
object
required
The agent’s details.
Hide attributes
string
required
Agent display name.
string | null
required
Agent description.
object
required
Metadata visible to anyone who can read the resource.
string | null
required
Agent handle, such as @acme-support, or null when none is set.
string
required
Agent status: ACTIVE, or REVOKED after deletion. One of: ACTIVE, REVOKED. See Statuses.
object | null
required
Spend caps for actions this agent initiates on its owner’s party.
Hide limits
integer | null
Per-transaction spending limit in cents, or null for no limit.
integer | null
Daily spending limit in cents, or null for no limit.
integer | null
Monthly spending limit in cents, or null for no limit.
string | null
required
RFC 3339 timestamp when this agent was created, or null when unknown.
string | null
required
User who created this agent (usr_*).
string | null
required
RFC 3339 timestamp when the agent last authenticated, or null when it never has.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Party that owns the agent.
Hide party
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
ID of the party that owns the agent (pty_*).
Statuses
Status
Meaning
Can become
ACTIVE
The agent can authenticate and act. Every new agent starts here.
REVOKED
REVOKED
You deleted the agent, or the account was closed. It stops acting at once, its customer authorizations end, and you can still read it. It can’t be updated.