v5

OpenAPI 3.1.0Proprietary2026-08-011476181.4 MB

Agent Management

Get agent by ID

Retrieve an agent by its system-generated ID.

get/agents/{agentId}

Response

Successful operation

idstring required

System-generated unique identifier for the agent.

namestring required

Human-readable name for the agent.

customerIdstring required

The ID of the customer this agent operates on behalf of.

isPausedboolean required

Whether the agent is currently paused. Paused agents cannot initiate any actions.

isConnectedboolean required

Whether the agent has been installed and connected (i.e., its device code has been redeemed).

createdAtstring date-time required

Creation timestamp.

updatedAtstring date-time required

Last update timestamp.

Example response

{
  "id": "Agent:019542f5-b3e7-1d02-0000-000000000001",
  "name": "Payroll Automation Agent",
  "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
  "isConnected": true,
  "policy": {
    "spendingLimits": {
      "currency": "USD",
      "perTransactionLimit": 50000,
      "dailyLimit": 500000,
      "dailyTransactionLimit": 10,
      "monthlyLimit": 5000000
    },
    "accountRestrictions": {
      "allowedAccountIds": [
        "Account:019542f5-b3e7-1d02-0000-000000000001"
      ],
      "accountRules": [
        {
          "accountId": "Account:019542f5-b3e7-1d02-0000-000000000001",
          "perTransactionLimit": 10000
        }
      ]
    },
    "approvalThresholds": {
      "currency": "USD",
      "amount": 100000
    }
  },
  "usage": {
    "dailyTransactionCount": 3,
    "dailySpend": 150000,
    "dailyResetDate": "2025-07-22",
    "monthlySpend": 750000,
    "monthlyResetMonth": "2025-08"
  },
  "createdAt": "2025-07-21T17:32:28Z",
  "updatedAt": "2025-07-21T17:32:28Z"
}