Sign in
hydra

Top up additional funds into an open head. (admin access required)

Changed on

Repeatable incremental commit into an already-Open head, reusing the same draft/validate/sign safety path as the initial commit. Each top-up is its own L1 deposit. With exactAmount, that amount is first carved into its own L1 UTxO and only that UTxO is deposited, so everything else in the wallet — an agent's registry NFT included — stays on L1; this is the way to top up from a mixed wallet. Without it, Hydra commits WHOLE UTxOs, so every wallet UTxO matching assetFilter/assetUnit goes into the head.

post/hydra/head/topup

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/hydra/head/topup
  • Auth: API key in header token

Request body

headIdstring required

The Hydra head to top up

assetFilter'all' | 'ada-only'

Which plain wallet UTxOs to commit: all, or ADA-only (ignored when assetUnit is set)

assetUnitstring

Commit only UTxOs containing this native-asset unit (policyId + assetName hex)

exactAmountstring

Exact top-up amount (base unit) of assetUnit (or lovelace). Pre-splits a dedicated L1 UTxO first, then commits it — adds an L1 confirmation wait.

Example request

{
  "headId": "cuid_v2_auto_generated",
  "assetFilter": "ada-only",
  "exactAmount": "50000000"
}

Response

Top-up accepted

status'success' required

Example response

{
  "status": "success",
  "data": {
    "headId": "cuid_v2_auto_generated",
    "accepted": true
  }
}

Changes