get_wallet

Read the prepaid wallet and human-set spend controls without changing them.

View Markdown

get_wallet reports whether your workspace can afford a new run and how much is reserved. It is read-only.

Signature

code
get_wallet({})
code
{
  "name": "get_wallet",
  "arguments": {}
}

The input object has no fields. Adding funds and changing either spending control are human actions on the web wallet.

Return shape

The Remote MCP response includes the amounts and spending controls below, plus currency, locked and a short note. It excludes ledger history, display blocks, daily_time_zone and purchase links. The direct HTTP wallet response also includes workspace details, recent ledger entries and daily_time_zone. HTTP run errors may include a human-only topup_url when funds are insufficient.

code
{
  "balance": "<USD decimal string>",
  "held": "<USD decimal string>",
  "available": "<balance minus held>",
  "confirm_threshold": "<USD decimal string or null>",
  "daily_spend_limit": "<USD decimal string or null>",
  "daily_spent": "<captured today plus unresolved holds>",
  "daily_remaining": "<USD decimal string or null>",
  "daily_resets_at": "<next workspace-local midnight as an ISO timestamp>"
}

Use available for affordability. Do not subtract a second time or assume that settled balance is free to spend while another run is in flight.

Spending controls and permissions

Only signed-in workspace owners and admins can add funds or change spending controls in the web wallet. MCP and API-key agents can read these controls but cannot change them.

  • confirm_threshold: a run estimated above this amount needs approval.
  • daily_spend_limit: the cap across all agents, including successful charges and funds still reserved.
  • confirm_threshold: null means Never ask for approval.
  • daily_spend_limit: null means No daily cap. Balance and platform safety checks still apply.
  • daily_remaining: remaining daily allowance, or null when no daily cap is set.

Money fields are USD decimal strings. Use the raw values for calculations and daily_resets_at for the next reset.

For funding, charges and approvals, read wallet and spending. To begin an execution, continue to search_tools.

get_wallet — Scrollport