Agent Wallets

Update an agent wallet

Update the label of an agent wallet.

patch/v1/agent-wallets/{id}

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/agent-wallets/{id}
  • Auth: one of:
    • API key in header X-Api-Key
    • bearer (a scheme the document does not define)

Path parameters

idstring uuid required

The unique identifier of the agent wallet to update

Request body

labelstring required

Human-readable label for the wallet

Response

Agent wallet updated successfully

idstring uuid required

Entity UUID

createdAtstring date-time required

Creation date (ISO 8601)

updatedAtstring date-time required

Last update date (ISO 8601)

labelstring required

Human-readable label for the wallet

applicationIdstring uuid required

Application this wallet belongs to

addressstring required

On-chain address of the wallet

status'deploying' | 'ready' | 'active' | 'failed' required

Current deployment status of the wallet

network'EthereumAnvil' | 'BaseSepolia' | 'BaseMainnet' | 'XdcApothem' | 'XdcMainnet' | 'StellarQuickstart' | 'StellarTestnet' | 'StellarMainnet' required

Blockchain network of the wallet

paymentRail'x402' required

Settlement rail the wallet uses to move funds.

whiteliststring[] required

Bare x402 domains this wallet may pay on — the domains of its wallet-scope destination allow rule. Empty when the wallet has no allow rule (a deny-list or no rule leaves it empty). Surfaced here so the admin list can render the domains without a second call.

emergencyStopboolean required

True while the wallet is paused by its emergency stop: every payment is refused until it is resumed. False when the wallet has no policy.

Example response

{
  "paymentRail": "x402",
  "owner": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Jeanne Martin",
    "email": "jeanne.martin@example.com"
  },
  "whitelist": [
    "api.example.com",
    "openai.com"
  ],
  "budget": {
    "currency": "EUR",
    "day": {
      "cap": "50000",
      "spent": "12500"
    },
    "week": {
      "cap": "50000",
      "spent": "12500"
    },
    "month": {
      "cap": "50000",
      "spent": "12500"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.