Prepare a withdrawal

POST/v1/users/{userId}/wallet/withdrawals

Builds the exact withdrawal contract for the given asset and amount, and opens the approval that stands for it. Nothing is signed and no key is touched: this only returns the terms to review and the fingerprint that wallets.confirmWithdrawal must echo back unchanged.

Authentication

Both headers are required.

Header: X-Api-Key: YOUR_API_KEY
Header: Authorization: Bearer YOUR_USER_TOKEN

Path parameters

userIdstring · uuidrequired

The user in the path; must equal the token's own account.

Validation rules

Format: "uuid"
Pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

Request body required

application/json · object

Additional properties are not allowed.

tokenIdstringrequired

Which asset to withdraw, as the provider identifies it: one of wallets.withdrawalSources' assets.

Validation rules

Minimum length: 1
Maximum length: 512

amountRawstringrequired

How much to withdraw, as a decimal string in the asset's smallest unit, never a float. Must be positive and no more than the current balance.

Validation rules

Maximum length: 160
Pattern: "^(0|[1-9]\\d*)$"

Request example

Illustrative request. Replace the host, credentials and resource IDs with your own. If a request file is shown, create it from the schema above. Review the requested action before sending it.

curl --request POST 'https://api.example.test/v1/users/YOUR_USER_ID/wallet/withdrawals' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Authorization: Bearer YOUR_USER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data-binary '@request.json'

Responses

200 The withdrawal's exact terms and the approval opened for them.

The withdrawal's exact terms and the approval opened for them.

application/json · object

operationIdstring · uuidrequired

This withdrawal's id; pass it to wallets.confirmWithdrawal.

Validation rules

Format: "uuid"
Pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

approvalIdstring · uuidrequired

The approval opened for this withdrawal; echo it back to confirm.

Validation rules

Format: "uuid"
Pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

fingerprintstringrequired

What wallets.confirmWithdrawal must echo back exactly, so confirming something other than what was reviewed here cannot happen.

expiresAtstring · date-timerequired

When this approval expires; confirm before then, or prepare again.

Validation rules

Format: "date-time"
Pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"

mainAccountIdstringrequired

The owner's main wallet account this withdrawal would pay out to.

contractoneOfrequired

The exact authorization contract this withdrawal runs under, precisely as the approval card shows it.

Show attributes

The exact authorization contract this withdrawal runs under, precisely as the approval card shows it.

oneOf · 1 variants

Variant 1 · type: near_intents_transfer

typestringrequired

Which contract template this is.

Validation rules

Allowed values: ["near_intents_transfer"]

actionsarrayrequired

The actions this contract authorizes, executed in order.

Show attributes

The actions this contract authorizes, executed in order.

Validation rules

Minimum items: 1
Maximum items: 16

Array items · oneOf

oneOf · 3 variants

Variant 1 · kind: swap

kindstringrequired

Exchange one asset for another; custody never leaves the agent wallet.

Validation rules

Allowed values: ["swap"]

inputanyOfrequired

The asset this action spends: pinned to one token, or any token the agent wallet holds.

Show attributes

The asset this action spends: pinned to one token, or any token the agent wallet holds.

anyOf · 2 variants

Variant 1 · object

pinnedobjectrequired

The exact token this asset is pinned to.

Show attributes

The exact token this asset is pinned to.

tokenIdstringrequired

The token's NEP-141 identifier.

Validation rules

Pattern: "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"

decimalsintegerrequired

How many decimal places the token's smallest unit represents.

Validation rules

Minimum: 0
Maximum: 38

Variant 2 · object

anybooleanrequired

Any token the agent wallet holds; the executor picks one at execution.

Validation rules

Allowed values: [true]

quantityoneOfrequired

How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.

Show attributes

How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.

oneOf · 5 variants

Variant 1 · kind: exact_input_tokens

Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw "5000000". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash.

kindstringrequired

Spend an exact amount of the input token.

Validation rules

Allowed values: ["exact_input_tokens"]

amountRawstringrequired

The exact input amount, in the input token's smallest unit.

Validation rules

Pattern: "^(0|[1-9]\\d{0,38})$"

Variant 2 · kind: exact_input_value_usd

Spend a USD-denominated value of the input token: "$5 worth of USDC" means value "5". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity.

kindstringrequired

Spend a USD-denominated value of the input token.

Validation rules

Allowed values: ["exact_input_value_usd"]

valuestringrequired

The USD value to spend, as a decimal string.

Validation rules

Pattern: "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"

Variant 3 · kind: exact_output_tokens

Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash.

kindstringrequired

Receive an exact amount of the output token.

Validation rules

Allowed values: ["exact_output_tokens"]

amountRawstringrequired

The exact output amount, in the output token's smallest unit.

Validation rules

Pattern: "^(0|[1-9]\\d{0,38})$"

Variant 4 · kind: all_of_input

kindstringrequired

Spend everything the agent wallet holds of the input asset.

Validation rules

Allowed values: ["all_of_input"]

Variant 5 · kind: fraction_of_input

kindstringrequired

Spend a fraction of the input asset.

Validation rules

Allowed values: ["fraction_of_input"]

bpsstringrequired

The fraction to spend, in basis points of the input asset.

Validation rules

Pattern: "^(0|[1-9]\\d{0,4})$"

outputanyOfrequired

The asset this action produces: pinned to one token, or left open.

Show attributes

The asset this action produces: pinned to one token, or left open.

anyOf · 2 variants

Variant 1 · object

pinnedobjectrequired

The exact token this asset is pinned to.

Show attributes

The exact token this asset is pinned to.

tokenIdstringrequired

The token's NEP-141 identifier.

Validation rules

Pattern: "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"

decimalsintegerrequired

How many decimal places the token's smallest unit represents.

Validation rules

Minimum: 0
Maximum: 38

Variant 2 · object

anybooleanrequired

Any token the agent wallet holds; the executor picks one at execution.

Validation rules

Allowed values: [true]

Variant 2 · kind: withdraw_to_owner

kindstringrequired

Return an asset to the account that owns the agent wallet.

Validation rules

Allowed values: ["withdraw_to_owner"]

inputanyOfrequired

The asset this action spends: pinned to one token, or any token the agent wallet holds.

Show attributes

The asset this action spends: pinned to one token, or any token the agent wallet holds.

anyOf · 2 variants

Variant 1 · object

pinnedobjectrequired

The exact token this asset is pinned to.

Show attributes

The exact token this asset is pinned to.

tokenIdstringrequired

The token's NEP-141 identifier.

Validation rules

Pattern: "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"

decimalsintegerrequired

How many decimal places the token's smallest unit represents.

Validation rules

Minimum: 0
Maximum: 38

Variant 2 · object

anybooleanrequired

Any token the agent wallet holds; the executor picks one at execution.

Validation rules

Allowed values: [true]

quantityoneOfrequired

How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.

Show attributes

How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.

oneOf · 5 variants

Variant 1 · kind: exact_input_tokens

kindstringrequired

Spend an exact amount of the input token.

Validation rules

Allowed values: ["exact_input_tokens"]

amountRawstringrequired

The exact input amount, in the input token's smallest unit.

Validation rules

Pattern: "^(0|[1-9]\\d{0,38})$"

Variant 2 · kind: exact_input_value_usd

kindstringrequired

Spend a USD-denominated value of the input token.

Validation rules

Allowed values: ["exact_input_value_usd"]

valuestringrequired

The USD value to spend, as a decimal string.

Validation rules

Pattern: "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"

Variant 3 · kind: exact_output_tokens

kindstringrequired

Receive an exact amount of the output token.

Validation rules

Allowed values: ["exact_output_tokens"]

amountRawstringrequired

The exact output amount, in the output token's smallest unit.

Validation rules

Pattern: "^(0|[1-9]\\d{0,38})$"

Variant 4 · kind: all_of_input

kindstringrequired

Spend everything the agent wallet holds of the input asset.

Validation rules

Allowed values: ["all_of_input"]

Variant 5 · kind: fraction_of_input

kindstringrequired

Spend a fraction of the input asset.

Validation rules

Allowed values: ["fraction_of_input"]

bpsstringrequired

The fraction to spend, in basis points of the input asset.

Validation rules

Pattern: "^(0|[1-9]\\d{0,4})$"

outputanyOfrequired

The asset this action produces: pinned to one token, or left open.

Show attributes

The asset this action produces: pinned to one token, or left open.

anyOf · 2 variants

Variant 1 · object

pinnedobjectrequired

The exact token this asset is pinned to.

Show attributes

The exact token this asset is pinned to.

tokenIdstringrequired

The token's NEP-141 identifier.

Validation rules

Pattern: "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"

decimalsintegerrequired

How many decimal places the token's smallest unit represents.

Validation rules

Minimum: 0
Maximum: 38

Variant 2 · object

anybooleanrequired

Any token the agent wallet holds; the executor picks one at execution.

Validation rules

Allowed values: [true]

Variant 3 · kind: send

kindstringrequired

Pay a pinned destination outside the agent wallet.

Validation rules

Allowed values: ["send"]

inputanyOfrequired

The asset this action spends: pinned to one token, or any token the agent wallet holds.

Show attributes

The asset this action spends: pinned to one token, or any token the agent wallet holds.

anyOf · 2 variants

Variant 1 · object

pinnedobjectrequired

The exact token this asset is pinned to.

Show attributes

The exact token this asset is pinned to.

tokenIdstringrequired

The token's NEP-141 identifier.

Validation rules

Pattern: "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"

decimalsintegerrequired

How many decimal places the token's smallest unit represents.

Validation rules

Minimum: 0
Maximum: 38

Variant 2 · object

anybooleanrequired

Any token the agent wallet holds; the executor picks one at execution.

Validation rules

Allowed values: [true]

quantityoneOfrequired

How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.

Show attributes

How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.

oneOf · 5 variants

Variant 1 · kind: exact_input_tokens

kindstringrequired

Spend an exact amount of the input token.

Validation rules

Allowed values: ["exact_input_tokens"]

amountRawstringrequired

The exact input amount, in the input token's smallest unit.

Validation rules

Pattern: "^(0|[1-9]\\d{0,38})$"

Variant 2 · kind: exact_input_value_usd

kindstringrequired

Spend a USD-denominated value of the input token.

Validation rules

Allowed values: ["exact_input_value_usd"]

valuestringrequired

The USD value to spend, as a decimal string.

Validation rules

Pattern: "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"

Variant 3 · kind: exact_output_tokens

kindstringrequired

Receive an exact amount of the output token.

Validation rules

Allowed values: ["exact_output_tokens"]

amountRawstringrequired

The exact output amount, in the output token's smallest unit.

Validation rules

Pattern: "^(0|[1-9]\\d{0,38})$"

Variant 4 · kind: all_of_input

kindstringrequired

Spend everything the agent wallet holds of the input asset.

Validation rules

Allowed values: ["all_of_input"]

Variant 5 · kind: fraction_of_input

kindstringrequired

Spend a fraction of the input asset.

Validation rules

Allowed values: ["fraction_of_input"]

bpsstringrequired

The fraction to spend, in basis points of the input asset.

Validation rules

Pattern: "^(0|[1-9]\\d{0,4})$"

outputanyOfrequired

The asset this action produces: pinned to one token, or left open.

Show attributes

The asset this action produces: pinned to one token, or left open.

anyOf · 2 variants

Variant 1 · object

pinnedobjectrequired

The exact token this asset is pinned to.

Show attributes

The exact token this asset is pinned to.

tokenIdstringrequired

The token's NEP-141 identifier.

Validation rules

Pattern: "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"

decimalsintegerrequired

How many decimal places the token's smallest unit represents.

Validation rules

Minimum: 0
Maximum: 38

Variant 2 · object

anybooleanrequired

Any token the agent wallet holds; the executor picks one at execution.

Validation rules

Allowed values: [true]

recipientobjectrequired

The pinned destination this action pays.

Show attributes

The pinned destination this action pays.

chainstringrequired

Which chain the destination address is on.

Validation rules

Minimum length: 1
Maximum length: 32

addressstringrequired

The destination address on that chain.

Validation rules

Pattern: "^[\\x21-\\x7e]{1,128}$"

validUntilstring · date-timerequired

When this contract's authority expires.

Validation rules

Format: "date-time"
Pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"

maxExecutionsintegerrequired

How many times this contract may be executed before it is exhausted.

Validation rules

Minimum: 1
Maximum: 10000

boundsobjectrequired

The value-loss and signature-lifetime limits every execution must respect.

Show attributes

The value-loss and signature-lifetime limits every execution must respect.

maxValueLossBpsstringrequired

The most value an execution may give up to price movement and fees together, in basis points.

Validation rules

Pattern: "^(0|[1-9]\\d{0,4})$"

maxSignatureLifetimeSecondsintegerrequired

Explicit maximum lifetime of each released transfer signature, in seconds. 1Click confidential swaps require up to 259500 seconds (72 hours 5 minutes). This does not extend the short execution window or approval validity.

Validation rules

Minimum: 1
Maximum: 259500

400 The request could not be read as this operation expects.

The request could not be read as this operation expects.

invalid_input — the body or query failed validation; issues names each field
invalid_cursor — the cursor is not one this list minted

application/problem+json · object

RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.

typestringrequired

The kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it

titlestringrequired

The kind's human title, for logs; never parse it

statusintegerrequired

The HTTP status, repeated in the body

Validation rules

Minimum: 400
Maximum: 599

reasonstringoptional

The machine-readable why. One of:

run_active (409) — a run already holds this conversation
budget_exhausted (409) — the user's spend headroom is gone, or an operator froze it
approval_not_pending (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation
execution_capacity (409) — no execution capacity is free right now; retryable says whether to try again
execution_unavailable (409) — the execution engine could not take the work
stop_pending (409) — a stop is already in progress and its cleanup is not yet confirmed
automation_changed (409) — the revision sent is stale; reload the automation
automation_held (409) — an operator holds the automation; it fires again when released
automation_invalid (409) — the automation's definition cannot run as written
automation_completed (409) — the automation has finished for good and cannot fire again
automation_limit (409) — the user already has as many automations as the deployment allows
profile_unknown_tool (409) — the run profile names a tool this deployment does not have
deployment_paused (409) — an operator paused a deployment control; nothing was admitted or fired
run_not_active (409) — the run named in the path is not the conversation's live run
withdrawal_changed (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress
credential_expired (401) — the user token has expired; obtain a fresh one
account_disabled (403) — an operator disabled the account
account_not_provisioned (412) — the identity is verified but has no account yet; call users.ensure first
provider_unavailable (503) — an external provider the call depends on did not answer
engine_unavailable (503) — the execution engine did not answer
invalid_input (400) — the body or query failed validation; issues names each field
internal (500) — a fault on our side; quote requestId when reporting it
partner_key_required (401) — no X-Api-Key header was sent
partner_key_invalid (401) — the X-Api-Key is unknown or revoked
subject_mismatch (403) — the {userId} in the path is not the token's user
origin_rejected (403) — a browser Origin other than the configured web origin
permission_required (403) — the operator credential lacks the scope this call needs
rate_limited (429) — the per-key or per-user limit is spent; honour Retry-After
stream_capacity (429) — no stream socket is free on this replica or for this user; honour Retry-After
invalid_cursor (400) — the cursor is not one this list minted

Validation rules

Allowed values: ["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]

requestIdstringrequired

The id Fin used for this request; quote it when reporting a problem

retryablebooleanrequired

Whether repeating the same request later can succeed without changing it

detailstringoptional

Only on invalid_input: which part of the request failed validation

issuesarrayoptional

Only on invalid_input: one entry per failing field

Show attributes

Only on invalid_input: one entry per failing field

Array items · object

pathstringrequired

The JSON pointer of the failing field; empty for the root object

messagestringrequired

Why the field failed

401 A credential is missing, invalid or expired.

A credential is missing, invalid or expired.

partner_key_required — no X-Api-Key header was sent
partner_key_invalid — the X-Api-Key is unknown or revoked
credential_expired — the user token has expired; obtain a fresh one

application/problem+json · object

RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.

typestringrequired

The kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it

titlestringrequired

The kind's human title, for logs; never parse it

statusintegerrequired

The HTTP status, repeated in the body

Validation rules

Minimum: 400
Maximum: 599

reasonstringoptional

The machine-readable why. One of:

run_active (409) — a run already holds this conversation
budget_exhausted (409) — the user's spend headroom is gone, or an operator froze it
approval_not_pending (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation
execution_capacity (409) — no execution capacity is free right now; retryable says whether to try again
execution_unavailable (409) — the execution engine could not take the work
stop_pending (409) — a stop is already in progress and its cleanup is not yet confirmed
automation_changed (409) — the revision sent is stale; reload the automation
automation_held (409) — an operator holds the automation; it fires again when released
automation_invalid (409) — the automation's definition cannot run as written
automation_completed (409) — the automation has finished for good and cannot fire again
automation_limit (409) — the user already has as many automations as the deployment allows
profile_unknown_tool (409) — the run profile names a tool this deployment does not have
deployment_paused (409) — an operator paused a deployment control; nothing was admitted or fired
run_not_active (409) — the run named in the path is not the conversation's live run
withdrawal_changed (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress
credential_expired (401) — the user token has expired; obtain a fresh one
account_disabled (403) — an operator disabled the account
account_not_provisioned (412) — the identity is verified but has no account yet; call users.ensure first
provider_unavailable (503) — an external provider the call depends on did not answer
engine_unavailable (503) — the execution engine did not answer
invalid_input (400) — the body or query failed validation; issues names each field
internal (500) — a fault on our side; quote requestId when reporting it
partner_key_required (401) — no X-Api-Key header was sent
partner_key_invalid (401) — the X-Api-Key is unknown or revoked
subject_mismatch (403) — the {userId} in the path is not the token's user
origin_rejected (403) — a browser Origin other than the configured web origin
permission_required (403) — the operator credential lacks the scope this call needs
rate_limited (429) — the per-key or per-user limit is spent; honour Retry-After
stream_capacity (429) — no stream socket is free on this replica or for this user; honour Retry-After
invalid_cursor (400) — the cursor is not one this list minted

Validation rules

Allowed values: ["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]

requestIdstringrequired

The id Fin used for this request; quote it when reporting a problem

retryablebooleanrequired

Whether repeating the same request later can succeed without changing it

detailstringoptional

Only on invalid_input: which part of the request failed validation

issuesarrayoptional

Only on invalid_input: one entry per failing field

Show attributes

Only on invalid_input: one entry per failing field

Array items · object

pathstringrequired

The JSON pointer of the failing field; empty for the root object

messagestringrequired

Why the field failed

403 The credentials are valid but may not do this.

The credentials are valid but may not do this.

subject_mismatch — the {userId} in the path is not the token's user
account_disabled — an operator disabled the account
origin_rejected — a browser Origin other than the configured web origin

application/problem+json · object

RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.

typestringrequired

The kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it

titlestringrequired

The kind's human title, for logs; never parse it

statusintegerrequired

The HTTP status, repeated in the body

Validation rules

Minimum: 400
Maximum: 599

reasonstringoptional

The machine-readable why. One of:

run_active (409) — a run already holds this conversation
budget_exhausted (409) — the user's spend headroom is gone, or an operator froze it
approval_not_pending (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation
execution_capacity (409) — no execution capacity is free right now; retryable says whether to try again
execution_unavailable (409) — the execution engine could not take the work
stop_pending (409) — a stop is already in progress and its cleanup is not yet confirmed
automation_changed (409) — the revision sent is stale; reload the automation
automation_held (409) — an operator holds the automation; it fires again when released
automation_invalid (409) — the automation's definition cannot run as written
automation_completed (409) — the automation has finished for good and cannot fire again
automation_limit (409) — the user already has as many automations as the deployment allows
profile_unknown_tool (409) — the run profile names a tool this deployment does not have
deployment_paused (409) — an operator paused a deployment control; nothing was admitted or fired
run_not_active (409) — the run named in the path is not the conversation's live run
withdrawal_changed (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress
credential_expired (401) — the user token has expired; obtain a fresh one
account_disabled (403) — an operator disabled the account
account_not_provisioned (412) — the identity is verified but has no account yet; call users.ensure first
provider_unavailable (503) — an external provider the call depends on did not answer
engine_unavailable (503) — the execution engine did not answer
invalid_input (400) — the body or query failed validation; issues names each field
internal (500) — a fault on our side; quote requestId when reporting it
partner_key_required (401) — no X-Api-Key header was sent
partner_key_invalid (401) — the X-Api-Key is unknown or revoked
subject_mismatch (403) — the {userId} in the path is not the token's user
origin_rejected (403) — a browser Origin other than the configured web origin
permission_required (403) — the operator credential lacks the scope this call needs
rate_limited (429) — the per-key or per-user limit is spent; honour Retry-After
stream_capacity (429) — no stream socket is free on this replica or for this user; honour Retry-After
invalid_cursor (400) — the cursor is not one this list minted

Validation rules

Allowed values: ["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]

requestIdstringrequired

The id Fin used for this request; quote it when reporting a problem

retryablebooleanrequired

Whether repeating the same request later can succeed without changing it

detailstringoptional

Only on invalid_input: which part of the request failed validation

issuesarrayoptional

Only on invalid_input: one entry per failing field

Show attributes

Only on invalid_input: one entry per failing field

Array items · object

pathstringrequired

The JSON pointer of the failing field; empty for the root object

messagestringrequired

Why the field failed

404 The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.

The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.

application/problem+json · object

RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.

typestringrequired

The kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it

titlestringrequired

The kind's human title, for logs; never parse it

statusintegerrequired

The HTTP status, repeated in the body

Validation rules

Minimum: 400
Maximum: 599

reasonstringoptional

The machine-readable why. One of:

run_active (409) — a run already holds this conversation
budget_exhausted (409) — the user's spend headroom is gone, or an operator froze it
approval_not_pending (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation
execution_capacity (409) — no execution capacity is free right now; retryable says whether to try again
execution_unavailable (409) — the execution engine could not take the work
stop_pending (409) — a stop is already in progress and its cleanup is not yet confirmed
automation_changed (409) — the revision sent is stale; reload the automation
automation_held (409) — an operator holds the automation; it fires again when released
automation_invalid (409) — the automation's definition cannot run as written
automation_completed (409) — the automation has finished for good and cannot fire again
automation_limit (409) — the user already has as many automations as the deployment allows
profile_unknown_tool (409) — the run profile names a tool this deployment does not have
deployment_paused (409) — an operator paused a deployment control; nothing was admitted or fired
run_not_active (409) — the run named in the path is not the conversation's live run
withdrawal_changed (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress
credential_expired (401) — the user token has expired; obtain a fresh one
account_disabled (403) — an operator disabled the account
account_not_provisioned (412) — the identity is verified but has no account yet; call users.ensure first
provider_unavailable (503) — an external provider the call depends on did not answer
engine_unavailable (503) — the execution engine did not answer
invalid_input (400) — the body or query failed validation; issues names each field
internal (500) — a fault on our side; quote requestId when reporting it
partner_key_required (401) — no X-Api-Key header was sent
partner_key_invalid (401) — the X-Api-Key is unknown or revoked
subject_mismatch (403) — the {userId} in the path is not the token's user
origin_rejected (403) — a browser Origin other than the configured web origin
permission_required (403) — the operator credential lacks the scope this call needs
rate_limited (429) — the per-key or per-user limit is spent; honour Retry-After
stream_capacity (429) — no stream socket is free on this replica or for this user; honour Retry-After
invalid_cursor (400) — the cursor is not one this list minted

Validation rules

Allowed values: ["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]

requestIdstringrequired

The id Fin used for this request; quote it when reporting a problem

retryablebooleanrequired

Whether repeating the same request later can succeed without changing it

detailstringoptional

Only on invalid_input: which part of the request failed validation

issuesarrayoptional

Only on invalid_input: one entry per failing field

Show attributes

Only on invalid_input: one entry per failing field

Array items · object

pathstringrequired

The JSON pointer of the failing field; empty for the root object

messagestringrequired

Why the field failed

409 The operation lost to the current state.

The operation lost to the current state.

withdrawal_changed — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress

application/problem+json · object

RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.

typestringrequired

The kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it

titlestringrequired

The kind's human title, for logs; never parse it

statusintegerrequired

The HTTP status, repeated in the body

Validation rules

Minimum: 400
Maximum: 599

reasonstringoptional

The machine-readable why. One of:

run_active (409) — a run already holds this conversation
budget_exhausted (409) — the user's spend headroom is gone, or an operator froze it
approval_not_pending (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation
execution_capacity (409) — no execution capacity is free right now; retryable says whether to try again
execution_unavailable (409) — the execution engine could not take the work
stop_pending (409) — a stop is already in progress and its cleanup is not yet confirmed
automation_changed (409) — the revision sent is stale; reload the automation
automation_held (409) — an operator holds the automation; it fires again when released
automation_invalid (409) — the automation's definition cannot run as written
automation_completed (409) — the automation has finished for good and cannot fire again
automation_limit (409) — the user already has as many automations as the deployment allows
profile_unknown_tool (409) — the run profile names a tool this deployment does not have
deployment_paused (409) — an operator paused a deployment control; nothing was admitted or fired
run_not_active (409) — the run named in the path is not the conversation's live run
withdrawal_changed (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress
credential_expired (401) — the user token has expired; obtain a fresh one
account_disabled (403) — an operator disabled the account
account_not_provisioned (412) — the identity is verified but has no account yet; call users.ensure first
provider_unavailable (503) — an external provider the call depends on did not answer
engine_unavailable (503) — the execution engine did not answer
invalid_input (400) — the body or query failed validation; issues names each field
internal (500) — a fault on our side; quote requestId when reporting it
partner_key_required (401) — no X-Api-Key header was sent
partner_key_invalid (401) — the X-Api-Key is unknown or revoked
subject_mismatch (403) — the {userId} in the path is not the token's user
origin_rejected (403) — a browser Origin other than the configured web origin
permission_required (403) — the operator credential lacks the scope this call needs
rate_limited (429) — the per-key or per-user limit is spent; honour Retry-After
stream_capacity (429) — no stream socket is free on this replica or for this user; honour Retry-After
invalid_cursor (400) — the cursor is not one this list minted

Validation rules

Allowed values: ["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]

requestIdstringrequired

The id Fin used for this request; quote it when reporting a problem

retryablebooleanrequired

Whether repeating the same request later can succeed without changing it

detailstringoptional

Only on invalid_input: which part of the request failed validation

issuesarrayoptional

Only on invalid_input: one entry per failing field

Show attributes

Only on invalid_input: one entry per failing field

Array items · object

pathstringrequired

The JSON pointer of the failing field; empty for the root object

messagestringrequired

Why the field failed

412 The identity is verified but has no account yet.

The identity is verified but has no account yet.

account_not_provisioned — the identity is verified but has no account yet; call users.ensure first

application/problem+json · object

RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.

typestringrequired

The kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it

titlestringrequired

The kind's human title, for logs; never parse it

statusintegerrequired

The HTTP status, repeated in the body

Validation rules

Minimum: 400
Maximum: 599

reasonstringoptional

The machine-readable why. One of:

run_active (409) — a run already holds this conversation
budget_exhausted (409) — the user's spend headroom is gone, or an operator froze it
approval_not_pending (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation
execution_capacity (409) — no execution capacity is free right now; retryable says whether to try again
execution_unavailable (409) — the execution engine could not take the work
stop_pending (409) — a stop is already in progress and its cleanup is not yet confirmed
automation_changed (409) — the revision sent is stale; reload the automation
automation_held (409) — an operator holds the automation; it fires again when released
automation_invalid (409) — the automation's definition cannot run as written
automation_completed (409) — the automation has finished for good and cannot fire again
automation_limit (409) — the user already has as many automations as the deployment allows
profile_unknown_tool (409) — the run profile names a tool this deployment does not have
deployment_paused (409) — an operator paused a deployment control; nothing was admitted or fired
run_not_active (409) — the run named in the path is not the conversation's live run
withdrawal_changed (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress
credential_expired (401) — the user token has expired; obtain a fresh one
account_disabled (403) — an operator disabled the account
account_not_provisioned (412) — the identity is verified but has no account yet; call users.ensure first
provider_unavailable (503) — an external provider the call depends on did not answer
engine_unavailable (503) — the execution engine did not answer
invalid_input (400) — the body or query failed validation; issues names each field
internal (500) — a fault on our side; quote requestId when reporting it
partner_key_required (401) — no X-Api-Key header was sent
partner_key_invalid (401) — the X-Api-Key is unknown or revoked
subject_mismatch (403) — the {userId} in the path is not the token's user
origin_rejected (403) — a browser Origin other than the configured web origin
permission_required (403) — the operator credential lacks the scope this call needs
rate_limited (429) — the per-key or per-user limit is spent; honour Retry-After
stream_capacity (429) — no stream socket is free on this replica or for this user; honour Retry-After
invalid_cursor (400) — the cursor is not one this list minted

Validation rules

Allowed values: ["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]

requestIdstringrequired

The id Fin used for this request; quote it when reporting a problem

retryablebooleanrequired

Whether repeating the same request later can succeed without changing it

detailstringoptional

Only on invalid_input: which part of the request failed validation

issuesarrayoptional

Only on invalid_input: one entry per failing field

Show attributes

Only on invalid_input: one entry per failing field

Array items · object

pathstringrequired

The JSON pointer of the failing field; empty for the root object

messagestringrequired

Why the field failed

413 The body exceeds the size this deployment accepts.

The body exceeds the size this deployment accepts.

application/problem+json · object

RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.

typestringrequired

The kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it

titlestringrequired

The kind's human title, for logs; never parse it

statusintegerrequired

The HTTP status, repeated in the body

Validation rules

Minimum: 400
Maximum: 599

reasonstringoptional

The machine-readable why. One of:

run_active (409) — a run already holds this conversation
budget_exhausted (409) — the user's spend headroom is gone, or an operator froze it
approval_not_pending (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation
execution_capacity (409) — no execution capacity is free right now; retryable says whether to try again
execution_unavailable (409) — the execution engine could not take the work
stop_pending (409) — a stop is already in progress and its cleanup is not yet confirmed
automation_changed (409) — the revision sent is stale; reload the automation
automation_held (409) — an operator holds the automation; it fires again when released
automation_invalid (409) — the automation's definition cannot run as written
automation_completed (409) — the automation has finished for good and cannot fire again
automation_limit (409) — the user already has as many automations as the deployment allows
profile_unknown_tool (409) — the run profile names a tool this deployment does not have
deployment_paused (409) — an operator paused a deployment control; nothing was admitted or fired
run_not_active (409) — the run named in the path is not the conversation's live run
withdrawal_changed (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress
credential_expired (401) — the user token has expired; obtain a fresh one
account_disabled (403) — an operator disabled the account
account_not_provisioned (412) — the identity is verified but has no account yet; call users.ensure first
provider_unavailable (503) — an external provider the call depends on did not answer
engine_unavailable (503) — the execution engine did not answer
invalid_input (400) — the body or query failed validation; issues names each field
internal (500) — a fault on our side; quote requestId when reporting it
partner_key_required (401) — no X-Api-Key header was sent
partner_key_invalid (401) — the X-Api-Key is unknown or revoked
subject_mismatch (403) — the {userId} in the path is not the token's user
origin_rejected (403) — a browser Origin other than the configured web origin
permission_required (403) — the operator credential lacks the scope this call needs
rate_limited (429) — the per-key or per-user limit is spent; honour Retry-After
stream_capacity (429) — no stream socket is free on this replica or for this user; honour Retry-After
invalid_cursor (400) — the cursor is not one this list minted

Validation rules

Allowed values: ["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]

requestIdstringrequired

The id Fin used for this request; quote it when reporting a problem

retryablebooleanrequired

Whether repeating the same request later can succeed without changing it

detailstringoptional

Only on invalid_input: which part of the request failed validation

issuesarrayoptional

Only on invalid_input: one entry per failing field

Show attributes

Only on invalid_input: one entry per failing field

Array items · object

pathstringrequired

The JSON pointer of the failing field; empty for the root object

messagestringrequired

Why the field failed

429 A limiter refused the request; honour `Retry-After`.

A limiter refused the request; honour Retry-After.

rate_limited — the per-key or per-user limit is spent; honour Retry-After

application/problem+json · object

RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.

typestringrequired

The kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it

titlestringrequired

The kind's human title, for logs; never parse it

statusintegerrequired

The HTTP status, repeated in the body

Validation rules

Minimum: 400
Maximum: 599

reasonstringoptional

The machine-readable why. One of:

run_active (409) — a run already holds this conversation
budget_exhausted (409) — the user's spend headroom is gone, or an operator froze it
approval_not_pending (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation
execution_capacity (409) — no execution capacity is free right now; retryable says whether to try again
execution_unavailable (409) — the execution engine could not take the work
stop_pending (409) — a stop is already in progress and its cleanup is not yet confirmed
automation_changed (409) — the revision sent is stale; reload the automation
automation_held (409) — an operator holds the automation; it fires again when released
automation_invalid (409) — the automation's definition cannot run as written
automation_completed (409) — the automation has finished for good and cannot fire again
automation_limit (409) — the user already has as many automations as the deployment allows
profile_unknown_tool (409) — the run profile names a tool this deployment does not have
deployment_paused (409) — an operator paused a deployment control; nothing was admitted or fired
run_not_active (409) — the run named in the path is not the conversation's live run
withdrawal_changed (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress
credential_expired (401) — the user token has expired; obtain a fresh one
account_disabled (403) — an operator disabled the account
account_not_provisioned (412) — the identity is verified but has no account yet; call users.ensure first
provider_unavailable (503) — an external provider the call depends on did not answer
engine_unavailable (503) — the execution engine did not answer
invalid_input (400) — the body or query failed validation; issues names each field
internal (500) — a fault on our side; quote requestId when reporting it
partner_key_required (401) — no X-Api-Key header was sent
partner_key_invalid (401) — the X-Api-Key is unknown or revoked
subject_mismatch (403) — the {userId} in the path is not the token's user
origin_rejected (403) — a browser Origin other than the configured web origin
permission_required (403) — the operator credential lacks the scope this call needs
rate_limited (429) — the per-key or per-user limit is spent; honour Retry-After
stream_capacity (429) — no stream socket is free on this replica or for this user; honour Retry-After
invalid_cursor (400) — the cursor is not one this list minted

Validation rules

Allowed values: ["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]

requestIdstringrequired

The id Fin used for this request; quote it when reporting a problem

retryablebooleanrequired

Whether repeating the same request later can succeed without changing it

detailstringoptional

Only on invalid_input: which part of the request failed validation

issuesarrayoptional

Only on invalid_input: one entry per failing field

Show attributes

Only on invalid_input: one entry per failing field

Array items · object

pathstringrequired

The JSON pointer of the failing field; empty for the root object

messagestringrequired

Why the field failed

500 A fault on our side; quote `requestId` when reporting it.

A fault on our side; quote requestId when reporting it.

internal — a fault on our side; quote requestId when reporting it

application/problem+json · object

RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.

typestringrequired

The kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it

titlestringrequired

The kind's human title, for logs; never parse it

statusintegerrequired

The HTTP status, repeated in the body

Validation rules

Minimum: 400
Maximum: 599

reasonstringoptional

The machine-readable why. One of:

run_active (409) — a run already holds this conversation
budget_exhausted (409) — the user's spend headroom is gone, or an operator froze it
approval_not_pending (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation
execution_capacity (409) — no execution capacity is free right now; retryable says whether to try again
execution_unavailable (409) — the execution engine could not take the work
stop_pending (409) — a stop is already in progress and its cleanup is not yet confirmed
automation_changed (409) — the revision sent is stale; reload the automation
automation_held (409) — an operator holds the automation; it fires again when released
automation_invalid (409) — the automation's definition cannot run as written
automation_completed (409) — the automation has finished for good and cannot fire again
automation_limit (409) — the user already has as many automations as the deployment allows
profile_unknown_tool (409) — the run profile names a tool this deployment does not have
deployment_paused (409) — an operator paused a deployment control; nothing was admitted or fired
run_not_active (409) — the run named in the path is not the conversation's live run
withdrawal_changed (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress
credential_expired (401) — the user token has expired; obtain a fresh one
account_disabled (403) — an operator disabled the account
account_not_provisioned (412) — the identity is verified but has no account yet; call users.ensure first
provider_unavailable (503) — an external provider the call depends on did not answer
engine_unavailable (503) — the execution engine did not answer
invalid_input (400) — the body or query failed validation; issues names each field
internal (500) — a fault on our side; quote requestId when reporting it
partner_key_required (401) — no X-Api-Key header was sent
partner_key_invalid (401) — the X-Api-Key is unknown or revoked
subject_mismatch (403) — the {userId} in the path is not the token's user
origin_rejected (403) — a browser Origin other than the configured web origin
permission_required (403) — the operator credential lacks the scope this call needs
rate_limited (429) — the per-key or per-user limit is spent; honour Retry-After
stream_capacity (429) — no stream socket is free on this replica or for this user; honour Retry-After
invalid_cursor (400) — the cursor is not one this list minted

Validation rules

Allowed values: ["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]

requestIdstringrequired

The id Fin used for this request; quote it when reporting a problem

retryablebooleanrequired

Whether repeating the same request later can succeed without changing it

detailstringoptional

Only on invalid_input: which part of the request failed validation

issuesarrayoptional

Only on invalid_input: one entry per failing field

Show attributes

Only on invalid_input: one entry per failing field

Array items · object

pathstringrequired

The JSON pointer of the failing field; empty for the root object

messagestringrequired

Why the field failed

503 The replica is draining or a dependency did not answer; `retryable` says whether to try again.

The replica is draining or a dependency did not answer; retryable says whether to try again.

internal — a fault on our side; quote requestId when reporting it
provider_unavailable — an external provider the call depends on did not answer

application/problem+json · object

RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.

typestringrequired

The kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it

titlestringrequired

The kind's human title, for logs; never parse it

statusintegerrequired

The HTTP status, repeated in the body

Validation rules

Minimum: 400
Maximum: 599

reasonstringoptional

The machine-readable why. One of:

run_active (409) — a run already holds this conversation
budget_exhausted (409) — the user's spend headroom is gone, or an operator froze it
approval_not_pending (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation
execution_capacity (409) — no execution capacity is free right now; retryable says whether to try again
execution_unavailable (409) — the execution engine could not take the work
stop_pending (409) — a stop is already in progress and its cleanup is not yet confirmed
automation_changed (409) — the revision sent is stale; reload the automation
automation_held (409) — an operator holds the automation; it fires again when released
automation_invalid (409) — the automation's definition cannot run as written
automation_completed (409) — the automation has finished for good and cannot fire again
automation_limit (409) — the user already has as many automations as the deployment allows
profile_unknown_tool (409) — the run profile names a tool this deployment does not have
deployment_paused (409) — an operator paused a deployment control; nothing was admitted or fired
run_not_active (409) — the run named in the path is not the conversation's live run
withdrawal_changed (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress
credential_expired (401) — the user token has expired; obtain a fresh one
account_disabled (403) — an operator disabled the account
account_not_provisioned (412) — the identity is verified but has no account yet; call users.ensure first
provider_unavailable (503) — an external provider the call depends on did not answer
engine_unavailable (503) — the execution engine did not answer
invalid_input (400) — the body or query failed validation; issues names each field
internal (500) — a fault on our side; quote requestId when reporting it
partner_key_required (401) — no X-Api-Key header was sent
partner_key_invalid (401) — the X-Api-Key is unknown or revoked
subject_mismatch (403) — the {userId} in the path is not the token's user
origin_rejected (403) — a browser Origin other than the configured web origin
permission_required (403) — the operator credential lacks the scope this call needs
rate_limited (429) — the per-key or per-user limit is spent; honour Retry-After
stream_capacity (429) — no stream socket is free on this replica or for this user; honour Retry-After
invalid_cursor (400) — the cursor is not one this list minted

Validation rules

Allowed values: ["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]

requestIdstringrequired

The id Fin used for this request; quote it when reporting a problem

retryablebooleanrequired

Whether repeating the same request later can succeed without changing it

detailstringoptional

Only on invalid_input: which part of the request failed validation

issuesarrayoptional

Only on invalid_input: one entry per failing field

Show attributes

Only on invalid_input: one entry per failing field

Array items · object

pathstringrequired

The JSON pointer of the failing field; empty for the root object

messagestringrequired

Why the field failed

Complete OpenAPI definition

The exact operation and all referenced components, including recursive schemas.

{
  "operation": {
    "operationId": "wallets.prepareWithdrawal",
    "summary": "Prepare a withdrawal",
    "tags": [
      "wallets"
    ],
    "description": "Builds the exact withdrawal contract for the given asset and amount, and opens the approval that stands for it. Nothing is signed and no key is touched: this only returns the terms to review and the `fingerprint` that `wallets.confirmWithdrawal` must echo back unchanged.",
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "tokenId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 512,
                "description": "Which asset to withdraw, as the provider identifies it: one of `wallets.withdrawalSources`' assets."
              },
              "amountRaw": {
                "type": "string",
                "maxLength": 160,
                "pattern": "^(0|[1-9]\\d*)$",
                "description": "How much to withdraw, as a decimal string in the asset's smallest unit, never a float. Must be positive and no more than the current balance."
              }
            },
            "required": [
              "tokenId",
              "amountRaw"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "parameters": [
      {
        "schema": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "in": "path",
        "name": "userId",
        "required": true,
        "description": "The user in the path; must equal the token's own account."
      }
    ],
    "security": [
      {
        "apiKey": [],
        "userToken": []
      }
    ],
    "responses": {
      "200": {
        "description": "The withdrawal's exact terms and the approval opened for them.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "operationId": {
                  "type": "string",
                  "format": "uuid",
                  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
                  "description": "This withdrawal's id; pass it to `wallets.confirmWithdrawal`."
                },
                "approvalId": {
                  "type": "string",
                  "format": "uuid",
                  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
                  "description": "The approval opened for this withdrawal; echo it back to confirm."
                },
                "fingerprint": {
                  "type": "string",
                  "description": "What `wallets.confirmWithdrawal` must echo back exactly, so confirming something other than what was reviewed here cannot happen."
                },
                "expiresAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
                  "description": "When this approval expires; confirm before then, or prepare again."
                },
                "mainAccountId": {
                  "type": "string",
                  "description": "The owner's main wallet account this withdrawal would pay out to."
                },
                "contract": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "description": "Which contract template this is.",
                          "enum": [
                            "near_intents_transfer"
                          ]
                        },
                        "actions": {
                          "minItems": 1,
                          "maxItems": 16,
                          "type": "array",
                          "items": {
                            "oneOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "description": "Exchange one asset for another; custody never leaves the agent wallet.",
                                    "enum": [
                                      "swap"
                                    ]
                                  },
                                  "input": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "pinned": {
                                            "type": "object",
                                            "properties": {
                                              "tokenId": {
                                                "type": "string",
                                                "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
                                                "description": "The token's NEP-141 identifier."
                                              },
                                              "decimals": {
                                                "type": "integer",
                                                "minimum": 0,
                                                "maximum": 38,
                                                "description": "How many decimal places the token's smallest unit represents."
                                              }
                                            },
                                            "required": [
                                              "tokenId",
                                              "decimals"
                                            ],
                                            "description": "The exact token this asset is pinned to."
                                          }
                                        },
                                        "required": [
                                          "pinned"
                                        ]
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "any": {
                                            "type": "boolean",
                                            "description": "Any token the agent wallet holds; the executor picks one at execution.",
                                            "enum": [
                                              true
                                            ]
                                          }
                                        },
                                        "required": [
                                          "any"
                                        ]
                                      }
                                    ],
                                    "description": "The asset this action spends: pinned to one token, or any token the agent wallet holds."
                                  },
                                  "quantity": {
                                    "oneOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend an exact amount of the input token.",
                                            "enum": [
                                              "exact_input_tokens"
                                            ]
                                          },
                                          "amountRaw": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,38})$",
                                            "description": "The exact input amount, in the input token's smallest unit."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "amountRaw"
                                        ],
                                        "description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash."
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend a USD-denominated value of the input token.",
                                            "enum": [
                                              "exact_input_value_usd"
                                            ]
                                          },
                                          "value": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
                                            "description": "The USD value to spend, as a decimal string."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "value"
                                        ],
                                        "description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity."
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Receive an exact amount of the output token.",
                                            "enum": [
                                              "exact_output_tokens"
                                            ]
                                          },
                                          "amountRaw": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,38})$",
                                            "description": "The exact output amount, in the output token's smallest unit."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "amountRaw"
                                        ],
                                        "description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash."
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend everything the agent wallet holds of the input asset.",
                                            "enum": [
                                              "all_of_input"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "kind"
                                        ]
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend a fraction of the input asset.",
                                            "enum": [
                                              "fraction_of_input"
                                            ]
                                          },
                                          "bps": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,4})$",
                                            "description": "The fraction to spend, in basis points of the input asset."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "bps"
                                        ]
                                      }
                                    ],
                                    "description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
                                  },
                                  "output": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "pinned": {
                                            "type": "object",
                                            "properties": {
                                              "tokenId": {
                                                "type": "string",
                                                "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
                                                "description": "The token's NEP-141 identifier."
                                              },
                                              "decimals": {
                                                "type": "integer",
                                                "minimum": 0,
                                                "maximum": 38,
                                                "description": "How many decimal places the token's smallest unit represents."
                                              }
                                            },
                                            "required": [
                                              "tokenId",
                                              "decimals"
                                            ],
                                            "description": "The exact token this asset is pinned to."
                                          }
                                        },
                                        "required": [
                                          "pinned"
                                        ]
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "any": {
                                            "type": "boolean",
                                            "description": "Any token the agent wallet holds; the executor picks one at execution.",
                                            "enum": [
                                              true
                                            ]
                                          }
                                        },
                                        "required": [
                                          "any"
                                        ]
                                      }
                                    ],
                                    "description": "The asset this action produces: pinned to one token, or left open."
                                  }
                                },
                                "required": [
                                  "kind",
                                  "input",
                                  "quantity",
                                  "output"
                                ]
                              },
                              {
                                "type": "object",
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "description": "Return an asset to the account that owns the agent wallet.",
                                    "enum": [
                                      "withdraw_to_owner"
                                    ]
                                  },
                                  "input": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "pinned": {
                                            "type": "object",
                                            "properties": {
                                              "tokenId": {
                                                "type": "string",
                                                "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
                                                "description": "The token's NEP-141 identifier."
                                              },
                                              "decimals": {
                                                "type": "integer",
                                                "minimum": 0,
                                                "maximum": 38,
                                                "description": "How many decimal places the token's smallest unit represents."
                                              }
                                            },
                                            "required": [
                                              "tokenId",
                                              "decimals"
                                            ],
                                            "description": "The exact token this asset is pinned to."
                                          }
                                        },
                                        "required": [
                                          "pinned"
                                        ]
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "any": {
                                            "type": "boolean",
                                            "description": "Any token the agent wallet holds; the executor picks one at execution.",
                                            "enum": [
                                              true
                                            ]
                                          }
                                        },
                                        "required": [
                                          "any"
                                        ]
                                      }
                                    ],
                                    "description": "The asset this action spends: pinned to one token, or any token the agent wallet holds."
                                  },
                                  "quantity": {
                                    "oneOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend an exact amount of the input token.",
                                            "enum": [
                                              "exact_input_tokens"
                                            ]
                                          },
                                          "amountRaw": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,38})$",
                                            "description": "The exact input amount, in the input token's smallest unit."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "amountRaw"
                                        ],
                                        "description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash."
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend a USD-denominated value of the input token.",
                                            "enum": [
                                              "exact_input_value_usd"
                                            ]
                                          },
                                          "value": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
                                            "description": "The USD value to spend, as a decimal string."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "value"
                                        ],
                                        "description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity."
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Receive an exact amount of the output token.",
                                            "enum": [
                                              "exact_output_tokens"
                                            ]
                                          },
                                          "amountRaw": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,38})$",
                                            "description": "The exact output amount, in the output token's smallest unit."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "amountRaw"
                                        ],
                                        "description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash."
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend everything the agent wallet holds of the input asset.",
                                            "enum": [
                                              "all_of_input"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "kind"
                                        ]
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend a fraction of the input asset.",
                                            "enum": [
                                              "fraction_of_input"
                                            ]
                                          },
                                          "bps": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,4})$",
                                            "description": "The fraction to spend, in basis points of the input asset."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "bps"
                                        ]
                                      }
                                    ],
                                    "description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
                                  },
                                  "output": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "pinned": {
                                            "type": "object",
                                            "properties": {
                                              "tokenId": {
                                                "type": "string",
                                                "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
                                                "description": "The token's NEP-141 identifier."
                                              },
                                              "decimals": {
                                                "type": "integer",
                                                "minimum": 0,
                                                "maximum": 38,
                                                "description": "How many decimal places the token's smallest unit represents."
                                              }
                                            },
                                            "required": [
                                              "tokenId",
                                              "decimals"
                                            ],
                                            "description": "The exact token this asset is pinned to."
                                          }
                                        },
                                        "required": [
                                          "pinned"
                                        ]
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "any": {
                                            "type": "boolean",
                                            "description": "Any token the agent wallet holds; the executor picks one at execution.",
                                            "enum": [
                                              true
                                            ]
                                          }
                                        },
                                        "required": [
                                          "any"
                                        ]
                                      }
                                    ],
                                    "description": "The asset this action produces: pinned to one token, or left open."
                                  }
                                },
                                "required": [
                                  "kind",
                                  "input",
                                  "quantity",
                                  "output"
                                ]
                              },
                              {
                                "type": "object",
                                "properties": {
                                  "kind": {
                                    "type": "string",
                                    "description": "Pay a pinned destination outside the agent wallet.",
                                    "enum": [
                                      "send"
                                    ]
                                  },
                                  "input": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "pinned": {
                                            "type": "object",
                                            "properties": {
                                              "tokenId": {
                                                "type": "string",
                                                "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
                                                "description": "The token's NEP-141 identifier."
                                              },
                                              "decimals": {
                                                "type": "integer",
                                                "minimum": 0,
                                                "maximum": 38,
                                                "description": "How many decimal places the token's smallest unit represents."
                                              }
                                            },
                                            "required": [
                                              "tokenId",
                                              "decimals"
                                            ],
                                            "description": "The exact token this asset is pinned to."
                                          }
                                        },
                                        "required": [
                                          "pinned"
                                        ]
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "any": {
                                            "type": "boolean",
                                            "description": "Any token the agent wallet holds; the executor picks one at execution.",
                                            "enum": [
                                              true
                                            ]
                                          }
                                        },
                                        "required": [
                                          "any"
                                        ]
                                      }
                                    ],
                                    "description": "The asset this action spends: pinned to one token, or any token the agent wallet holds."
                                  },
                                  "quantity": {
                                    "oneOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend an exact amount of the input token.",
                                            "enum": [
                                              "exact_input_tokens"
                                            ]
                                          },
                                          "amountRaw": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,38})$",
                                            "description": "The exact input amount, in the input token's smallest unit."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "amountRaw"
                                        ],
                                        "description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash."
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend a USD-denominated value of the input token.",
                                            "enum": [
                                              "exact_input_value_usd"
                                            ]
                                          },
                                          "value": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
                                            "description": "The USD value to spend, as a decimal string."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "value"
                                        ],
                                        "description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity."
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Receive an exact amount of the output token.",
                                            "enum": [
                                              "exact_output_tokens"
                                            ]
                                          },
                                          "amountRaw": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,38})$",
                                            "description": "The exact output amount, in the output token's smallest unit."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "amountRaw"
                                        ],
                                        "description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash."
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend everything the agent wallet holds of the input asset.",
                                            "enum": [
                                              "all_of_input"
                                            ]
                                          }
                                        },
                                        "required": [
                                          "kind"
                                        ]
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "kind": {
                                            "type": "string",
                                            "description": "Spend a fraction of the input asset.",
                                            "enum": [
                                              "fraction_of_input"
                                            ]
                                          },
                                          "bps": {
                                            "type": "string",
                                            "pattern": "^(0|[1-9]\\d{0,4})$",
                                            "description": "The fraction to spend, in basis points of the input asset."
                                          }
                                        },
                                        "required": [
                                          "kind",
                                          "bps"
                                        ]
                                      }
                                    ],
                                    "description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
                                  },
                                  "output": {
                                    "anyOf": [
                                      {
                                        "type": "object",
                                        "properties": {
                                          "pinned": {
                                            "type": "object",
                                            "properties": {
                                              "tokenId": {
                                                "type": "string",
                                                "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
                                                "description": "The token's NEP-141 identifier."
                                              },
                                              "decimals": {
                                                "type": "integer",
                                                "minimum": 0,
                                                "maximum": 38,
                                                "description": "How many decimal places the token's smallest unit represents."
                                              }
                                            },
                                            "required": [
                                              "tokenId",
                                              "decimals"
                                            ],
                                            "description": "The exact token this asset is pinned to."
                                          }
                                        },
                                        "required": [
                                          "pinned"
                                        ]
                                      },
                                      {
                                        "type": "object",
                                        "properties": {
                                          "any": {
                                            "type": "boolean",
                                            "description": "Any token the agent wallet holds; the executor picks one at execution.",
                                            "enum": [
                                              true
                                            ]
                                          }
                                        },
                                        "required": [
                                          "any"
                                        ]
                                      }
                                    ],
                                    "description": "The asset this action produces: pinned to one token, or left open."
                                  },
                                  "recipient": {
                                    "type": "object",
                                    "properties": {
                                      "chain": {
                                        "type": "string",
                                        "minLength": 1,
                                        "maxLength": 32,
                                        "description": "Which chain the destination address is on."
                                      },
                                      "address": {
                                        "type": "string",
                                        "pattern": "^[\\x21-\\x7e]{1,128}$",
                                        "description": "The destination address on that chain."
                                      }
                                    },
                                    "required": [
                                      "chain",
                                      "address"
                                    ],
                                    "description": "The pinned destination this action pays."
                                  }
                                },
                                "required": [
                                  "kind",
                                  "input",
                                  "quantity",
                                  "output",
                                  "recipient"
                                ]
                              }
                            ]
                          },
                          "description": "The actions this contract authorizes, executed in order."
                        },
                        "validUntil": {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
                          "description": "When this contract's authority expires."
                        },
                        "maxExecutions": {
                          "type": "integer",
                          "minimum": 1,
                          "maximum": 10000,
                          "description": "How many times this contract may be executed before it is exhausted."
                        },
                        "bounds": {
                          "type": "object",
                          "properties": {
                            "maxValueLossBps": {
                              "type": "string",
                              "pattern": "^(0|[1-9]\\d{0,4})$",
                              "description": "The most value an execution may give up to price movement and fees together, in basis points."
                            },
                            "maxSignatureLifetimeSeconds": {
                              "type": "integer",
                              "minimum": 1,
                              "maximum": 259500,
                              "description": "Explicit maximum lifetime of each released transfer signature, in seconds. 1Click confidential swaps require up to 259500 seconds (72 hours 5 minutes). This does not extend the short execution window or approval validity."
                            }
                          },
                          "required": [
                            "maxValueLossBps",
                            "maxSignatureLifetimeSeconds"
                          ],
                          "description": "The value-loss and signature-lifetime limits every execution must respect."
                        }
                      },
                      "required": [
                        "type",
                        "actions",
                        "validUntil",
                        "maxExecutions",
                        "bounds"
                      ]
                    }
                  ],
                  "description": "The exact authorization contract this withdrawal runs under, precisely as the approval card shows it."
                }
              },
              "required": [
                "operationId",
                "approvalId",
                "fingerprint",
                "expiresAt",
                "mainAccountId",
                "contract"
              ]
            }
          }
        }
      },
      "400": {
        "$ref": "#/components/responses/InvalidInput"
      },
      "401": {
        "$ref": "#/components/responses/Unauthorized"
      },
      "403": {
        "$ref": "#/components/responses/Forbidden"
      },
      "404": {
        "$ref": "#/components/responses/NotFound"
      },
      "409": {
        "description": "The operation lost to the current state.\n\n- `withdrawal_changed` — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "412": {
        "$ref": "#/components/responses/AccountNotProvisioned"
      },
      "413": {
        "$ref": "#/components/responses/PayloadTooLarge"
      },
      "429": {
        "$ref": "#/components/responses/TooManyRequests"
      },
      "500": {
        "$ref": "#/components/responses/Internal"
      },
      "503": {
        "description": "The replica is draining or a dependency did not answer; `retryable` says whether to try again.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it\n- `provider_unavailable` — an external provider the call depends on did not answer",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      }
    }
  },
  "components": {
    "responses": {
      "InvalidInput": {
        "description": "The request could not be read as this operation expects.\n\n- `invalid_input` — the body or query failed validation; `issues` names each field\n- `invalid_cursor` — the `cursor` is not one this list minted",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "A credential is missing, invalid or expired.\n\n- `partner_key_required` — no `X-Api-Key` header was sent\n- `partner_key_invalid` — the `X-Api-Key` is unknown or revoked\n- `credential_expired` — the user token has expired; obtain a fresh one",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "Forbidden": {
        "description": "The credentials are valid but may not do this.\n\n- `subject_mismatch` — the `{userId}` in the path is not the token's user\n- `account_disabled` — an operator disabled the account\n- `origin_rejected` — a browser `Origin` other than the configured web origin",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "NotFound": {
        "description": "The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "AccountNotProvisioned": {
        "description": "The identity is verified but has no account yet.\n\n- `account_not_provisioned` — the identity is verified but has no account yet; call `users.ensure` first",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "PayloadTooLarge": {
        "description": "The body exceeds the size this deployment accepts.",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "A limiter refused the request; honour `Retry-After`.\n\n- `rate_limited` — the per-key or per-user limit is spent; honour `Retry-After`",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "Internal": {
        "description": "A fault on our side; quote `requestId` when reporting it.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      }
    },
    "schemas": {
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The kind of problem as a URN, `urn:fin:error:<kind>`; stable, compare against it"
          },
          "title": {
            "type": "string",
            "description": "The kind's human title, for logs; never parse it"
          },
          "status": {
            "type": "integer",
            "minimum": 400,
            "maximum": 599,
            "description": "The HTTP status, repeated in the body"
          },
          "reason": {
            "description": "The machine-readable why. One of:\n\n- `run_active` (409) — a run already holds this conversation\n- `budget_exhausted` (409) — the user's spend headroom is gone, or an operator froze it\n- `approval_not_pending` (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation\n- `execution_capacity` (409) — no execution capacity is free right now; `retryable` says whether to try again\n- `execution_unavailable` (409) — the execution engine could not take the work\n- `stop_pending` (409) — a stop is already in progress and its cleanup is not yet confirmed\n- `automation_changed` (409) — the `revision` sent is stale; reload the automation\n- `automation_held` (409) — an operator holds the automation; it fires again when released\n- `automation_invalid` (409) — the automation's definition cannot run as written\n- `automation_completed` (409) — the automation has finished for good and cannot fire again\n- `automation_limit` (409) — the user already has as many automations as the deployment allows\n- `profile_unknown_tool` (409) — the run profile names a tool this deployment does not have\n- `deployment_paused` (409) — an operator paused a deployment control; nothing was admitted or fired\n- `run_not_active` (409) — the run named in the path is not the conversation's live run\n- `withdrawal_changed` (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress\n- `credential_expired` (401) — the user token has expired; obtain a fresh one\n- `account_disabled` (403) — an operator disabled the account\n- `account_not_provisioned` (412) — the identity is verified but has no account yet; call `users.ensure` first\n- `provider_unavailable` (503) — an external provider the call depends on did not answer\n- `engine_unavailable` (503) — the execution engine did not answer\n- `invalid_input` (400) — the body or query failed validation; `issues` names each field\n- `internal` (500) — a fault on our side; quote `requestId` when reporting it\n- `partner_key_required` (401) — no `X-Api-Key` header was sent\n- `partner_key_invalid` (401) — the `X-Api-Key` is unknown or revoked\n- `subject_mismatch` (403) — the `{userId}` in the path is not the token's user\n- `origin_rejected` (403) — a browser `Origin` other than the configured web origin\n- `permission_required` (403) — the operator credential lacks the scope this call needs\n- `rate_limited` (429) — the per-key or per-user limit is spent; honour `Retry-After`\n- `stream_capacity` (429) — no stream socket is free on this replica or for this user; honour `Retry-After`\n- `invalid_cursor` (400) — the `cursor` is not one this list minted",
            "type": "string",
            "enum": [
              "run_active",
              "budget_exhausted",
              "approval_not_pending",
              "execution_capacity",
              "execution_unavailable",
              "stop_pending",
              "automation_changed",
              "automation_held",
              "automation_invalid",
              "automation_completed",
              "automation_limit",
              "profile_unknown_tool",
              "deployment_paused",
              "run_not_active",
              "withdrawal_changed",
              "credential_expired",
              "account_disabled",
              "account_not_provisioned",
              "provider_unavailable",
              "engine_unavailable",
              "invalid_input",
              "internal",
              "partner_key_required",
              "partner_key_invalid",
              "subject_mismatch",
              "origin_rejected",
              "permission_required",
              "rate_limited",
              "stream_capacity",
              "invalid_cursor"
            ]
          },
          "requestId": {
            "type": "string",
            "description": "The id Fin used for this request; quote it when reporting a problem"
          },
          "retryable": {
            "type": "boolean",
            "description": "Whether repeating the same request later can succeed without changing it"
          },
          "detail": {
            "description": "Only on `invalid_input`: which part of the request failed validation",
            "type": "string"
          },
          "issues": {
            "description": "Only on `invalid_input`: one entry per failing field",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "path": {
                  "type": "string",
                  "description": "The JSON pointer of the failing field; empty for the root object"
                },
                "message": {
                  "type": "string",
                  "description": "Why the field failed"
                }
              },
              "required": [
                "path",
                "message"
              ]
            }
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "requestId",
          "retryable"
        ],
        "description": "RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack."
      }
    },
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Api-Key"
      },
      "userToken": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}