Skip to content

Get agent status

One read-only call returning the agent profile, monthly spend headroom, balances (USDC / credits / XRP with deposit addresses), mandates, and recent transactions. Requires the login JWT (not a VC). Every amount is an atomic integer string with a matching `*Formatted` string and `decimals`.

GET
/api/agent/self/status

Responses​

Agent status.

application/json

Aggregate agent status.

Always ok.

Agent profile.

Best-effort balances. A block contains error instead of amounts when that balance is temporarily unavailable.

Mandate summary.

Recent transactions, newest first.

{
  "status": "<string>",
  "agent": {
    "externalAgentId": "<string>",
    "name": "<string>",
    "isAuthorized": "<boolean>",
    "authorizationExpiry": "<string>",
    "walletAddress": "<string>",
    "monthly": {
      "decimals": "<integer>",
      "unlimited": "<boolean>",
      "limit": "<string>",
      "limitFormatted": "<string>",
      "spent": "<string>",
      "spentFormatted": "<string>",
      "pending": "<string>",
      "pendingFormatted": "<string>",
      "remaining": "<string>",
      "remainingFormatted": "<string>",
      "lastReset": "<string>"
    }
  },
  "balances": {
    "usdc": {
      "network": "<string>",
      "address": "<string>",
      "decimals": "<integer>",
      "available": "<string>",
      "availableFormatted": "<string>",
      "error": "<string>"
    },
    "credits": {
      "decimals": "<integer>",
      "available": "<string>",
      "availableFormatted": "<string>",
      "balance": "<string>",
      "balanceFormatted": "<string>",
      "frozen": "<string>",
      "frozenFormatted": "<string>",
      "error": "<string>"
    },
    "xrp": {
      "network": "<string>",
      "address": "<string>",
      "decimals": "<integer>",
      "available": "<string>",
      "availableFormatted": "<string>",
      "error": "<string>"
    }
  },
  "mandates": {
    "open": "<integer>",
    "total": "<integer>",
    "items": [
      {
        "mandateId": "<string>",
        "status": "<string>",
        "isEnabled": "<boolean>",
        "currency": "<string>",
        "decimals": "<integer>",
        "naturalLanguage": "<string>",
        "category": "<string>",
        "limitAmount": "<string>",
        "limitAmountFormatted": "<string>",
        "spentAmount": "<string>",
        "spentAmountFormatted": "<string>",
        "pendingSpentAmount": "<string>",
        "pendingSpentAmountFormatted": "<string>",
        "remainingAmount": "<string>",
        "remainingAmountFormatted": "<string>",
        "validFrom": "<string>",
        "validUntil": "<string>",
        "signedAt": "<string>",
        "createdAt": "<string>",
        "approvalUrl": "<string>"
      }
    ],
    "itemsTruncated": "<boolean>"
  },
  "recentTransactions": {
    "items": [
      {
        "currency": "<string>",
        "decimals": "<integer>",
        "amount": "<string>",
        "amountFormatted": "<string>",
        "type": "<string>",
        "status": "<string>",
        "txHash": "<string>",
        "toAddress": "<string>",
        "fromAddress": "<string>",
        "createdAt": "<string>"
      }
    ],
    "limit": "<integer>",
    "hasMore": "<boolean>"
  }
}

Released under the MIT License.