GET /v1/workflows/{id}/analyze-funds

Analyze the fund requirements of a workflow without executing it. Returns resolved (wallet, chain, token, amount) tuples for every action that moves money, plus a `balance` row per requirement when the wallet-balances client is configured. The endpoint is read-only and does not consume CU.

GET /v1/workflows/{id}/analyze-funds
Analyze the fund requirements of a workflow without executing it. Returns resolved (wallet, chain, token, amount) tuples for every action that moves money, plus a `balance` row per requirement when the wallet-balances client is configured. The endpoint is read-only and does not consume CU.

Path Parameters

id string required path
Workflow ID

Query Parameters

version integer optional query
Pin analysis to a specific workflow version

Responses

200 OK
application/json
code integer
data object
balancesFetched boolean
requirements object[]
Array of:
amountIsHumanReadable boolean
amountIsPartial boolean
AmountIsPartial means RequiredAmount understates the true total for a reason OTHER than a runtime expression: an operand was dropped, or the amount is per-iteration inside a loop. Floor semantics apply (the number is a lower bound) but NO claim about a later step computing the remainder is true.
amountRuntimeDetermined boolean
AmountRuntimeDetermined is true when the leg's amount is wired to a runtime expression ({{...}}) rather than a literal, and could not be constant-folded. The leg's IDENTITY (chain + token) is fully resolved — only the SIZE is unknown until the workflow runs. Distinct from Unresolved, which means the identity itself could not be determined. When multiple legs sharing the same dedup key (wallet + chain + token) are merged (addOrMerge), this flag is true if ANY contributing leg was runtime-determined — even when another contributing leg supplied a literal amount. It is never cleared just because a literal amount is also present. FLOOR SEMANTICS: when this is true AND RequiredAmount is non-empty, the two fields are BOTH meaningful together: RequiredAmount is the sum of only the literal contributing legs — a known LOWER BOUND on the true requirement, not the total (the runtime-determined leg's own contribution is never invented). Treat RequiredAmount as "at least X" in this state. isInsufficient MAY still be computed against this floor and MAY be true — a balance below the floor is a genuine shortfall. A balance at or above the floor is UNKNOWN sufficiency, not proven sufficient.
amountUnit string
AmountUnit declares the unit of the amount when the analyzer KNOWS it, rather than inferring it from the string's shape. "raw" — smallest units (wei-like). ONLY the constant-fold sets this: it computes the integer itself, so it is the one producer that knows. "" — unknown. Consumers MUST print the value verbatim and MUST NOT rescale it by decimals. Deliberately has no "human" value yet. Action payloads don't carry unit metadata, so claiming "human" would be the same guess in a new coat.
balance object
amount string
raw units (wei)
amountIsPartial boolean
AmountIsPartial mirrors funds.Requirement.AmountIsPartial: true when RequiredAmount understates the true total for a reason OTHER than a runtime expression — a dropped operand on a unit mismatch, or a per-iteration amount inside a loop. Same FLOOR semantics as AmountRuntimeDetermined (the amount is a known lower bound, and IsInsufficient=true against it is a genuine shortfall), but unlike that flag there is no runtime expression that a later step resolves — no claim is made about anything computing the remainder.
amountRuntimeDetermined boolean
AmountRuntimeDetermined mirrors funds.Requirement.AmountRuntimeDetermined: true when at least one contributing leg's amount is wired to a runtime expression and could not be resolved statically. When this is true and the requirement has no known amount at all, IsInsufficient stays false (nothing to compare against — "unknown", not "known and sufficient"). When this is true AND a RequiredAmount IS present (merged with a literal-amount leg), that amount is only a known FLOOR — the literal legs' sum, not the true total — and IsInsufficient IS computed against it. IsInsufficient=true there is a genuine shortfall. But IsInsufficient=false is still NOT proof of sufficiency: it only means the balance clears the known floor, not the (partially unknown) total. Consumers must key off AmountRuntimeDetermined AND AmountIsPartial, not IsInsufficient alone, to know whether "sufficient" can be asserted — both flags carry the identical FLOOR semantics described above.
amountUsd number
chainId integer
decimals integer
isInsufficient boolean
amount < requiredAmount
isLow boolean
gas only: balance below LowGasThreshold
symbol string
tokenAddress string
walletAddress string
chainId integer
chainName string
decimals integer
isNative boolean
nodeId string
nodeName string
nodeType string
reason string
receivedDisplay object
ReceivedDisplay is DISPLAY-ONLY context describing what the SAME node receives, attached only when this sent leg has no RequiredAmount of its own. See the ReceivedLegDisplay doc for the boundary it must not cross.
amount string
Amount is the received leg's resolved amount: a literal from the payload, or the exact constant-fold of an upstream literal-only convert-to-wei node. Never estimated.
amountUnit string
AmountUnit declares the unit of the amount when the analyzer KNOWS it, rather than inferring it from the string's shape. "raw" — smallest units (wei-like). ONLY the constant-fold sets this: it computes the integer itself, so it is the one producer that knows. "" — unknown. Consumers MUST print the value verbatim and MUST NOT rescale it by decimals. Deliberately has no "human" value yet. Action payloads don't carry unit metadata, so claiming "human" would be the same guess in a new coat.
chainId integer
chainName string
decimals integer
isHumanReadable boolean
IsHumanReadable mirrors Requirement.AmountIsHumanReadable for Amount: true for values like "0.5", false for raw smallest-unit integers.
symbol string
requiredAmount string
source string
Enum: requiredTokens, fundsMovement.sent, fundsMovement.received, requiresGas
symbol string
tokenAddress string
unresolved boolean
unresolvedReason string
Enum: chainId, tokenAddress, parseError, template
walletAddress string
unresolved object[]
Array of:
amountIsHumanReadable boolean
amountIsPartial boolean
AmountIsPartial means RequiredAmount understates the true total for a reason OTHER than a runtime expression: an operand was dropped, or the amount is per-iteration inside a loop. Floor semantics apply (the number is a lower bound) but NO claim about a later step computing the remainder is true.
amountRuntimeDetermined boolean
AmountRuntimeDetermined is true when the leg's amount is wired to a runtime expression ({{...}}) rather than a literal, and could not be constant-folded. The leg's IDENTITY (chain + token) is fully resolved — only the SIZE is unknown until the workflow runs. Distinct from Unresolved, which means the identity itself could not be determined. When multiple legs sharing the same dedup key (wallet + chain + token) are merged (addOrMerge), this flag is true if ANY contributing leg was runtime-determined — even when another contributing leg supplied a literal amount. It is never cleared just because a literal amount is also present. FLOOR SEMANTICS: when this is true AND RequiredAmount is non-empty, the two fields are BOTH meaningful together: RequiredAmount is the sum of only the literal contributing legs — a known LOWER BOUND on the true requirement, not the total (the runtime-determined leg's own contribution is never invented). Treat RequiredAmount as "at least X" in this state. isInsufficient MAY still be computed against this floor and MAY be true — a balance below the floor is a genuine shortfall. A balance at or above the floor is UNKNOWN sufficiency, not proven sufficient.
amountUnit string
AmountUnit declares the unit of the amount when the analyzer KNOWS it, rather than inferring it from the string's shape. "raw" — smallest units (wei-like). ONLY the constant-fold sets this: it computes the integer itself, so it is the one producer that knows. "" — unknown. Consumers MUST print the value verbatim and MUST NOT rescale it by decimals. Deliberately has no "human" value yet. Action payloads don't carry unit metadata, so claiming "human" would be the same guess in a new coat.
chainId integer
chainName string
decimals integer
isNative boolean
nodeId string
nodeName string
nodeType string
reason string
receivedDisplay object
ReceivedDisplay is DISPLAY-ONLY context describing what the SAME node receives, attached only when this sent leg has no RequiredAmount of its own. See the ReceivedLegDisplay doc for the boundary it must not cross.
amount string
Amount is the received leg's resolved amount: a literal from the payload, or the exact constant-fold of an upstream literal-only convert-to-wei node. Never estimated.
amountUnit string
AmountUnit declares the unit of the amount when the analyzer KNOWS it, rather than inferring it from the string's shape. "raw" — smallest units (wei-like). ONLY the constant-fold sets this: it computes the integer itself, so it is the one producer that knows. "" — unknown. Consumers MUST print the value verbatim and MUST NOT rescale it by decimals. Deliberately has no "human" value yet. Action payloads don't carry unit metadata, so claiming "human" would be the same guess in a new coat.
chainId integer
chainName string
decimals integer
isHumanReadable boolean
IsHumanReadable mirrors Requirement.AmountIsHumanReadable for Amount: true for values like "0.5", false for raw smallest-unit integers.
symbol string
requiredAmount string
source string
Enum: requiredTokens, fundsMovement.sent, fundsMovement.received, requiresGas
symbol string
tokenAddress string
unresolved boolean
unresolvedReason string
Enum: chainId, tokenAddress, parseError, template
walletAddress string
workflowId string
workflowVersion integer
message string
requestId string
400 Bad request
404 Workflow not found 
curl -X GET 'https://api.example.com/v1/workflows/string/analyze-funds' \  -H 'Authorization: Bearer YOUR_API_TOKEN'
const response = await fetch('https://api.example.com/v1/workflows/string/analyze-funds', {  method: 'GET',  headers: {      "Authorization": "Bearer YOUR_API_TOKEN"  }});const data = await response.json();console.log(data);
import requestsheaders = {    'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.get('https://api.example.com/v1/workflows/string/analyze-funds', headers=headers)print(response.json())
package mainimport (	"fmt"	"io"	"net/http")func main() {	req, _ := http.NewRequest("GET", "https://api.example.com/v1/workflows/string/analyze-funds", nil)	req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")	resp, _ := http.DefaultClient.Do(req)	defer resp.Body.Close()	result, _ := io.ReadAll(resp.Body)	fmt.Println(string(result))}
200 Response 
{  "code": 200,  "data": {    "balancesFetched": true,    "requirements": [      {        "amountIsHumanReadable": true,        "amountIsPartial": true,        "amountRuntimeDetermined": true,        "amountUnit": "<string>",        "balance": {          "amount": "<string>",          "amountIsPartial": true,          "amountRuntimeDetermined": true,          "amountUsd": 123,          "chainId": 123,          "decimals": 123,          "isInsufficient": true,          "isLow": true,          "symbol": "<string>",          "tokenAddress": "<string>",          "walletAddress": "<string>"        },        "chainId": 123,        "chainName": "<string>",        "decimals": 123,        "isNative": true,        "nodeId": "<string>",        "nodeName": "<string>",        "nodeType": "<string>",        "reason": "<string>",        "receivedDisplay": {          "amount": "<string>",          "amountUnit": "<string>",          "chainId": 123,          "chainName": "<string>",          "decimals": 123,          "isHumanReadable": true,          "symbol": "<string>"        },        "requiredAmount": "<string>",        "source": "requiredTokens",        "symbol": "<string>",        "tokenAddress": "<string>",        "unresolved": true,        "unresolvedReason": "chainId",        "walletAddress": "<string>"      }    ],    "unresolved": [      {        "amountIsHumanReadable": true,        "amountIsPartial": true,        "amountRuntimeDetermined": true,        "amountUnit": "<string>",        "chainId": 123,        "chainName": "<string>",        "decimals": 123,        "isNative": true,        "nodeId": "<string>",        "nodeName": "<string>",        "nodeType": "<string>",        "reason": "<string>",        "receivedDisplay": {          "amount": "<string>",          "amountUnit": "<string>",          "chainId": 123,          "chainName": "<string>",          "decimals": 123,          "isHumanReadable": true,          "symbol": "<string>"        },        "requiredAmount": "<string>",        "source": "requiredTokens",        "symbol": "<string>",        "tokenAddress": "<string>",        "unresolved": true,        "unresolvedReason": "chainId",        "walletAddress": "<string>"      }    ],    "workflowId": "<string>",    "workflowVersion": 123  },  "message": "success",  "requestId": "abc-123"}
Previous DELETE /v1/workflows/{id}
Next GET /v1/workflows/{id}/draft