List an automation's runs
Lists each time the automation ran or was due to run, newest first, with the outcome and the agent run it started.
Authentication
Both headers are required.
- Header:
X-Api-Key: YOUR_API_KEY - Header:
Authorization: Bearer YOUR_USER_TOKEN— A user's session token, from Create a session.
Path parameters
userIdstringrequiredYour id for the user: the userId you sent to Create a user. It must be the session's user.
Validation rules
- Pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
automationIdstring · uuidrequiredThe automation's id.
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)$"
Query parameters
cursorstringoptionalWhere the previous page ended; omit for the first page
Validation rules
- Maximum length
256
limitintegeroptionalHow many rows to answer, at most 100
Validation rules
- Default
50- Minimum
1- Maximum
100
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 GET 'https://api.example.test/v1/users/YOUR_USER_ID/automations/YOUR_AUTOMATION_ID/runs' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Authorization: Bearer YOUR_USER_TOKEN'
Responses
200 The automation's runs.
The automation's runs.
application/json · object
dataarrayrequiredThis page's rows.
Show attributes
This page's rows.
Array items · object
One time an automation ran or was due to run: why, its delivery state, and the agent run it started, if any.
idstring · uuidrequiredThe automation run's id.
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)$"
deliverySequencestringrequiredThis automation run's place in delivery order across all automations, as a string so it sorts and compares exactly at any size. A paging cursor, not a count of this automation's runs: runNumber is that.
Validation rules
- Pattern
"^[1-9]\\d*$"
automationIdstring · uuidrequiredThe automation's id.
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)$"
definitionVersionintegerrequiredThe automation definition version this automation run was recorded under.
Validation rules
- Greater than
0- Maximum
9007199254740991
activationEpochstring · uuidrequiredThe activation epoch this automation run was recorded under.
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)$"
namestringrequiredThe automation's name when this automation run was recorded.
promptstringrequiredThe automation's prompt when this automation run was recorded.
evidenceobjectrequiredWhy this automation run happened: the decision, its evaluated data, and any recipe checks behind it.
Show attributes
Why this automation run happened: the decision, its evaluated data, and any recipe checks behind it.
kindstringrequiredWhat produced this automation run: decision the rule's own condition, external a source that decided on the engine's behalf.
Validation rules
- Allowed values
["decision","external"]
identitystringrequiredA stable string identifying this exact decision, used to deduplicate exact replays within one activation. Reuse with changed data conflicts.
Validation rules
- Minimum length
1- Maximum length
256
evaluatedAtstring · date-timerequiredWhen this decision was made.
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))$"
dataobjectrequiredThe observations behind one decision, exactly as evaluated. Bounded to 256 KiB, 24 levels of nesting and 16384 entries.
Show attributes
The observations behind one decision, exactly as evaluated. Bounded to 256 KiB, 24 levels of nesting and 16384 entries.
Validation rules
- propertyNames
{"type":"string"}
Additional property values
Any JSON value: a string, number, boolean, null, array or object, nested to any depth.
anyOf · 6 variants
Variant 1 · string
Variant 2 · number
Variant 3 · boolean
Variant 4 · null
Variant 5 · array
Array items · anyOf
Recursive reference: #/components/schemas/AutomationJsonValue. See the complete schema below.
Variant 6 · object
Validation rules
- propertyNames
{"type":"string"}
Additional property values
Recursive reference: #/components/schemas/AutomationJsonValue. See the complete schema below.
sourceChecksarrayoptionalRecipe checks recorded for each source this decision read, when evidence review is configured.
Show attributes
Recipe checks recorded for each source this decision read, when evidence review is configured.
Validation rules
- Maximum items
4
Array items · object
Frozen recipe evidence tied to the actual observation used by one decision.
bindingstringrequiredThe binding this check was collected for.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_-]{0,31}$"
sourceIdstringrequiredThe source's id within its provider.
Validation rules
- Minimum length
1- Maximum length
128
eventIdstringrequiredThe specific event or observation this check backs.
Validation rules
- Minimum length
1- Maximum length
128
operationIdstringrequiredThe collection operation this check ran.
Validation rules
- Pattern
"^[a-z][a-z0-9_.-]{0,79}$"
operationVersionintegerrequiredThe collection operation's version.
Validation rules
- Greater than
0- Maximum
9007199254740991
checkobjectrequiredA recorded run of a recipe's steps against the real source, kept as evidence.
Show attributes
A recorded run of a recipe's steps against the real source, kept as evidence.
recipeobjectrequiredA reviewed, public description of how a source is collected: the steps a reviewer confirmed, never an executable request or a resolved private endpoint.
Show attributes
A reviewed, public description of how a source is collected: the steps a reviewer confirmed, never an executable request or a resolved private endpoint.
versionintegerrequiredThe recipe description's own version, bumped when its steps change.
Validation rules
- Greater than
0- Maximum
9007199254740991
titlestringrequiredThe recipe's short label, for the reviewed catalog.
Validation rules
- Minimum length
1- Maximum length
120
summarystringrequiredWhat the recipe does, for the reviewed catalog.
Validation rules
- Minimum length
1- Maximum length
600
stepsarrayrequiredThe recipe's steps, in order.
Show attributes
The recipe's steps, in order.
Validation rules
- Minimum items
1- Maximum items
12
Array items · object
idstringrequiredThe step's identifier, unique within its recipe.
Validation rules
- Pattern
"^[a-z][a-z0-9_-]{0,47}$"
kindstringrequiredWhat this step does: request calls the provider, validate checks what it returned, calculate derives a value from earlier steps.
Validation rules
- Allowed values
["request","validate","calculate"]
titlestringrequiredThe step's short label, for the reviewed catalog.
Validation rules
- Minimum length
1- Maximum length
120
descriptionstringrequiredWhat this step does, for the reviewed catalog.
Validation rules
- Minimum length
1- Maximum length
600
apiobjectoptionalThe request this step makes, when it calls the provider.
Show attributes
The request this step makes, when it calls the provider.
methodstringrequiredThe request's method or protocol.
Validation rules
- Allowed values
["GET","POST","GRAPHQL"]
resourcestringrequiredThe request's path or resource name.
Validation rules
- Minimum length
1- Maximum length
160- Pattern
"^\\/?[A-Za-z0-9_{}][A-Za-z0-9_./{} -]*$"
limitationsarrayrequiredWhat the recipe does not cover, in the reviewer's own words.
Show attributes
What the recipe does not cover, in the reviewer's own words.
Validation rules
- Maximum items
6
Array items · string
Validation rules
- Minimum length
1- Maximum length
600
fingerprintstringrequiredA content hash identifying this exact recipe, independent of execution or connection identity.
Validation rules
- Pattern
"^[a-f0-9]{64}$"
startedAtstring · date-timerequiredWhen this check began.
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))$"
completedAtstring · date-timerequiredWhen this check finished.
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))$"
statusstringrequiredWhether every step completed.
Validation rules
- Allowed values
["completed","failed"]
stepsarrayrequiredEach step's own recorded outcome, in order.
Show attributes
Each step's own recorded outcome, in order.
Validation rules
- Maximum items
12
Array items · object
One recipe step's recorded outcome: counts and a closed reason only, never a URL, body, cursor, address or error message.
stepIdstringrequiredThe declared recipe step this check reports on.
Validation rules
- Pattern
"^[a-z][a-z0-9_-]{0,47}$"
outcomestringrequiredWhether the step completed or failed.
Validation rules
- Allowed values
["completed","failed"]
requestCountintegeroptionalHow many requests this step made, when it made any.
Validation rules
- Minimum
0- Maximum
100000
itemCountintegeroptionalHow many items this step processed, when counting applies.
Validation rules
- Minimum
0- Maximum
1000000
durationMsintegeroptionalHow long this step took, in milliseconds.
Validation rules
- Minimum
0- Maximum
600000
reasonstringoptionalWhy the step failed, when it did: not_configured the source lacks a needed setting, unavailable the provider did not answer, malformed its answer could not be read, oversized the answer exceeded a bound, stale or future a timestamp was out of range, incomplete part of the answer was missing, invalid the answer failed validation, canceled the check was stopped before finishing.
Validation rules
- Allowed values
["not_configured","unavailable","malformed","oversized","stale","future","incomplete","invalid","canceled"]
selectiononeOfrequiredWhat this automation run's firing selected out of its contract: every entry action in order (Scheduled buy), or exactly one exit action (Take-profit exit/Stop-loss exit). A definition without a contract records { kind: "entry" }.
Show attributes
What this automation run's firing selected out of its contract: every entry action in order (Scheduled buy), or exactly one exit action (Take-profit exit/Stop-loss exit). A definition without a contract records { kind: "entry" }.
oneOf · 2 variants
Variant 1 · kind: entry
kindstringrequiredThis firing runs every entry action of the contract, in order.
Validation rules
- Exact value
"entry"
Variant 2 · kind: exit
kindstringrequiredThis firing runs exactly one exit action.
Validation rules
- Exact value
"exit"
actionIndexintegerrequiredThe zero-based index of the approved exit action this firing selected.
Validation rules
- Minimum
0- Maximum
15
exitKindstringrequiredWhich guard fired: a take-profit, a stop-loss or a scheduled harvest.
Validation rules
- Allowed values
["take_profit","stop_loss","harvest_every"]
statestringrequiredThis automation run's state: pending waiting to start, deferred an admission attempt failed and is waiting to retry, accepted handed to an agent run, retrying waiting to try again before its deadline, succeeded it did what it was asked, partial only some of it went through, failed it moved nothing it was asked to, uncertain money may have moved and how it ended is not known yet, rejected the delivery policy refused it outright, or a non-retryable admission failure (or an exhausted retry deadline) stopped it, canceled stopped before starting, skipped an earlier automation run was still active or it was missed, coalesced merged into a newer match.
Validation rules
- Allowed values
["pending","deferred","accepted","retrying","succeeded","partial","failed","uncertain","rejected","canceled","skipped","coalesced"]
reasonstring or nullrequiredWhy the automation run is in this state, when there is one to give. A run that failed or went through only in part gives one of unavailable, insufficient_funds, quote_rejected, not_authorized, not_executed or condition_passed.
runNumberanyOfrequiredWhich of its automation's runs this is, counting from 1, the number its run limit counts. Null for a run that is no scheduled or triggered firing of its own, such as an exit check selling a position. Show this, not deliverySequence.
Show attributes
Which of its automation's runs this is, counting from 1, the number its run limit counts. Null for a run that is no scheduled or triggered firing of its own, such as an exit check selling a position. Show this, not deliverySequence.
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Greater than
0- Maximum
9007199254740991
Variant 2 · null
createdAtstring · date-timerequiredWhen this automation run was recorded.
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))$"
deliveryDeadlinestring · date-timerequiredThe latest this automation run could still start.
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))$"
deadlineAtanyOfoptionalThe latest this run may still try, once it has started: the earliest of its delivery deadline, the windows its owner signed and its next firing. Null or absent for a run that never started, or one from before this field. Use it, not deliveryDeadline, to say how long a run had.
Show attributes
The latest this run may still try, once it has started: the earliest of its delivery deadline, the windows its owner signed and its next firing. Null or absent for a run that never started, or one from before this field. Use it, not deliveryDeadline, to say how long a run had.
anyOf · 2 variants
Variant 1 · string · date-time
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))$"
Variant 2 · null
nextAttemptAtstring · date-timerequiredWhen the next attempt to start this automation run is due.
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))$"
lastAttemptAtanyOfrequiredWhen this automation run was last tried, when it has been.
Show attributes
When this automation run was last tried, when it has been.
anyOf · 2 variants
Variant 1 · string · date-time
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))$"
Variant 2 · null
attemptsintegerrequiredHow many attempts to start this automation run there have been.
Validation rules
- Minimum
0- Maximum
9007199254740991
conversationIdanyOfrequiredThe conversation this automation run works in, once it has one.
Show attributes
The conversation this automation run works in, once it has one.
anyOf · 2 variants
Variant 1 · string · uuid
The conversation's id.
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)$"
Variant 2 · null
runIdanyOfrequiredThe agent run this automation run started, once it has one.
Show attributes
The agent run this automation run started, once it has one.
anyOf · 2 variants
Variant 1 · string · uuid
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)$"
Variant 2 · null
runStatusanyOfrequiredThat agent run's status, once it has one: running, paused while an approval waits, then completed, failed or aborted.
Show attributes
That agent run's status, once it has one: running, paused while an approval waits, then completed, failed or aborted.
anyOf · 2 variants
Variant 1 · string
Validation rules
- Allowed values
["running","paused","completed","failed","aborted"]
Variant 2 · null
runErrorstring or nullrequiredWhy the agent run failed, when it did.
pendingApprovalsintegerrequiredHow many approvals this automation run's agent run is waiting on.
Validation rules
- Minimum
0- Maximum
9007199254740991
solanaanyOfoptionalFor a Solana trading automation, the admitted trade and its observed result. Absent or null before it acts and for other automations. Read this result independently of runStatus.
Show attributes
For a Solana trading automation, the admitted trade and its observed result. Absent or null before it acts and for other automations. Read this result independently of runStatus.
anyOf · 2 variants
Variant 1 · oneOf
The Solana trade this automation run admitted, with its observed financial result.
oneOf · 2 variants
Variant 1 · kind: buy
idstring · uuidrequiredThe Solana activity item’s id, for its receipt in History.
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)$"
kindstringrequiredValidation rules
- Exact value
"buy"
requestobjectrequiredOne exact-input buy of a Solana token through the agent's own Solana account.
Show attributes
One exact-input buy of a Solana token through the agent's own Solana account.
tokenobjectrequiredThe exact token to buy.
Show attributes
The exact token to buy.
mintstringrequiredThe token's mint address, exactly as solana_token_search or solana_token returned it. Never a ticker.
Validation rules
- Minimum length
32- Maximum length
44- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
decimalsintegerrequiredThe mint's decimals, exactly as returned with the mint.
Validation rules
- Minimum
0- Maximum
18
tokenProgramstringrequiredThe program that owns the mint, exactly as returned with the mint: spl_token or token_2022.
Validation rules
- Allowed values
["spl_token","token_2022"]
payoneOfrequiredWhat the buy spends, as an exact input amount. Buying an exact number of tokens is not supported.
Show attributes
What the buy spends, as an exact input amount. Buying an exact number of tokens is not supported.
oneOf · 2 variants
Variant 1 · kind: usdc
Spend an exact amount of USDC or USDT from the agent wallet.
kindstringrequiredPay from one USDC or USDT holding of the agent wallet (USDC on NEAR, Base, Arbitrum, Ethereum or Solana, or USDT on NEAR; any USDC that covers it before USDT), moved to Solana as SOL first.
Validation rules
- Exact value
"usdc"
amountRawstringrequiredExact USDC or USDT to spend, in six-decimal atomic units: $50 is "50000000". At least 5 ("5000000"); a smaller buy is refused.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: sol
Spend an exact amount of SOL the agent's Solana account already holds.
kindstringrequiredPay with SOL already in the agent's Solana account.
Validation rules
- Exact value
"sol"
lamportsstringrequiredExact SOL to spend, in lamports (nine decimals): 0.5 SOL is "500000000".
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
maxValueLossBpsintegerrequiredExplicit all-in maximum value loss in basis points, from the value paid to the value received, fees and price impact included: at least 1, at most 1500. Required; no default.
Validation rules
- Minimum
1- Maximum
1500
maxSolTopUpUsdcRawstringrequiredThe most extra USDC or USDT the funding may add to keep SOL in the Solana account for network fees, in six-decimal atomic units: "0" for none, at most "1000000" (1 USDC). Must be "0" when paying with SOL.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
payWithobjectoptionalA buy paid in dollars and approved in chat as one call: the coin its funding pays with instead of a USDC or USDT holding, and the most of it it may spend, the SOL top-up included. Never SOL. A buy from a token's page refuses it.
Show attributes
A buy paid in dollars and approved in chat as one call: the coin its funding pays with instead of a USDC or USDT holding, and the most of it it may spend, the SOL top-up included. Never SOL. A buy from a token's page refuses it.
tokenIdstringrequiredThe exact ledger asset identifier, including its token standard namespace.
Validation rules
- Maximum length
256- Pattern
"^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
maxInputRawstringrequiredThe most of the coin this funding may spend, in its smallest unit: the approved dollars at the price read when the approval opened, plus 5%.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
outcomeanyOfrequiredThe observed financial result. Null until there is one; an agent run completing does not prove that money moved.
Show attributes
The observed financial result. Null until there is one; an agent run completing does not prove that money moved.
anyOf · 2 variants
Variant 1 · anyOf
anyOf · 4 variants
Variant 1 · status: in_progress
statusstringrequiredValidation rules
- Exact value
"in_progress"
operationIdstring · uuidrequiredThe persisted financial operation still owned by its durable executor.
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)$"
Variant 2 · status: no_trade
statusstringrequiredThe request resolved without attempting a financial action.
Validation rules
- Exact value
"no_trade"
Variant 3 · status: refused
statusstringrequiredThe financial command refused execution under its authority or safety checks.
Validation rules
- Exact value
"refused"
scopestringrequiredThe bounded category of the refusal; no provider text, account details or amounts are exposed here. buy_too_small (a Solana buy below its minimum), reserve_required (it would spend the SOL the Solana account keeps for fees) and loss_bound_exceeded (no route returned at least the approved minimum) can be corrected by asking the user for other terms; token_blocked means the token's own rules, or its missing price, keep it from trading through fin; route_unavailable means the requested financial route was not available; nothing_freed means a cash-out's withdrawal found nothing its exit freed to bring home.
Validation rules
- Allowed values
["authority","request","transient","insufficient_funds","request_frozen","verification","stale_evidence","account_busy","conflict","paused","held","withdrawn","spend_cap_reached","no_signing_authority","not_available_in_region","no_account","withdrawal_too_small","withdrawal_reserve_required","nothing_freed","order_invalid","route_unavailable","buy_too_small","reserve_required","loss_bound_exceeded","token_blocked"]
Variant 4 · object
statusstringrequiredThe financial outcome: settled, unresolved, mixed or incomplete, refunded, or conclusively not executed. An outcome can still be waiting for receipts; the trade's or withdrawal's status says whether it is final.
Validation rules
- Allowed values
["settled","pending","partial","refunded","not_executed"]
reasonstringoptionalPresent when execution was restricted to a mode that cannot sign or move funds.
Validation rules
- Exact value
"signing_disabled"
stoppedobjectoptionalPresent only on a partial outcome whose run refused a later leg before it was claimed: the planned action the run stopped on and the bounded reason it never started.
Show attributes
Present only on a partial outcome whose run refused a later leg before it was claimed: the planned action the run stopped on and the bounded reason it never started.
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
reasonstringrequiredThe bounded category the stopped leg was refused with; no provider text, account details or amounts.
Validation rules
- Allowed values
["lineage_unavailable","consent_invalid","allowance_exhausted","spend_cap_reached","position_unknown","exit_not_reached","selection_mismatch","action_mismatch","request_frozen","insufficient_funds","evidence_unavailable","inventory_stale","plan_conflict","leg_order","quote_invalid","payload_invalid","account_busy","expired","credentials_unavailable","execution_paused","automation_held","authority_withdrawn","perps_disabled","prediction_disabled","not_available_in_region","no_account","withdrawal_too_small","withdrawal_reserve_required","nothing_freed","order_invalid","route_unsupported","route_changed","solana_disabled","token_unpriced","token_mismatch","token_freezable","token_transfer_hook","token_permanent_delegate","token_non_transferable","token_default_frozen","token_transfer_fee","token_pausable","token_unknown_extension","token_not_sellable","route_invalid","loss_bound_exceeded","reserve_required","buy_too_small","swap_already_landed","solana_unavailable"]
blockedarrayoptionalUnclaimed actions blocked before dispatch, with unique indices disjoint from all actual legs.
Show attributes
Unclaimed actions blocked before dispatch, with unique indices disjoint from all actual legs.
Validation rules
- Minimum items
1- Maximum items
16
Array items · object
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
reasonstringrequiredThe bounded category the stopped leg was refused with; no provider text, account details or amounts.
Validation rules
- Allowed values
["lineage_unavailable","consent_invalid","allowance_exhausted","spend_cap_reached","position_unknown","exit_not_reached","selection_mismatch","action_mismatch","request_frozen","insufficient_funds","evidence_unavailable","inventory_stale","plan_conflict","leg_order","quote_invalid","payload_invalid","account_busy","expired","credentials_unavailable","execution_paused","automation_held","authority_withdrawn","perps_disabled","prediction_disabled","not_available_in_region","no_account","withdrawal_too_small","withdrawal_reserve_required","nothing_freed","order_invalid","route_unsupported","route_changed","solana_disabled","token_unpriced","token_mismatch","token_freezable","token_transfer_hook","token_permanent_delegate","token_non_transferable","token_default_frozen","token_transfer_fee","token_pausable","token_unknown_extension","token_not_sellable","route_invalid","loss_bound_exceeded","reserve_required","buy_too_small","swap_already_landed","solana_unavailable"]
legsarrayrequiredThe actual execution legs represented by this outcome; unattempted planned legs have no invented receipt.
Show attributes
The actual execution legs represented by this outcome; unattempted planned legs have no invented receipt.
Validation rules
- Maximum items
16
Array items · object
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
statestringrequiredThe recorded execution or settlement state of this actual leg.
Validation rules
- Allowed values
["claimed","signed","uncertain","settled","refunded","not_executed"]
solanaobjectoptionalPresent only on a Solana operation's outcome: what it paid, received and signed on Solana. legs are its 1Click legs.
Show attributes
Present only on a Solana operation's outcome: what it paid, received and signed on Solana. legs are its 1Click legs.
sidestringrequiredWhich Solana operation this is: a buy, a sell, a fund or a withdrawal.
Validation rules
- Allowed values
["buy","sell","fund","withdraw"]
tokenobjectoptionalThe token bought or sold; absent for a fund or a withdrawal.
Show attributes
The token bought or sold; absent for a fund or a withdrawal.
mintstringrequiredThe token's mint address, exactly as solana_token_search or solana_token returned it. Never a ticker.
Validation rules
- Minimum length
32- Maximum length
44- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
decimalsintegerrequiredThe mint's decimals, exactly as returned with the mint.
Validation rules
- Minimum
0- Maximum
18
tokenProgramstringrequiredThe program that owns the mint, exactly as returned with the mint: spl_token or token_2022.
Validation rules
- Allowed values
["spl_token","token_2022"]
accountstringrequiredThe agent's own Solana account the operation used.
Validation rules
- Minimum length
32- Maximum length
44- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
transactionsarrayrequiredEvery transaction the operation signed, in the order it signed them. A multi-coin sale lists here only its one transfer back: each coin's swaps are under its own entry of sales.
Show attributes
Every transaction the operation signed, in the order it signed them. A multi-coin sale lists here only its one transfer back: each coin's swaps are under its own entry of sales.
Validation rules
- Maximum items
6
Array items · object
One signed Solana transaction of this operation.
purposestringrequiredswap trades on Jupiter; sweep sends SOL back to the agent wallet through 1Click.
Validation rules
- Allowed values
["swap","sweep"]
signaturestringrequiredA Solana transaction signature, which is also its id: base58 text of 64 bytes.
Validation rules
- Minimum length
64- Maximum length
88- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
statestringrequiredsigned and dispatching are not yet sent or not yet seen; landed succeeded on chain, failed landed with an error, expired provably never will; uncertain is not yet known: never sign it again.
Validation rules
- Allowed values
["signed","dispatching","landed","failed","expired","uncertain"]
feeLamportsstringoptionalThe network fee the transaction paid, in lamports, once it landed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
paidobjectoptionalWhat the operation spent, once known.
Show attributes
What the operation spent, once known.
assetstringrequiredusdc is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, sol is SOL, token is the operation's own token.
Validation rules
- Allowed values
["usdc","sol","token"]
amountRawstringrequiredThe exact amount, in the asset's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
receivedobjectoptionalWhat the operation received, once it landed or settled.
Show attributes
What the operation received, once it landed or settled.
assetstringrequiredusdc is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, sol is SOL, token is the operation's own token.
Validation rules
- Allowed values
["usdc","sol","token"]
amountRawstringrequiredThe exact amount, in the asset's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
solLeftLamportsstringoptionalSOL the operation left in the Solana account, in lamports: what a partial outcome left behind.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
salesarrayoptionalPresent only on a multi-coin sale's outcome: each sale in the order it ran. received is what the whole sale returned.
Show attributes
Present only on a multi-coin sale's outcome: each sale in the order it ran. received is what the whole sale returned.
Validation rules
- Maximum items
6
Array items · object
One coin of a multi-coin sale, and what became of it.
tokenobjectrequiredThe coin this sale sold, or was to sell.
Show attributes
The coin this sale sold, or was to sell.
mintstringrequiredThe token's mint address, exactly as solana_token_search or solana_token returned it. Never a ticker.
Validation rules
- Minimum length
32- Maximum length
44- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
decimalsintegerrequiredThe mint's decimals, exactly as returned with the mint.
Validation rules
- Minimum
0- Maximum
18
tokenProgramstringrequiredThe program that owns the mint, exactly as returned with the mint: spl_token or token_2022.
Validation rules
- Allowed values
["spl_token","token_2022"]
statestringrequiredsold once its swap landed; not_sold when it ended without selling anything (refused before any signature, every attempt failed or expired, or the sale stopped before it); uncertain while an attempt of it may still land: never sign it again.
Validation rules
- Allowed values
["sold","not_sold","uncertain"]
paidobjectoptionalWhat this sale sold, once its swap landed: the token's exact amount.
Show attributes
What this sale sold, once its swap landed: the token's exact amount.
assetstringrequiredusdc is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, sol is SOL, token is the operation's own token.
Validation rules
- Allowed values
["usdc","sol","token"]
amountRawstringrequiredThe exact amount, in the asset's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
solGainedLamportsstringoptionalThe SOL this sale's landed swap added to the Solana account, in lamports, before the one transfer back.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
transactionsarrayoptionalThis coin's swap attempts the sale signed, in the order it signed them; absent while none was signed.
Show attributes
This coin's swap attempts the sale signed, in the order it signed them; absent while none was signed.
Validation rules
- Maximum items
3
Array items · object
One signed Solana transaction of this operation.
purposestringrequiredswap trades on Jupiter; sweep sends SOL back to the agent wallet through 1Click.
Validation rules
- Allowed values
["swap","sweep"]
signaturestringrequiredA Solana transaction signature, which is also its id: base58 text of 64 bytes.
Validation rules
- Minimum length
64- Maximum length
88- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
statestringrequiredsigned and dispatching are not yet sent or not yet seen; landed succeeded on chain, failed landed with an error, expired provably never will; uncertain is not yet known: never sign it again.
Validation rules
- Allowed values
["signed","dispatching","landed","failed","expired","uncertain"]
feeLamportsstringoptionalThe network fee the transaction paid, in lamports, once it landed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · null
Variant 2 · kind: sell
idstring · uuidrequiredThe Solana activity item’s id, for its receipt in History.
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)$"
kindstringrequiredValidation rules
- Exact value
"sell"
requestobjectrequiredOne sell of a Solana token held in the agent's own Solana account.
Show attributes
One sell of a Solana token held in the agent's own Solana account.
tokenobjectrequiredThe exact token to sell.
Show attributes
The exact token to sell.
mintstringrequiredThe token's mint address, exactly as solana_token_search or solana_token returned it. Never a ticker.
Validation rules
- Minimum length
32- Maximum length
44- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
decimalsintegerrequiredThe mint's decimals, exactly as returned with the mint.
Validation rules
- Minimum
0- Maximum
18
tokenProgramstringrequiredThe program that owns the mint, exactly as returned with the mint: spl_token or token_2022.
Validation rules
- Allowed values
["spl_token","token_2022"]
amountoneOfrequiredHow much of the token to sell.
Show attributes
How much of the token to sell.
oneOf · 2 variants
Variant 1 · kind: exact
Sell an exact amount of the token.
kindstringrequiredSell an exact amount of the token.
Validation rules
- Exact value
"exact"
amountRawstringrequiredExact amount of the token to sell, in its smallest unit (scaled by the token's decimals).
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: fraction
Sell a share of the account's balance of the token.
kindstringrequiredSell a share of what the Solana account holds of the token.
Validation rules
- Exact value
"fraction"
bpsintegerrequiredThe share to sell, in basis points of the account's balance of the token: all of it is 10000, half is 5000.
Validation rules
- Minimum
1- Maximum
10000
receivestringrequiredusdc returns the proceeds to the agent wallet as USDC on NEAR, which is what selling means; sol keeps them as SOL in the agent's Solana account.
Validation rules
- Allowed values
["usdc","sol"]
maxValueLossBpsintegerrequiredExplicit all-in maximum value loss in basis points, from the value paid to the value received, fees and price impact included: at least 1, at most 1500. Required; no default.
Validation rules
- Minimum
1- Maximum
1500
outcomeanyOfrequiredThe observed financial result. Null until there is one; a partial result may leave SOL in the Solana account.
Show attributes
The observed financial result. Null until there is one; a partial result may leave SOL in the Solana account.
anyOf · 2 variants
Variant 1 · anyOf
anyOf · 4 variants
Variant 1 · status: in_progress
statusstringrequiredValidation rules
- Exact value
"in_progress"
operationIdstring · uuidrequiredThe persisted financial operation still owned by its durable executor.
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)$"
Variant 2 · status: no_trade
statusstringrequiredThe request resolved without attempting a financial action.
Validation rules
- Exact value
"no_trade"
Variant 3 · status: refused
statusstringrequiredThe financial command refused execution under its authority or safety checks.
Validation rules
- Exact value
"refused"
scopestringrequiredThe bounded category of the refusal; no provider text, account details or amounts are exposed here. buy_too_small (a Solana buy below its minimum), reserve_required (it would spend the SOL the Solana account keeps for fees) and loss_bound_exceeded (no route returned at least the approved minimum) can be corrected by asking the user for other terms; token_blocked means the token's own rules, or its missing price, keep it from trading through fin; route_unavailable means the requested financial route was not available; nothing_freed means a cash-out's withdrawal found nothing its exit freed to bring home.
Validation rules
- Allowed values
["authority","request","transient","insufficient_funds","request_frozen","verification","stale_evidence","account_busy","conflict","paused","held","withdrawn","spend_cap_reached","no_signing_authority","not_available_in_region","no_account","withdrawal_too_small","withdrawal_reserve_required","nothing_freed","order_invalid","route_unavailable","buy_too_small","reserve_required","loss_bound_exceeded","token_blocked"]
Variant 4 · object
statusstringrequiredThe financial outcome: settled, unresolved, mixed or incomplete, refunded, or conclusively not executed. An outcome can still be waiting for receipts; the trade's or withdrawal's status says whether it is final.
Validation rules
- Allowed values
["settled","pending","partial","refunded","not_executed"]
reasonstringoptionalPresent when execution was restricted to a mode that cannot sign or move funds.
Validation rules
- Exact value
"signing_disabled"
stoppedobjectoptionalPresent only on a partial outcome whose run refused a later leg before it was claimed: the planned action the run stopped on and the bounded reason it never started.
Show attributes
Present only on a partial outcome whose run refused a later leg before it was claimed: the planned action the run stopped on and the bounded reason it never started.
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
reasonstringrequiredThe bounded category the stopped leg was refused with; no provider text, account details or amounts.
Validation rules
- Allowed values
["lineage_unavailable","consent_invalid","allowance_exhausted","spend_cap_reached","position_unknown","exit_not_reached","selection_mismatch","action_mismatch","request_frozen","insufficient_funds","evidence_unavailable","inventory_stale","plan_conflict","leg_order","quote_invalid","payload_invalid","account_busy","expired","credentials_unavailable","execution_paused","automation_held","authority_withdrawn","perps_disabled","prediction_disabled","not_available_in_region","no_account","withdrawal_too_small","withdrawal_reserve_required","nothing_freed","order_invalid","route_unsupported","route_changed","solana_disabled","token_unpriced","token_mismatch","token_freezable","token_transfer_hook","token_permanent_delegate","token_non_transferable","token_default_frozen","token_transfer_fee","token_pausable","token_unknown_extension","token_not_sellable","route_invalid","loss_bound_exceeded","reserve_required","buy_too_small","swap_already_landed","solana_unavailable"]
blockedarrayoptionalUnclaimed actions blocked before dispatch, with unique indices disjoint from all actual legs.
Show attributes
Unclaimed actions blocked before dispatch, with unique indices disjoint from all actual legs.
Validation rules
- Minimum items
1- Maximum items
16
Array items · object
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
reasonstringrequiredThe bounded category the stopped leg was refused with; no provider text, account details or amounts.
Validation rules
- Allowed values
["lineage_unavailable","consent_invalid","allowance_exhausted","spend_cap_reached","position_unknown","exit_not_reached","selection_mismatch","action_mismatch","request_frozen","insufficient_funds","evidence_unavailable","inventory_stale","plan_conflict","leg_order","quote_invalid","payload_invalid","account_busy","expired","credentials_unavailable","execution_paused","automation_held","authority_withdrawn","perps_disabled","prediction_disabled","not_available_in_region","no_account","withdrawal_too_small","withdrawal_reserve_required","nothing_freed","order_invalid","route_unsupported","route_changed","solana_disabled","token_unpriced","token_mismatch","token_freezable","token_transfer_hook","token_permanent_delegate","token_non_transferable","token_default_frozen","token_transfer_fee","token_pausable","token_unknown_extension","token_not_sellable","route_invalid","loss_bound_exceeded","reserve_required","buy_too_small","swap_already_landed","solana_unavailable"]
legsarrayrequiredThe actual execution legs represented by this outcome; unattempted planned legs have no invented receipt.
Show attributes
The actual execution legs represented by this outcome; unattempted planned legs have no invented receipt.
Validation rules
- Maximum items
16
Array items · object
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
statestringrequiredThe recorded execution or settlement state of this actual leg.
Validation rules
- Allowed values
["claimed","signed","uncertain","settled","refunded","not_executed"]
solanaobjectoptionalPresent only on a Solana operation's outcome: what it paid, received and signed on Solana. legs are its 1Click legs.
Show attributes
Present only on a Solana operation's outcome: what it paid, received and signed on Solana. legs are its 1Click legs.
sidestringrequiredWhich Solana operation this is: a buy, a sell, a fund or a withdrawal.
Validation rules
- Allowed values
["buy","sell","fund","withdraw"]
tokenobjectoptionalThe token bought or sold; absent for a fund or a withdrawal.
Show attributes
The token bought or sold; absent for a fund or a withdrawal.
mintstringrequiredThe token's mint address, exactly as solana_token_search or solana_token returned it. Never a ticker.
Validation rules
- Minimum length
32- Maximum length
44- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
decimalsintegerrequiredThe mint's decimals, exactly as returned with the mint.
Validation rules
- Minimum
0- Maximum
18
tokenProgramstringrequiredThe program that owns the mint, exactly as returned with the mint: spl_token or token_2022.
Validation rules
- Allowed values
["spl_token","token_2022"]
accountstringrequiredThe agent's own Solana account the operation used.
Validation rules
- Minimum length
32- Maximum length
44- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
transactionsarrayrequiredEvery transaction the operation signed, in the order it signed them. A multi-coin sale lists here only its one transfer back: each coin's swaps are under its own entry of sales.
Show attributes
Every transaction the operation signed, in the order it signed them. A multi-coin sale lists here only its one transfer back: each coin's swaps are under its own entry of sales.
Validation rules
- Maximum items
6
Array items · object
One signed Solana transaction of this operation.
purposestringrequiredswap trades on Jupiter; sweep sends SOL back to the agent wallet through 1Click.
Validation rules
- Allowed values
["swap","sweep"]
signaturestringrequiredA Solana transaction signature, which is also its id: base58 text of 64 bytes.
Validation rules
- Minimum length
64- Maximum length
88- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
statestringrequiredsigned and dispatching are not yet sent or not yet seen; landed succeeded on chain, failed landed with an error, expired provably never will; uncertain is not yet known: never sign it again.
Validation rules
- Allowed values
["signed","dispatching","landed","failed","expired","uncertain"]
feeLamportsstringoptionalThe network fee the transaction paid, in lamports, once it landed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
paidobjectoptionalWhat the operation spent, once known.
Show attributes
What the operation spent, once known.
assetstringrequiredusdc is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, sol is SOL, token is the operation's own token.
Validation rules
- Allowed values
["usdc","sol","token"]
amountRawstringrequiredThe exact amount, in the asset's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
receivedobjectoptionalWhat the operation received, once it landed or settled.
Show attributes
What the operation received, once it landed or settled.
assetstringrequiredusdc is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, sol is SOL, token is the operation's own token.
Validation rules
- Allowed values
["usdc","sol","token"]
amountRawstringrequiredThe exact amount, in the asset's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
solLeftLamportsstringoptionalSOL the operation left in the Solana account, in lamports: what a partial outcome left behind.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
salesarrayoptionalPresent only on a multi-coin sale's outcome: each sale in the order it ran. received is what the whole sale returned.
Show attributes
Present only on a multi-coin sale's outcome: each sale in the order it ran. received is what the whole sale returned.
Validation rules
- Maximum items
6
Array items · object
One coin of a multi-coin sale, and what became of it.
tokenobjectrequiredThe coin this sale sold, or was to sell.
Show attributes
The coin this sale sold, or was to sell.
mintstringrequiredThe token's mint address, exactly as solana_token_search or solana_token returned it. Never a ticker.
Validation rules
- Minimum length
32- Maximum length
44- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
decimalsintegerrequiredThe mint's decimals, exactly as returned with the mint.
Validation rules
- Minimum
0- Maximum
18
tokenProgramstringrequiredThe program that owns the mint, exactly as returned with the mint: spl_token or token_2022.
Validation rules
- Allowed values
["spl_token","token_2022"]
statestringrequiredsold once its swap landed; not_sold when it ended without selling anything (refused before any signature, every attempt failed or expired, or the sale stopped before it); uncertain while an attempt of it may still land: never sign it again.
Validation rules
- Allowed values
["sold","not_sold","uncertain"]
paidobjectoptionalWhat this sale sold, once its swap landed: the token's exact amount.
Show attributes
What this sale sold, once its swap landed: the token's exact amount.
assetstringrequiredusdc is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, sol is SOL, token is the operation's own token.
Validation rules
- Allowed values
["usdc","sol","token"]
amountRawstringrequiredThe exact amount, in the asset's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
solGainedLamportsstringoptionalThe SOL this sale's landed swap added to the Solana account, in lamports, before the one transfer back.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
transactionsarrayoptionalThis coin's swap attempts the sale signed, in the order it signed them; absent while none was signed.
Show attributes
This coin's swap attempts the sale signed, in the order it signed them; absent while none was signed.
Validation rules
- Maximum items
3
Array items · object
One signed Solana transaction of this operation.
purposestringrequiredswap trades on Jupiter; sweep sends SOL back to the agent wallet through 1Click.
Validation rules
- Allowed values
["swap","sweep"]
signaturestringrequiredA Solana transaction signature, which is also its id: base58 text of 64 bytes.
Validation rules
- Minimum length
64- Maximum length
88- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
statestringrequiredsigned and dispatching are not yet sent or not yet seen; landed succeeded on chain, failed landed with an error, expired provably never will; uncertain is not yet known: never sign it again.
Validation rules
- Allowed values
["signed","dispatching","landed","failed","expired","uncertain"]
feeLamportsstringoptionalThe network fee the transaction paid, in lamports, once it landed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · null
Variant 2 · null
perpsanyOfrequiredFor a perps automation, the order this run placed or the margin it added, with Hyperliquid's answer. Null for any other automation, and until the run acts.
Show attributes
For a perps automation, the order this run placed or the margin it added, with Hyperliquid's answer. Null for any other automation, and until the run acts.
anyOf · 2 variants
Variant 1 · oneOf
What one run of a perps automation did on Hyperliquid: the reduce-only order it placed or the margin it added, with the answer it got.
oneOf · 2 variants
Variant 1 · kind: order
kindstringrequiredA reduce-only order on the automation's position.
Validation rules
- Exact value
"order"
orderobjectrequiredThe exact order the run placed: the coin, side, size and worst price (entry.price) this firing allowed.
Show attributes
The exact order the run placed: the coin, side, size and worst price (entry.price) this firing allowed.
coinstringrequiredThe market's coin name exactly as perps_markets lists it, such as BTC or xyz:TSLA.
Validation rules
- Pattern
"^(?:xyz:)?[A-Za-z0-9]{1,20}$"
assetintegerrequiredThe market's asset id exactly as perps_markets lists it for that coin.
Validation rules
- Minimum
0- Maximum
1099999
sidestringrequiredThe position this order opens, adds to, reduces or protects. A reduce-only entry on a long position sells.
Validation rules
- Allowed values
["long","short"]
sizestringrequiredExact size in the coin, at most the market's szDecimals places.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$"
leverageanyOfrequiredLeverage the user chose for this market, at most the market's maximum. Required for an entry that is not reduce-only; null otherwise. Never assume it: ask the user.
Show attributes
Leverage the user chose for this market, at most the market's maximum. Required for an entry that is not reduce-only; null otherwise. Never assume it: ask the user.
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
1- Maximum
100
Variant 2 · null
marginModestringoptionalHow the position is margined, which the user chose with the leverage: cross shares the account's margin with every cross position, isolated puts only this position's own margin at risk (perps_margin_update adds or removes it later). Present exactly when leverage is; an isolated-only market (perps_markets onlyIsolated) takes isolated. Never assume it: ask the user. Absent on orders approved before margin modes existed, which were cross.
Validation rules
- Allowed values
["cross","isolated"]
entryanyOfrequiredThe order itself; null for take-profit and stop-loss on the existing position only.
Show attributes
The order itself; null for take-profit and stop-loss on the existing position only.
anyOf · 2 variants
Variant 1 · object
pricestringrequiredThe limit price; for an immediate (Ioc) order, the worst price it may fill at.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$"
timeInForcestringrequiredIoc fills now within price and cancels the rest (a market order), Gtc rests until filled or cancelled, Alo rests only as a maker order.
Validation rules
- Allowed values
["Gtc","Ioc","Alo"]
reduceOnlybooleanrequiredTrue to only reduce or close the existing position, never open or add.
Variant 2 · null
takeProfitanyOfrequiredA reduce-only take-profit, or null.
Show attributes
A reduce-only take-profit, or null.
anyOf · 2 variants
Variant 1 · object
A reduce-only market exit on the same size: fires at triggerPrice and fills no worse than limitPrice.
triggerPricestringrequiredThe mark price that fires this exit.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$"
limitPricestringrequiredThe worst price the exit may fill at once fired; it executes as a market order within it.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$"
Variant 2 · null
stopLossanyOfrequiredA reduce-only stop-loss, or null.
Show attributes
A reduce-only stop-loss, or null.
anyOf · 2 variants
Variant 1 · object
A reduce-only market exit on the same size: fires at triggerPrice and fills no worse than limitPrice.
triggerPricestringrequiredThe mark price that fires this exit.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$"
limitPricestringrequiredThe worst price the exit may fill at once fired; it executes as a market order within it.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$"
Variant 2 · null
trailingStopanyOfoptionalA reduce-only trailing stop, placed after the order (or alone on the existing position); absent or null for none. It carries no builder fee.
Show attributes
A reduce-only trailing stop, placed after the order (or alone on the existing position); absent or null for none. It carries no builder fee.
anyOf · 2 variants
Variant 1 · object
A reduce-only market exit on the same size that follows the mark price as it moves in the position's favour and fires once it reverses by the retracement.
retracementanyOfrequiredHow far the mark price may reverse from its best before the stop fires.
Show attributes
How far the mark price may reverse from its best before the stop fires.
anyOf · 2 variants
Variant 1 · object
Trail by a percentage of the best mark price.
percentstringrequiredHow far the mark price may reverse from its best since activation, in percent: 2 is 2%.
Validation rules
- Pattern
"^(0|[1-9][0-9]?)(\\.[0-9]{0,3}[1-9])?$"
Variant 2 · object
Trail by a fixed price distance.
pricestringrequiredHow far the mark price may reverse from its best since activation, in price units.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$"
activationPriceanyOfrequiredThe mark price that starts the trailing; null to trail from placement.
Show attributes
The mark price that starts the trailing; null to trail from placement.
anyOf · 2 variants
Variant 1 · string
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$"
Variant 2 · null
Variant 2 · null
outcomeanyOfrequiredHyperliquid's answer, with each placement's fill. Null while the order is being sent or its answer is still being checked; the run never sends it twice.
Show attributes
Hyperliquid's answer, with each placement's fill. Null while the order is being sent or its answer is still being checked; the run never sends it twice.
anyOf · 2 variants
Variant 1 · object
The result of one approved perps order, cancellation or margin change.
statusstringrequiredplaced Hyperliquid accepted the order (see each placement), rejected it accepted none (or refused the margin change), uncertain the answer was lost and the host reconciles what is still unknown by client order id (a trailing stop with no answer only when one order matches its terms; a margin change from the account's own transaction list), cancelled the cancellation took effect, applied the margin change took effect, not_executed nothing was signed.
Validation rules
- Allowed values
["placed","rejected","uncertain","cancelled","applied","not_executed"]
placementsarrayrequiredEach placement's own answer, in the order's order: entry, take-profit, stop-loss, then trailing stop.
Show attributes
Each placement's own answer, in the order's order: entry, take-profit, stop-loss, then trailing stop.
Validation rules
- Maximum items
4
Array items · object
What one placement of an order came to on Hyperliquid.
rolestringrequiredWhich part of the order: entry, take_profit, stop_loss or trailing_stop.
Validation rules
- Allowed values
["entry","take_profit","stop_loss","trailing_stop"]
cloidanyOfrequiredThe client order id it is reconciled by; null for a trailing stop, which Hyperliquid gives none and the host matches by its terms instead.
Show attributes
The client order id it is reconciled by; null for a trailing stop, which Hyperliquid gives none and the host matches by its terms instead.
anyOf · 2 variants
Variant 1 · string
Validation rules
- Pattern
"^0x[0-9a-f]{32}$"
Variant 2 · null
statestringrequiredfilled executed (possibly partly; see filledSize), resting waits on the book, triggered_pending is an exit waiting for its trigger, triggered is an exit whose trigger fired and became a market order (its fill is in the account's fills, not here), rejected never placed, unknown not yet known: never resubmit it.
Validation rules
- Allowed values
["filled","resting","triggered_pending","triggered","cancelled","rejected","unknown"]
oidanyOfrequiredHyperliquid's order id once it named one; null for a trigger it answered without one, or an answer not yet known.
Show attributes
Hyperliquid's order id once it named one; null for a trigger it answered without one, or an answer not yet known.
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Greater than
0- Maximum
9007199254740991
Variant 2 · null
filledSizestring or nullrequiredHow much filled, in the coin, as Hyperliquid wrote it; null when nothing filled or it did not say.
averagePricestring or nullrequiredThe average fill price, as Hyperliquid wrote it; null when it did not say.
erroranyOfrequiredHyperliquid's own refusal text for this placement; null otherwise.
Show attributes
Hyperliquid's own refusal text for this placement; null otherwise.
anyOf · 2 variants
Variant 1 · string
Validation rules
- Maximum length
512
Variant 2 · null
reasonanyOfrequiredWhy nothing was placed or the cancellation did not take effect, in Hyperliquid's or the host's words; null otherwise.
Show attributes
Why nothing was placed or the cancellation did not take effect, in Hyperliquid's or the host's words; null otherwise.
anyOf · 2 variants
Variant 1 · string
Validation rules
- Maximum length
512
Variant 2 · null
Variant 2 · null
Variant 2 · kind: margin
kindstringrequiredMargin moved from the agent wallet to the perps account.
Validation rules
- Exact value
"margin"
transferobjectrequiredThe exact USDC amount the run moved, in six-decimal units, and its loss bound.
Show attributes
The exact USDC amount the run moved, in six-decimal units, and its loss bound.
amountRawstringrequiredExact amount in six-decimal atomic units in either direction: 5 USDC is "5000000". A withdrawal returns USDC. A funding spends it from one USDC or USDT holding of the agent wallet (USDC on NEAR, Base, Arbitrum, Ethereum or Solana, or USDT on NEAR; any USDC that covers it before USDT) that alone covers it, never split across holdings, or, when it pays with a coin, that coin's value of it; Hyperliquid receives USDC. Never supply an address.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
maxValueLossBpsintegerrequiredExplicit maximum value loss in basis points, including provider fees and any swap or cross-chain hop of the USDC, USDT or coin a funding spends. Required; no default.
Validation rules
- Minimum
0- Maximum
300
payWithobjectoptionalA funding only, approved in chat as one call: the coin it pays with instead of a USDC or USDT holding, and the most of it it may spend. A withdrawal never carries it.
Show attributes
A funding only, approved in chat as one call: the coin it pays with instead of a USDC or USDT holding, and the most of it it may spend. A withdrawal never carries it.
tokenIdstringrequiredThe exact ledger asset identifier, including its token standard namespace.
Validation rules
- Maximum length
256- Pattern
"^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
maxInputRawstringrequiredThe most of the coin this funding may spend, in its smallest unit: the approved dollars at the price read when the approval opened, plus 5%.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
outcomeanyOfrequiredHow the transfer ended. Null while it is still under way.
Show attributes
How the transfer ended. Null while it is still under way.
anyOf · 2 variants
Variant 1 · anyOf
anyOf · 4 variants
Variant 1 · status: in_progress
statusstringrequiredValidation rules
- Exact value
"in_progress"
operationIdstring · uuidrequiredThe persisted financial operation still owned by its durable executor.
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)$"
Variant 2 · status: no_trade
statusstringrequiredThe request resolved without attempting a financial action.
Validation rules
- Exact value
"no_trade"
Variant 3 · status: refused
statusstringrequiredThe financial command refused execution under its authority or safety checks.
Validation rules
- Exact value
"refused"
scopestringrequiredThe bounded category of the refusal; no provider text, account details or amounts are exposed here. buy_too_small (a Solana buy below its minimum), reserve_required (it would spend the SOL the Solana account keeps for fees) and loss_bound_exceeded (no route returned at least the approved minimum) can be corrected by asking the user for other terms; token_blocked means the token's own rules, or its missing price, keep it from trading through fin; route_unavailable means the requested financial route was not available; nothing_freed means a cash-out's withdrawal found nothing its exit freed to bring home.
Validation rules
- Allowed values
["authority","request","transient","insufficient_funds","request_frozen","verification","stale_evidence","account_busy","conflict","paused","held","withdrawn","spend_cap_reached","no_signing_authority","not_available_in_region","no_account","withdrawal_too_small","withdrawal_reserve_required","nothing_freed","order_invalid","route_unavailable","buy_too_small","reserve_required","loss_bound_exceeded","token_blocked"]
Variant 4 · object
statusstringrequiredThe financial outcome: settled, unresolved, mixed or incomplete, refunded, or conclusively not executed. An outcome can still be waiting for receipts; the trade's or withdrawal's status says whether it is final.
Validation rules
- Allowed values
["settled","pending","partial","refunded","not_executed"]
reasonstringoptionalPresent when execution was restricted to a mode that cannot sign or move funds.
Validation rules
- Exact value
"signing_disabled"
stoppedobjectoptionalPresent only on a partial outcome whose run refused a later leg before it was claimed: the planned action the run stopped on and the bounded reason it never started.
Show attributes
Present only on a partial outcome whose run refused a later leg before it was claimed: the planned action the run stopped on and the bounded reason it never started.
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
reasonstringrequiredThe bounded category the stopped leg was refused with; no provider text, account details or amounts.
Validation rules
- Allowed values
["lineage_unavailable","consent_invalid","allowance_exhausted","spend_cap_reached","position_unknown","exit_not_reached","selection_mismatch","action_mismatch","request_frozen","insufficient_funds","evidence_unavailable","inventory_stale","plan_conflict","leg_order","quote_invalid","payload_invalid","account_busy","expired","credentials_unavailable","execution_paused","automation_held","authority_withdrawn","perps_disabled","prediction_disabled","not_available_in_region","no_account","withdrawal_too_small","withdrawal_reserve_required","nothing_freed","order_invalid","route_unsupported","route_changed","solana_disabled","token_unpriced","token_mismatch","token_freezable","token_transfer_hook","token_permanent_delegate","token_non_transferable","token_default_frozen","token_transfer_fee","token_pausable","token_unknown_extension","token_not_sellable","route_invalid","loss_bound_exceeded","reserve_required","buy_too_small","swap_already_landed","solana_unavailable"]
blockedarrayoptionalUnclaimed actions blocked before dispatch, with unique indices disjoint from all actual legs.
Show attributes
Unclaimed actions blocked before dispatch, with unique indices disjoint from all actual legs.
Validation rules
- Minimum items
1- Maximum items
16
Array items · object
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
reasonstringrequiredThe bounded category the stopped leg was refused with; no provider text, account details or amounts.
Validation rules
- Allowed values
["lineage_unavailable","consent_invalid","allowance_exhausted","spend_cap_reached","position_unknown","exit_not_reached","selection_mismatch","action_mismatch","request_frozen","insufficient_funds","evidence_unavailable","inventory_stale","plan_conflict","leg_order","quote_invalid","payload_invalid","account_busy","expired","credentials_unavailable","execution_paused","automation_held","authority_withdrawn","perps_disabled","prediction_disabled","not_available_in_region","no_account","withdrawal_too_small","withdrawal_reserve_required","nothing_freed","order_invalid","route_unsupported","route_changed","solana_disabled","token_unpriced","token_mismatch","token_freezable","token_transfer_hook","token_permanent_delegate","token_non_transferable","token_default_frozen","token_transfer_fee","token_pausable","token_unknown_extension","token_not_sellable","route_invalid","loss_bound_exceeded","reserve_required","buy_too_small","swap_already_landed","solana_unavailable"]
legsarrayrequiredThe actual execution legs represented by this outcome; unattempted planned legs have no invented receipt.
Show attributes
The actual execution legs represented by this outcome; unattempted planned legs have no invented receipt.
Validation rules
- Maximum items
16
Array items · object
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
statestringrequiredThe recorded execution or settlement state of this actual leg.
Validation rules
- Allowed values
["claimed","signed","uncertain","settled","refunded","not_executed"]
solanaobjectoptionalPresent only on a Solana operation's outcome: what it paid, received and signed on Solana. legs are its 1Click legs.
Show attributes
Present only on a Solana operation's outcome: what it paid, received and signed on Solana. legs are its 1Click legs.
sidestringrequiredWhich Solana operation this is: a buy, a sell, a fund or a withdrawal.
Validation rules
- Allowed values
["buy","sell","fund","withdraw"]
tokenobjectoptionalThe token bought or sold; absent for a fund or a withdrawal.
Show attributes
The token bought or sold; absent for a fund or a withdrawal.
mintstringrequiredThe token's mint address, exactly as solana_token_search or solana_token returned it. Never a ticker.
Validation rules
- Minimum length
32- Maximum length
44- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
decimalsintegerrequiredThe mint's decimals, exactly as returned with the mint.
Validation rules
- Minimum
0- Maximum
18
tokenProgramstringrequiredThe program that owns the mint, exactly as returned with the mint: spl_token or token_2022.
Validation rules
- Allowed values
["spl_token","token_2022"]
accountstringrequiredThe agent's own Solana account the operation used.
Validation rules
- Minimum length
32- Maximum length
44- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
transactionsarrayrequiredEvery transaction the operation signed, in the order it signed them. A multi-coin sale lists here only its one transfer back: each coin's swaps are under its own entry of sales.
Show attributes
Every transaction the operation signed, in the order it signed them. A multi-coin sale lists here only its one transfer back: each coin's swaps are under its own entry of sales.
Validation rules
- Maximum items
6
Array items · object
One signed Solana transaction of this operation.
purposestringrequiredswap trades on Jupiter; sweep sends SOL back to the agent wallet through 1Click.
Validation rules
- Allowed values
["swap","sweep"]
signaturestringrequiredA Solana transaction signature, which is also its id: base58 text of 64 bytes.
Validation rules
- Minimum length
64- Maximum length
88- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
statestringrequiredsigned and dispatching are not yet sent or not yet seen; landed succeeded on chain, failed landed with an error, expired provably never will; uncertain is not yet known: never sign it again.
Validation rules
- Allowed values
["signed","dispatching","landed","failed","expired","uncertain"]
feeLamportsstringoptionalThe network fee the transaction paid, in lamports, once it landed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
paidobjectoptionalWhat the operation spent, once known.
Show attributes
What the operation spent, once known.
assetstringrequiredusdc is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, sol is SOL, token is the operation's own token.
Validation rules
- Allowed values
["usdc","sol","token"]
amountRawstringrequiredThe exact amount, in the asset's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
receivedobjectoptionalWhat the operation received, once it landed or settled.
Show attributes
What the operation received, once it landed or settled.
assetstringrequiredusdc is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, sol is SOL, token is the operation's own token.
Validation rules
- Allowed values
["usdc","sol","token"]
amountRawstringrequiredThe exact amount, in the asset's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
solLeftLamportsstringoptionalSOL the operation left in the Solana account, in lamports: what a partial outcome left behind.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
salesarrayoptionalPresent only on a multi-coin sale's outcome: each sale in the order it ran. received is what the whole sale returned.
Show attributes
Present only on a multi-coin sale's outcome: each sale in the order it ran. received is what the whole sale returned.
Validation rules
- Maximum items
6
Array items · object
One coin of a multi-coin sale, and what became of it.
tokenobjectrequiredThe coin this sale sold, or was to sell.
Show attributes
The coin this sale sold, or was to sell.
mintstringrequiredThe token's mint address, exactly as solana_token_search or solana_token returned it. Never a ticker.
Validation rules
- Minimum length
32- Maximum length
44- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
decimalsintegerrequiredThe mint's decimals, exactly as returned with the mint.
Validation rules
- Minimum
0- Maximum
18
tokenProgramstringrequiredThe program that owns the mint, exactly as returned with the mint: spl_token or token_2022.
Validation rules
- Allowed values
["spl_token","token_2022"]
statestringrequiredsold once its swap landed; not_sold when it ended without selling anything (refused before any signature, every attempt failed or expired, or the sale stopped before it); uncertain while an attempt of it may still land: never sign it again.
Validation rules
- Allowed values
["sold","not_sold","uncertain"]
paidobjectoptionalWhat this sale sold, once its swap landed: the token's exact amount.
Show attributes
What this sale sold, once its swap landed: the token's exact amount.
assetstringrequiredusdc is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, sol is SOL, token is the operation's own token.
Validation rules
- Allowed values
["usdc","sol","token"]
amountRawstringrequiredThe exact amount, in the asset's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
solGainedLamportsstringoptionalThe SOL this sale's landed swap added to the Solana account, in lamports, before the one transfer back.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
transactionsarrayoptionalThis coin's swap attempts the sale signed, in the order it signed them; absent while none was signed.
Show attributes
This coin's swap attempts the sale signed, in the order it signed them; absent while none was signed.
Validation rules
- Maximum items
3
Array items · object
One signed Solana transaction of this operation.
purposestringrequiredswap trades on Jupiter; sweep sends SOL back to the agent wallet through 1Click.
Validation rules
- Allowed values
["swap","sweep"]
signaturestringrequiredA Solana transaction signature, which is also its id: base58 text of 64 bytes.
Validation rules
- Minimum length
64- Maximum length
88- Pattern
"^[1-9A-HJ-NP-Za-km-z]+$"
statestringrequiredsigned and dispatching are not yet sent or not yet seen; landed succeeded on chain, failed landed with an error, expired provably never will; uncertain is not yet known: never sign it again.
Validation rules
- Allowed values
["signed","dispatching","landed","failed","expired","uncertain"]
feeLamportsstringoptionalThe network fee the transaction paid, in lamports, once it landed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · null
Variant 2 · null
nextCursorstring or nullrequiredThe cursor for the next page; null once there are no more rows.
totalintegerrequiredHow many rows the list holds in all.
Validation rules
- Minimum
0- Maximum
9007199254740991
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;issuesnames each fieldinvalid_cursor— thecursoris 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.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
401 A credential is missing, invalid or expired.
A credential is missing, invalid or expired.
partner_key_required— noX-Api-Keyheader was sentpartner_key_invalid— theX-Api-Keyis unknown or revokedcredential_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.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy 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 useraccount_disabled— an operator disabled the accountorigin_rejected— a browserOriginother than the configured web originpermission_required— the verified credential is not permitted to make this call
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy 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.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
429 A limit refused the request; wait for `Retry-After` when it is sent.
A limit refused the request; wait for Retry-After when it is sent.
rate_limited— the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity— this partner's request quota across all keys and replicas 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.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy 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; quoterequestIdwhen 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.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
503 The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); `retryable` says whether to try again.
The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); retryable says whether to try again.
internal— a fault on our side; quoterequestIdwhen 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.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
Complete OpenAPI definition
The exact operation and all referenced components, including recursive schemas.
{
"operation": {
"operationId": "automations.listRuns",
"summary": "List an automation's runs",
"tags": [
"automations"
],
"description": "Lists each time the automation ran or was due to run, newest first, with the outcome and the agent run it started.",
"parameters": [
{
"schema": {
"type": "string",
"maxLength": 256
},
"in": "query",
"name": "cursor",
"required": false,
"description": "Where the previous page ended; omit for the first page"
},
{
"schema": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"in": "query",
"name": "limit",
"required": false,
"description": "How many rows to answer, at most 100"
},
{
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
},
"in": "path",
"name": "userId",
"required": true,
"description": "Your id for the user: the `userId` you sent to Create a user. It must be the session's user."
},
{
"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": "automationId",
"required": true,
"description": "The automation's id."
}
],
"security": [
{
"apiKey": [],
"userToken": []
}
],
"responses": {
"200": {
"description": "The automation's runs.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutomationRun"
},
"description": "This page's rows."
},
"nextCursor": {
"description": "The cursor for the next page; null once there are no more rows.",
"type": [
"string",
"null"
]
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "How many rows the list holds in all."
}
},
"required": [
"data",
"nextCursor",
"total"
]
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidInput"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
},
"500": {
"$ref": "#/components/responses/Internal"
},
"503": {
"$ref": "#/components/responses/Unavailable"
}
}
},
"components": {
"schemas": {
"AutomationRun": {
"type": "object",
"properties": {
"id": {
"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 automation run's id."
},
"deliverySequence": {
"type": "string",
"pattern": "^[1-9]\\d*$",
"description": "This automation run's place in delivery order across all automations, as a string so it sorts and compares exactly at any size. A paging cursor, not a count of this automation's runs: `runNumber` is that."
},
"automationId": {
"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 automation's id."
},
"definitionVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The automation definition version this automation run was recorded under."
},
"activationEpoch": {
"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 activation epoch this automation run was recorded under."
},
"name": {
"type": "string",
"description": "The automation's name when this automation run was recorded."
},
"prompt": {
"type": "string",
"description": "The automation's prompt when this automation run was recorded."
},
"evidence": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"decision",
"external"
],
"description": "What produced this automation run: `decision` the rule's own condition, `external` a source that decided on the engine's behalf."
},
"identity": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "A stable string identifying this exact decision, used to deduplicate exact replays within one activation. Reuse with changed data conflicts."
},
"evaluatedAt": {
"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 decision was made."
},
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/components/schemas/AutomationJsonValue"
},
"description": "The observations behind one decision, exactly as evaluated. Bounded to 256 KiB, 24 levels of nesting and 16384 entries."
},
"sourceChecks": {
"description": "Recipe checks recorded for each source this decision read, when evidence review is configured.",
"maxItems": 4,
"type": "array",
"items": {
"type": "object",
"properties": {
"binding": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding this check was collected for."
},
"sourceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "The source's id within its provider."
},
"eventId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "The specific event or observation this check backs."
},
"operationId": {
"type": "string",
"pattern": "^[a-z][a-z0-9_.-]{0,79}$",
"description": "The collection operation this check ran."
},
"operationVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The collection operation's version."
},
"check": {
"type": "object",
"properties": {
"recipe": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The recipe description's own version, bumped when its steps change."
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 120,
"description": "The recipe's short label, for the reviewed catalog."
},
"summary": {
"type": "string",
"minLength": 1,
"maxLength": 600,
"description": "What the recipe does, for the reviewed catalog."
},
"steps": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z][a-z0-9_-]{0,47}$",
"description": "The step's identifier, unique within its recipe."
},
"kind": {
"type": "string",
"enum": [
"request",
"validate",
"calculate"
],
"description": "What this step does: `request` calls the provider, `validate` checks what it returned, `calculate` derives a value from earlier steps."
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 120,
"description": "The step's short label, for the reviewed catalog."
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 600,
"description": "What this step does, for the reviewed catalog."
},
"api": {
"type": "object",
"properties": {
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"GRAPHQL"
],
"description": "The request's method or protocol."
},
"resource": {
"type": "string",
"minLength": 1,
"maxLength": 160,
"pattern": "^\\/?[A-Za-z0-9_{}][A-Za-z0-9_./{} -]*$",
"description": "The request's path or resource name."
}
},
"required": [
"method",
"resource"
],
"description": "The request this step makes, when it calls the provider."
}
},
"required": [
"id",
"kind",
"title",
"description"
]
},
"description": "The recipe's steps, in order."
},
"limitations": {
"maxItems": 6,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 600
},
"description": "What the recipe does not cover, in the reviewer's own words."
},
"fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "A content hash identifying this exact recipe, independent of execution or connection identity."
}
},
"required": [
"version",
"title",
"summary",
"steps",
"limitations",
"fingerprint"
],
"description": "A reviewed, public description of how a source is collected: the steps a reviewer confirmed, never an executable request or a resolved private endpoint."
},
"startedAt": {
"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 check began."
},
"completedAt": {
"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 check finished."
},
"status": {
"type": "string",
"enum": [
"completed",
"failed"
],
"description": "Whether every step completed."
},
"steps": {
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string",
"pattern": "^[a-z][a-z0-9_-]{0,47}$",
"description": "The declared recipe step this check reports on."
},
"outcome": {
"type": "string",
"enum": [
"completed",
"failed"
],
"description": "Whether the step completed or failed."
},
"requestCount": {
"description": "How many requests this step made, when it made any.",
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"itemCount": {
"description": "How many items this step processed, when counting applies.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"durationMs": {
"description": "How long this step took, in milliseconds.",
"type": "integer",
"minimum": 0,
"maximum": 600000
},
"reason": {
"description": "Why the step failed, when it did: `not_configured` the source lacks a needed setting, `unavailable` the provider did not answer, `malformed` its answer could not be read, `oversized` the answer exceeded a bound, `stale` or `future` a timestamp was out of range, `incomplete` part of the answer was missing, `invalid` the answer failed validation, `canceled` the check was stopped before finishing.",
"type": "string",
"enum": [
"not_configured",
"unavailable",
"malformed",
"oversized",
"stale",
"future",
"incomplete",
"invalid",
"canceled"
]
}
},
"required": [
"stepId",
"outcome"
],
"description": "One recipe step's recorded outcome: counts and a closed reason only, never a URL, body, cursor, address or error message."
},
"description": "Each step's own recorded outcome, in order."
}
},
"required": [
"recipe",
"startedAt",
"completedAt",
"status",
"steps"
],
"description": "A recorded run of a recipe's steps against the real source, kept as evidence."
}
},
"required": [
"binding",
"sourceId",
"eventId",
"operationId",
"operationVersion",
"check"
],
"description": "Frozen recipe evidence tied to the actual observation used by one decision."
}
}
},
"required": [
"kind",
"identity",
"evaluatedAt",
"data"
],
"description": "Why this automation run happened: the decision, its evaluated data, and any recipe checks behind it."
},
"selection": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "entry",
"description": "This firing runs every entry action of the contract, in order."
}
},
"required": [
"kind"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exit",
"description": "This firing runs exactly one exit action."
},
"actionIndex": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The zero-based index of the approved exit action this firing selected."
},
"exitKind": {
"type": "string",
"enum": [
"take_profit",
"stop_loss",
"harvest_every"
],
"description": "Which guard fired: a take-profit, a stop-loss or a scheduled harvest."
}
},
"required": [
"kind",
"actionIndex",
"exitKind"
]
}
],
"description": "What this automation run's firing selected out of its contract: every entry action in order (`Scheduled buy`), or exactly one exit action (`Take-profit exit`/`Stop-loss exit`). A definition without a contract records `{ kind: \"entry\" }`."
},
"state": {
"type": "string",
"enum": [
"pending",
"deferred",
"accepted",
"retrying",
"succeeded",
"partial",
"failed",
"uncertain",
"rejected",
"canceled",
"skipped",
"coalesced"
],
"description": "This automation run's state: `pending` waiting to start, `deferred` an admission attempt failed and is waiting to retry, `accepted` handed to an agent run, `retrying` waiting to try again before its deadline, `succeeded` it did what it was asked, `partial` only some of it went through, `failed` it moved nothing it was asked to, `uncertain` money may have moved and how it ended is not known yet, `rejected` the delivery policy refused it outright, or a non-retryable admission failure (or an exhausted retry deadline) stopped it, `canceled` stopped before starting, `skipped` an earlier automation run was still active or it was missed, `coalesced` merged into a newer match."
},
"reason": {
"description": "Why the automation run is in this state, when there is one to give. A run that failed or went through only in part gives one of `unavailable`, `insufficient_funds`, `quote_rejected`, `not_authorized`, `not_executed` or `condition_passed`.",
"type": [
"string",
"null"
]
},
"runNumber": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "Which of its automation's runs this is, counting from 1, the number its run limit counts. Null for a run that is no scheduled or triggered firing of its own, such as an exit check selling a position. Show this, not `deliverySequence`."
},
"createdAt": {
"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 automation run was recorded."
},
"deliveryDeadline": {
"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": "The latest this automation run could still start."
},
"deadlineAt": {
"description": "The latest this run may still try, once it has started: the earliest of its delivery deadline, the windows its owner signed and its next firing. Null or absent for a run that never started, or one from before this field. Use it, not `deliveryDeadline`, to say how long a run had.",
"anyOf": [
{
"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))$"
},
{
"type": "null"
}
]
},
"nextAttemptAt": {
"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 the next attempt to start this automation run is due."
},
"lastAttemptAt": {
"anyOf": [
{
"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))$"
},
{
"type": "null"
}
],
"description": "When this automation run was last tried, when it has been."
},
"attempts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "How many attempts to start this automation run there have been."
},
"conversationId": {
"anyOf": [
{
"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 conversation's id."
},
{
"type": "null"
}
],
"description": "The conversation this automation run works in, once it has one."
},
"runId": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
],
"description": "The agent run this automation run started, once it has one."
},
"runStatus": {
"anyOf": [
{
"type": "string",
"enum": [
"running",
"paused",
"completed",
"failed",
"aborted"
]
},
{
"type": "null"
}
],
"description": "That agent run's status, once it has one: `running`, `paused` while an approval waits, then `completed`, `failed` or `aborted`."
},
"runError": {
"description": "Why the agent run failed, when it did.",
"type": [
"string",
"null"
]
},
"pendingApprovals": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "How many approvals this automation run's agent run is waiting on."
},
"solana": {
"description": "For a Solana trading automation, the admitted trade and its observed result. Absent or null before it acts and for other automations. Read this result independently of runStatus.",
"anyOf": [
{
"$ref": "#/components/schemas/AutomationRunSolana"
},
{
"type": "null"
}
]
},
"perps": {
"anyOf": [
{
"$ref": "#/components/schemas/AutomationRunPerps"
},
{
"type": "null"
}
],
"description": "For a perps automation, the order this run placed or the margin it added, with Hyperliquid's answer. Null for any other automation, and until the run acts."
}
},
"required": [
"id",
"deliverySequence",
"automationId",
"definitionVersion",
"activationEpoch",
"name",
"prompt",
"evidence",
"selection",
"state",
"reason",
"runNumber",
"createdAt",
"deliveryDeadline",
"nextAttemptAt",
"lastAttemptAt",
"attempts",
"conversationId",
"runId",
"runStatus",
"runError",
"pendingApprovals",
"perps"
],
"description": "One time an automation ran or was due to run: why, its delivery state, and the agent run it started, if any."
},
"AutomationJsonValue": {
"description": "Any JSON value: a string, number, boolean, null, array or object, nested to any depth.",
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AutomationJsonValue"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/components/schemas/AutomationJsonValue"
}
}
]
},
"AutomationRunSolana": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"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 Solana activity item’s id, for its receipt in History."
},
"kind": {
"type": "string",
"const": "buy"
},
"request": {
"$ref": "#/components/schemas/SolanaBuyInput"
},
"outcome": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "in_progress"
},
"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": "The persisted financial operation still owned by its durable executor."
}
},
"required": [
"status",
"operationId"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "no_trade",
"description": "The request resolved without attempting a financial action."
}
},
"required": [
"status"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "refused",
"description": "The financial command refused execution under its authority or safety checks."
},
"scope": {
"type": "string",
"enum": [
"authority",
"request",
"transient",
"insufficient_funds",
"request_frozen",
"verification",
"stale_evidence",
"account_busy",
"conflict",
"paused",
"held",
"withdrawn",
"spend_cap_reached",
"no_signing_authority",
"not_available_in_region",
"no_account",
"withdrawal_too_small",
"withdrawal_reserve_required",
"nothing_freed",
"order_invalid",
"route_unavailable",
"buy_too_small",
"reserve_required",
"loss_bound_exceeded",
"token_blocked"
],
"description": "The bounded category of the refusal; no provider text, account details or amounts are exposed here. `buy_too_small` (a Solana buy below its minimum), `reserve_required` (it would spend the SOL the Solana account keeps for fees) and `loss_bound_exceeded` (no route returned at least the approved minimum) can be corrected by asking the user for other terms; `token_blocked` means the token's own rules, or its missing price, keep it from trading through fin; `route_unavailable` means the requested financial route was not available; `nothing_freed` means a cash-out's withdrawal found nothing its exit freed to bring home."
}
},
"required": [
"status",
"scope"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"settled",
"pending",
"partial",
"refunded",
"not_executed"
],
"description": "The financial outcome: settled, unresolved, mixed or incomplete, refunded, or conclusively not executed. An outcome can still be waiting for receipts; the trade's or withdrawal's `status` says whether it is final."
},
"reason": {
"description": "Present when execution was restricted to a mode that cannot sign or move funds.",
"type": "string",
"const": "signing_disabled"
},
"stopped": {
"description": "Present only on a partial outcome whose run refused a later leg before it was claimed: the planned action the run stopped on and the bounded reason it never started.",
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"reason": {
"type": "string",
"enum": [
"lineage_unavailable",
"consent_invalid",
"allowance_exhausted",
"spend_cap_reached",
"position_unknown",
"exit_not_reached",
"selection_mismatch",
"action_mismatch",
"request_frozen",
"insufficient_funds",
"evidence_unavailable",
"inventory_stale",
"plan_conflict",
"leg_order",
"quote_invalid",
"payload_invalid",
"account_busy",
"expired",
"credentials_unavailable",
"execution_paused",
"automation_held",
"authority_withdrawn",
"perps_disabled",
"prediction_disabled",
"not_available_in_region",
"no_account",
"withdrawal_too_small",
"withdrawal_reserve_required",
"nothing_freed",
"order_invalid",
"route_unsupported",
"route_changed",
"solana_disabled",
"token_unpriced",
"token_mismatch",
"token_freezable",
"token_transfer_hook",
"token_permanent_delegate",
"token_non_transferable",
"token_default_frozen",
"token_transfer_fee",
"token_pausable",
"token_unknown_extension",
"token_not_sellable",
"route_invalid",
"loss_bound_exceeded",
"reserve_required",
"buy_too_small",
"swap_already_landed",
"solana_unavailable"
],
"description": "The bounded category the stopped leg was refused with; no provider text, account details or amounts."
}
},
"required": [
"index",
"reason"
]
},
"blocked": {
"description": "Unclaimed actions blocked before dispatch, with unique indices disjoint from all actual legs.",
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"reason": {
"type": "string",
"enum": [
"lineage_unavailable",
"consent_invalid",
"allowance_exhausted",
"spend_cap_reached",
"position_unknown",
"exit_not_reached",
"selection_mismatch",
"action_mismatch",
"request_frozen",
"insufficient_funds",
"evidence_unavailable",
"inventory_stale",
"plan_conflict",
"leg_order",
"quote_invalid",
"payload_invalid",
"account_busy",
"expired",
"credentials_unavailable",
"execution_paused",
"automation_held",
"authority_withdrawn",
"perps_disabled",
"prediction_disabled",
"not_available_in_region",
"no_account",
"withdrawal_too_small",
"withdrawal_reserve_required",
"nothing_freed",
"order_invalid",
"route_unsupported",
"route_changed",
"solana_disabled",
"token_unpriced",
"token_mismatch",
"token_freezable",
"token_transfer_hook",
"token_permanent_delegate",
"token_non_transferable",
"token_default_frozen",
"token_transfer_fee",
"token_pausable",
"token_unknown_extension",
"token_not_sellable",
"route_invalid",
"loss_bound_exceeded",
"reserve_required",
"buy_too_small",
"swap_already_landed",
"solana_unavailable"
],
"description": "The bounded category the stopped leg was refused with; no provider text, account details or amounts."
}
},
"required": [
"index",
"reason"
]
}
},
"legs": {
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"state": {
"type": "string",
"enum": [
"claimed",
"signed",
"uncertain",
"settled",
"refunded",
"not_executed"
],
"description": "The recorded execution or settlement state of this actual leg."
}
},
"required": [
"index",
"state"
]
},
"description": "The actual execution legs represented by this outcome; unattempted planned legs have no invented receipt."
},
"solana": {
"description": "Present only on a Solana operation's outcome: what it paid, received and signed on Solana. `legs` are its 1Click legs.",
"$ref": "#/components/schemas/SolanaOperationDetail"
}
},
"required": [
"status",
"legs"
]
}
]
},
{
"type": "null"
}
],
"description": "The observed financial result. Null until there is one; an agent run completing does not prove that money moved."
}
},
"required": [
"id",
"kind",
"request",
"outcome"
]
},
{
"type": "object",
"properties": {
"id": {
"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 Solana activity item’s id, for its receipt in History."
},
"kind": {
"type": "string",
"const": "sell"
},
"request": {
"$ref": "#/components/schemas/SolanaSellInput"
},
"outcome": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "in_progress"
},
"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": "The persisted financial operation still owned by its durable executor."
}
},
"required": [
"status",
"operationId"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "no_trade",
"description": "The request resolved without attempting a financial action."
}
},
"required": [
"status"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "refused",
"description": "The financial command refused execution under its authority or safety checks."
},
"scope": {
"type": "string",
"enum": [
"authority",
"request",
"transient",
"insufficient_funds",
"request_frozen",
"verification",
"stale_evidence",
"account_busy",
"conflict",
"paused",
"held",
"withdrawn",
"spend_cap_reached",
"no_signing_authority",
"not_available_in_region",
"no_account",
"withdrawal_too_small",
"withdrawal_reserve_required",
"nothing_freed",
"order_invalid",
"route_unavailable",
"buy_too_small",
"reserve_required",
"loss_bound_exceeded",
"token_blocked"
],
"description": "The bounded category of the refusal; no provider text, account details or amounts are exposed here. `buy_too_small` (a Solana buy below its minimum), `reserve_required` (it would spend the SOL the Solana account keeps for fees) and `loss_bound_exceeded` (no route returned at least the approved minimum) can be corrected by asking the user for other terms; `token_blocked` means the token's own rules, or its missing price, keep it from trading through fin; `route_unavailable` means the requested financial route was not available; `nothing_freed` means a cash-out's withdrawal found nothing its exit freed to bring home."
}
},
"required": [
"status",
"scope"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"settled",
"pending",
"partial",
"refunded",
"not_executed"
],
"description": "The financial outcome: settled, unresolved, mixed or incomplete, refunded, or conclusively not executed. An outcome can still be waiting for receipts; the trade's or withdrawal's `status` says whether it is final."
},
"reason": {
"description": "Present when execution was restricted to a mode that cannot sign or move funds.",
"type": "string",
"const": "signing_disabled"
},
"stopped": {
"description": "Present only on a partial outcome whose run refused a later leg before it was claimed: the planned action the run stopped on and the bounded reason it never started.",
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"reason": {
"type": "string",
"enum": [
"lineage_unavailable",
"consent_invalid",
"allowance_exhausted",
"spend_cap_reached",
"position_unknown",
"exit_not_reached",
"selection_mismatch",
"action_mismatch",
"request_frozen",
"insufficient_funds",
"evidence_unavailable",
"inventory_stale",
"plan_conflict",
"leg_order",
"quote_invalid",
"payload_invalid",
"account_busy",
"expired",
"credentials_unavailable",
"execution_paused",
"automation_held",
"authority_withdrawn",
"perps_disabled",
"prediction_disabled",
"not_available_in_region",
"no_account",
"withdrawal_too_small",
"withdrawal_reserve_required",
"nothing_freed",
"order_invalid",
"route_unsupported",
"route_changed",
"solana_disabled",
"token_unpriced",
"token_mismatch",
"token_freezable",
"token_transfer_hook",
"token_permanent_delegate",
"token_non_transferable",
"token_default_frozen",
"token_transfer_fee",
"token_pausable",
"token_unknown_extension",
"token_not_sellable",
"route_invalid",
"loss_bound_exceeded",
"reserve_required",
"buy_too_small",
"swap_already_landed",
"solana_unavailable"
],
"description": "The bounded category the stopped leg was refused with; no provider text, account details or amounts."
}
},
"required": [
"index",
"reason"
]
},
"blocked": {
"description": "Unclaimed actions blocked before dispatch, with unique indices disjoint from all actual legs.",
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"reason": {
"type": "string",
"enum": [
"lineage_unavailable",
"consent_invalid",
"allowance_exhausted",
"spend_cap_reached",
"position_unknown",
"exit_not_reached",
"selection_mismatch",
"action_mismatch",
"request_frozen",
"insufficient_funds",
"evidence_unavailable",
"inventory_stale",
"plan_conflict",
"leg_order",
"quote_invalid",
"payload_invalid",
"account_busy",
"expired",
"credentials_unavailable",
"execution_paused",
"automation_held",
"authority_withdrawn",
"perps_disabled",
"prediction_disabled",
"not_available_in_region",
"no_account",
"withdrawal_too_small",
"withdrawal_reserve_required",
"nothing_freed",
"order_invalid",
"route_unsupported",
"route_changed",
"solana_disabled",
"token_unpriced",
"token_mismatch",
"token_freezable",
"token_transfer_hook",
"token_permanent_delegate",
"token_non_transferable",
"token_default_frozen",
"token_transfer_fee",
"token_pausable",
"token_unknown_extension",
"token_not_sellable",
"route_invalid",
"loss_bound_exceeded",
"reserve_required",
"buy_too_small",
"swap_already_landed",
"solana_unavailable"
],
"description": "The bounded category the stopped leg was refused with; no provider text, account details or amounts."
}
},
"required": [
"index",
"reason"
]
}
},
"legs": {
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"state": {
"type": "string",
"enum": [
"claimed",
"signed",
"uncertain",
"settled",
"refunded",
"not_executed"
],
"description": "The recorded execution or settlement state of this actual leg."
}
},
"required": [
"index",
"state"
]
},
"description": "The actual execution legs represented by this outcome; unattempted planned legs have no invented receipt."
},
"solana": {
"description": "Present only on a Solana operation's outcome: what it paid, received and signed on Solana. `legs` are its 1Click legs.",
"$ref": "#/components/schemas/SolanaOperationDetail"
}
},
"required": [
"status",
"legs"
]
}
]
},
{
"type": "null"
}
],
"description": "The observed financial result. Null until there is one; a partial result may leave SOL in the Solana account."
}
},
"required": [
"id",
"kind",
"request",
"outcome"
]
}
],
"description": "The Solana trade this automation run admitted, with its observed financial result."
},
"SolanaBuyInput": {
"type": "object",
"properties": {
"token": {
"description": "The exact token to buy.",
"$ref": "#/components/schemas/SolanaToken"
},
"pay": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "usdc",
"description": "Pay from one USDC or USDT holding of the agent wallet (USDC on NEAR, Base, Arbitrum, Ethereum or Solana, or USDT on NEAR; any USDC that covers it before USDT), moved to Solana as SOL first."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "Exact USDC or USDT to spend, in six-decimal atomic units: $50 is \"50000000\". At least 5 (\"5000000\"); a smaller buy is refused."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Spend an exact amount of USDC or USDT from the agent wallet."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "sol",
"description": "Pay with SOL already in the agent's Solana account."
},
"lamports": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "Exact SOL to spend, in lamports (nine decimals): 0.5 SOL is \"500000000\"."
}
},
"required": [
"kind",
"lamports"
],
"description": "Spend an exact amount of SOL the agent's Solana account already holds."
}
],
"description": "What the buy spends, as an exact input amount. Buying an exact number of tokens is not supported."
},
"maxValueLossBps": {
"type": "integer",
"minimum": 1,
"maximum": 1500,
"description": "Explicit all-in maximum value loss in basis points, from the value paid to the value received, fees and price impact included: at least 1, at most 1500. Required; no default."
},
"maxSolTopUpUsdcRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The most extra USDC or USDT the funding may add to keep SOL in the Solana account for network fees, in six-decimal atomic units: \"0\" for none, at most \"1000000\" (1 USDC). Must be \"0\" when paying with SOL."
},
"payWith": {
"description": "A buy paid in dollars and approved in chat as one call: the coin its funding pays with instead of a USDC or USDT holding, and the most of it it may spend, the SOL top-up included. Never SOL. A buy from a token's page refuses it.",
"$ref": "#/components/schemas/VenueFundingPayment"
}
},
"required": [
"token",
"pay",
"maxValueLossBps",
"maxSolTopUpUsdcRaw"
],
"description": "One exact-input buy of a Solana token through the agent's own Solana account."
},
"SolanaToken": {
"type": "object",
"properties": {
"mint": {
"type": "string",
"minLength": 32,
"maxLength": 44,
"pattern": "^[1-9A-HJ-NP-Za-km-z]+$",
"description": "The token's mint address, exactly as solana_token_search or solana_token returned it. Never a ticker."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 18,
"description": "The mint's decimals, exactly as returned with the mint."
},
"tokenProgram": {
"type": "string",
"enum": [
"spl_token",
"token_2022"
],
"description": "The program that owns the mint, exactly as returned with the mint: `spl_token` or `token_2022`."
}
},
"required": [
"mint",
"decimals",
"tokenProgram"
],
"description": "One Solana token, pinned by its mint, its decimals and its token program."
},
"VenueFundingPayment": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"maxLength": 256,
"pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
"description": "The exact ledger asset identifier, including its token standard namespace."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
},
"maxInputRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The most of the coin this funding may spend, in its smallest unit: the approved dollars at the price read when the approval opened, plus 5%."
}
},
"required": [
"tokenId",
"decimals",
"maxInputRaw"
],
"description": "The coin this funding pays with and the most of it it may spend, as the owner approved them. Absent: the funding spends one USDC or USDT holding."
},
"SolanaOperationDetail": {
"type": "object",
"properties": {
"side": {
"type": "string",
"enum": [
"buy",
"sell",
"fund",
"withdraw"
],
"description": "Which Solana operation this is: a buy, a sell, a fund or a withdrawal."
},
"token": {
"description": "The token bought or sold; absent for a fund or a withdrawal.",
"$ref": "#/components/schemas/SolanaToken"
},
"account": {
"type": "string",
"minLength": 32,
"maxLength": 44,
"pattern": "^[1-9A-HJ-NP-Za-km-z]+$",
"description": "The agent's own Solana account the operation used."
},
"transactions": {
"maxItems": 6,
"type": "array",
"items": {
"type": "object",
"properties": {
"purpose": {
"type": "string",
"enum": [
"swap",
"sweep"
],
"description": "`swap` trades on Jupiter; `sweep` sends SOL back to the agent wallet through 1Click."
},
"signature": {
"type": "string",
"minLength": 64,
"maxLength": 88,
"pattern": "^[1-9A-HJ-NP-Za-km-z]+$",
"description": "A Solana transaction signature, which is also its id: base58 text of 64 bytes."
},
"state": {
"type": "string",
"enum": [
"signed",
"dispatching",
"landed",
"failed",
"expired",
"uncertain"
],
"description": "`signed` and `dispatching` are not yet sent or not yet seen; `landed` succeeded on chain, `failed` landed with an error, `expired` provably never will; `uncertain` is not yet known: never sign it again."
},
"feeLamports": {
"description": "The network fee the transaction paid, in lamports, once it landed.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
}
},
"required": [
"purpose",
"signature",
"state"
],
"description": "One signed Solana transaction of this operation."
},
"description": "Every transaction the operation signed, in the order it signed them. A multi-coin sale lists here only its one transfer back: each coin's swaps are under its own entry of `sales`."
},
"paid": {
"description": "What the operation spent, once known.",
"type": "object",
"properties": {
"asset": {
"type": "string",
"enum": [
"usdc",
"sol",
"token"
],
"description": "`usdc` is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, `sol` is SOL, `token` is the operation's own token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact amount, in the asset's smallest unit."
}
},
"required": [
"asset",
"amountRaw"
]
},
"received": {
"description": "What the operation received, once it landed or settled.",
"type": "object",
"properties": {
"asset": {
"type": "string",
"enum": [
"usdc",
"sol",
"token"
],
"description": "`usdc` is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, `sol` is SOL, `token` is the operation's own token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact amount, in the asset's smallest unit."
}
},
"required": [
"asset",
"amountRaw"
]
},
"solLeftLamports": {
"description": "SOL the operation left in the Solana account, in lamports: what a partial outcome left behind.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"sales": {
"description": "Present only on a multi-coin sale's outcome: each sale in the order it ran. `received` is what the whole sale returned.",
"maxItems": 6,
"type": "array",
"items": {
"type": "object",
"properties": {
"token": {
"description": "The coin this sale sold, or was to sell.",
"$ref": "#/components/schemas/SolanaToken"
},
"state": {
"type": "string",
"enum": [
"sold",
"not_sold",
"uncertain"
],
"description": "`sold` once its swap landed; `not_sold` when it ended without selling anything (refused before any signature, every attempt failed or expired, or the sale stopped before it); `uncertain` while an attempt of it may still land: never sign it again."
},
"paid": {
"description": "What this sale sold, once its swap landed: the token's exact amount.",
"type": "object",
"properties": {
"asset": {
"type": "string",
"enum": [
"usdc",
"sol",
"token"
],
"description": "`usdc` is the stablecoin a buy or fund paid (one USDC or USDT holding of the agent wallet, counted one raw unit for one) or the USDC on NEAR a sale or withdrawal returned, `sol` is SOL, `token` is the operation's own token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact amount, in the asset's smallest unit."
}
},
"required": [
"asset",
"amountRaw"
]
},
"solGainedLamports": {
"description": "The SOL this sale's landed swap added to the Solana account, in lamports, before the one transfer back.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"transactions": {
"description": "This coin's swap attempts the sale signed, in the order it signed them; absent while none was signed.",
"maxItems": 3,
"type": "array",
"items": {
"type": "object",
"properties": {
"purpose": {
"type": "string",
"enum": [
"swap",
"sweep"
],
"description": "`swap` trades on Jupiter; `sweep` sends SOL back to the agent wallet through 1Click."
},
"signature": {
"type": "string",
"minLength": 64,
"maxLength": 88,
"pattern": "^[1-9A-HJ-NP-Za-km-z]+$",
"description": "A Solana transaction signature, which is also its id: base58 text of 64 bytes."
},
"state": {
"type": "string",
"enum": [
"signed",
"dispatching",
"landed",
"failed",
"expired",
"uncertain"
],
"description": "`signed` and `dispatching` are not yet sent or not yet seen; `landed` succeeded on chain, `failed` landed with an error, `expired` provably never will; `uncertain` is not yet known: never sign it again."
},
"feeLamports": {
"description": "The network fee the transaction paid, in lamports, once it landed.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
}
},
"required": [
"purpose",
"signature",
"state"
],
"description": "One signed Solana transaction of this operation."
}
}
},
"required": [
"token",
"state"
],
"description": "One coin of a multi-coin sale, and what became of it."
}
}
},
"required": [
"side",
"account",
"transactions"
],
"description": "What one Solana operation did on chain."
},
"SolanaSellInput": {
"type": "object",
"properties": {
"token": {
"description": "The exact token to sell.",
"$ref": "#/components/schemas/SolanaToken"
},
"amount": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact",
"description": "Sell an exact amount of the token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "Exact amount of the token to sell, in its smallest unit (scaled by the token's decimals)."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Sell an exact amount of the token."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction",
"description": "Sell a share of what the Solana account holds of the token."
},
"bps": {
"type": "integer",
"minimum": 1,
"maximum": 10000,
"description": "The share to sell, in basis points of the account's balance of the token: all of it is 10000, half is 5000."
}
},
"required": [
"kind",
"bps"
],
"description": "Sell a share of the account's balance of the token."
}
],
"description": "How much of the token to sell."
},
"receive": {
"type": "string",
"enum": [
"usdc",
"sol"
],
"description": "`usdc` returns the proceeds to the agent wallet as USDC on NEAR, which is what selling means; `sol` keeps them as SOL in the agent's Solana account."
},
"maxValueLossBps": {
"type": "integer",
"minimum": 1,
"maximum": 1500,
"description": "Explicit all-in maximum value loss in basis points, from the value paid to the value received, fees and price impact included: at least 1, at most 1500. Required; no default."
}
},
"required": [
"token",
"amount",
"receive",
"maxValueLossBps"
],
"description": "One sell of a Solana token held in the agent's own Solana account."
},
"AutomationRunPerps": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "order",
"description": "A reduce-only order on the automation's position."
},
"order": {
"description": "The exact order the run placed: the coin, side, size and worst price (`entry.price`) this firing allowed.",
"$ref": "#/components/schemas/PerpsOrderInput"
},
"outcome": {
"anyOf": [
{
"$ref": "#/components/schemas/PerpsOrderOutcome"
},
{
"type": "null"
}
],
"description": "Hyperliquid's answer, with each placement's fill. Null while the order is being sent or its answer is still being checked; the run never sends it twice."
}
},
"required": [
"kind",
"order",
"outcome"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "margin",
"description": "Margin moved from the agent wallet to the perps account."
},
"transfer": {
"description": "The exact USDC amount the run moved, in six-decimal units, and its loss bound.",
"$ref": "#/components/schemas/PerpsTransferInput"
},
"outcome": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "in_progress"
},
"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": "The persisted financial operation still owned by its durable executor."
}
},
"required": [
"status",
"operationId"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "no_trade",
"description": "The request resolved without attempting a financial action."
}
},
"required": [
"status"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "refused",
"description": "The financial command refused execution under its authority or safety checks."
},
"scope": {
"type": "string",
"enum": [
"authority",
"request",
"transient",
"insufficient_funds",
"request_frozen",
"verification",
"stale_evidence",
"account_busy",
"conflict",
"paused",
"held",
"withdrawn",
"spend_cap_reached",
"no_signing_authority",
"not_available_in_region",
"no_account",
"withdrawal_too_small",
"withdrawal_reserve_required",
"nothing_freed",
"order_invalid",
"route_unavailable",
"buy_too_small",
"reserve_required",
"loss_bound_exceeded",
"token_blocked"
],
"description": "The bounded category of the refusal; no provider text, account details or amounts are exposed here. `buy_too_small` (a Solana buy below its minimum), `reserve_required` (it would spend the SOL the Solana account keeps for fees) and `loss_bound_exceeded` (no route returned at least the approved minimum) can be corrected by asking the user for other terms; `token_blocked` means the token's own rules, or its missing price, keep it from trading through fin; `route_unavailable` means the requested financial route was not available; `nothing_freed` means a cash-out's withdrawal found nothing its exit freed to bring home."
}
},
"required": [
"status",
"scope"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"settled",
"pending",
"partial",
"refunded",
"not_executed"
],
"description": "The financial outcome: settled, unresolved, mixed or incomplete, refunded, or conclusively not executed. An outcome can still be waiting for receipts; the trade's or withdrawal's `status` says whether it is final."
},
"reason": {
"description": "Present when execution was restricted to a mode that cannot sign or move funds.",
"type": "string",
"const": "signing_disabled"
},
"stopped": {
"description": "Present only on a partial outcome whose run refused a later leg before it was claimed: the planned action the run stopped on and the bounded reason it never started.",
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"reason": {
"type": "string",
"enum": [
"lineage_unavailable",
"consent_invalid",
"allowance_exhausted",
"spend_cap_reached",
"position_unknown",
"exit_not_reached",
"selection_mismatch",
"action_mismatch",
"request_frozen",
"insufficient_funds",
"evidence_unavailable",
"inventory_stale",
"plan_conflict",
"leg_order",
"quote_invalid",
"payload_invalid",
"account_busy",
"expired",
"credentials_unavailable",
"execution_paused",
"automation_held",
"authority_withdrawn",
"perps_disabled",
"prediction_disabled",
"not_available_in_region",
"no_account",
"withdrawal_too_small",
"withdrawal_reserve_required",
"nothing_freed",
"order_invalid",
"route_unsupported",
"route_changed",
"solana_disabled",
"token_unpriced",
"token_mismatch",
"token_freezable",
"token_transfer_hook",
"token_permanent_delegate",
"token_non_transferable",
"token_default_frozen",
"token_transfer_fee",
"token_pausable",
"token_unknown_extension",
"token_not_sellable",
"route_invalid",
"loss_bound_exceeded",
"reserve_required",
"buy_too_small",
"swap_already_landed",
"solana_unavailable"
],
"description": "The bounded category the stopped leg was refused with; no provider text, account details or amounts."
}
},
"required": [
"index",
"reason"
]
},
"blocked": {
"description": "Unclaimed actions blocked before dispatch, with unique indices disjoint from all actual legs.",
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"reason": {
"type": "string",
"enum": [
"lineage_unavailable",
"consent_invalid",
"allowance_exhausted",
"spend_cap_reached",
"position_unknown",
"exit_not_reached",
"selection_mismatch",
"action_mismatch",
"request_frozen",
"insufficient_funds",
"evidence_unavailable",
"inventory_stale",
"plan_conflict",
"leg_order",
"quote_invalid",
"payload_invalid",
"account_busy",
"expired",
"credentials_unavailable",
"execution_paused",
"automation_held",
"authority_withdrawn",
"perps_disabled",
"prediction_disabled",
"not_available_in_region",
"no_account",
"withdrawal_too_small",
"withdrawal_reserve_required",
"nothing_freed",
"order_invalid",
"route_unsupported",
"route_changed",
"solana_disabled",
"token_unpriced",
"token_mismatch",
"token_freezable",
"token_transfer_hook",
"token_permanent_delegate",
"token_non_transferable",
"token_default_frozen",
"token_transfer_fee",
"token_pausable",
"token_unknown_extension",
"token_not_sellable",
"route_invalid",
"loss_bound_exceeded",
"reserve_required",
"buy_too_small",
"swap_already_landed",
"solana_unavailable"
],
"description": "The bounded category the stopped leg was refused with; no provider text, account details or amounts."
}
},
"required": [
"index",
"reason"
]
}
},
"legs": {
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"state": {
"type": "string",
"enum": [
"claimed",
"signed",
"uncertain",
"settled",
"refunded",
"not_executed"
],
"description": "The recorded execution or settlement state of this actual leg."
}
},
"required": [
"index",
"state"
]
},
"description": "The actual execution legs represented by this outcome; unattempted planned legs have no invented receipt."
},
"solana": {
"description": "Present only on a Solana operation's outcome: what it paid, received and signed on Solana. `legs` are its 1Click legs.",
"$ref": "#/components/schemas/SolanaOperationDetail"
}
},
"required": [
"status",
"legs"
]
}
]
},
{
"type": "null"
}
],
"description": "How the transfer ended. Null while it is still under way."
}
},
"required": [
"kind",
"transfer",
"outcome"
]
}
],
"description": "What one run of a perps automation did on Hyperliquid: the reduce-only order it placed or the margin it added, with the answer it got."
},
"PerpsOrderInput": {
"type": "object",
"properties": {
"coin": {
"type": "string",
"pattern": "^(?:xyz:)?[A-Za-z0-9]{1,20}$",
"description": "The market's coin name exactly as perps_markets lists it, such as `BTC` or `xyz:TSLA`."
},
"asset": {
"type": "integer",
"minimum": 0,
"maximum": 1099999,
"description": "The market's asset id exactly as perps_markets lists it for that coin."
},
"side": {
"type": "string",
"enum": [
"long",
"short"
],
"description": "The position this order opens, adds to, reduces or protects. A reduce-only entry on a long position sells."
},
"size": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$",
"description": "Exact size in the coin, at most the market's `szDecimals` places."
},
"leverage": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 100
},
{
"type": "null"
}
],
"description": "Leverage the user chose for this market, at most the market's maximum. Required for an entry that is not reduce-only; null otherwise. Never assume it: ask the user."
},
"marginMode": {
"description": "How the position is margined, which the user chose with the leverage: `cross` shares the account's margin with every cross position, `isolated` puts only this position's own margin at risk (perps_margin_update adds or removes it later). Present exactly when leverage is; an isolated-only market (perps_markets `onlyIsolated`) takes `isolated`. Never assume it: ask the user. Absent on orders approved before margin modes existed, which were cross.",
"type": "string",
"enum": [
"cross",
"isolated"
]
},
"entry": {
"anyOf": [
{
"type": "object",
"properties": {
"price": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$",
"description": "The limit price; for an immediate (`Ioc`) order, the worst price it may fill at."
},
"timeInForce": {
"type": "string",
"enum": [
"Gtc",
"Ioc",
"Alo"
],
"description": "`Ioc` fills now within `price` and cancels the rest (a market order), `Gtc` rests until filled or cancelled, `Alo` rests only as a maker order."
},
"reduceOnly": {
"type": "boolean",
"description": "True to only reduce or close the existing position, never open or add."
}
},
"required": [
"price",
"timeInForce",
"reduceOnly"
]
},
{
"type": "null"
}
],
"description": "The order itself; null for take-profit and stop-loss on the existing position only."
},
"takeProfit": {
"anyOf": [
{
"$ref": "#/components/schemas/PerpsTrigger"
},
{
"type": "null"
}
],
"description": "A reduce-only take-profit, or null."
},
"stopLoss": {
"anyOf": [
{
"$ref": "#/components/schemas/PerpsTrigger"
},
{
"type": "null"
}
],
"description": "A reduce-only stop-loss, or null."
},
"trailingStop": {
"description": "A reduce-only trailing stop, placed after the order (or alone on the existing position); absent or null for none. It carries no builder fee.",
"anyOf": [
{
"$ref": "#/components/schemas/PerpsTrailingStop"
},
{
"type": "null"
}
]
}
},
"required": [
"coin",
"asset",
"side",
"size",
"leverage",
"entry",
"takeProfit",
"stopLoss"
],
"description": "One exact Hyperliquid order on the agent's own account, with optional exits."
},
"PerpsTrigger": {
"type": "object",
"properties": {
"triggerPrice": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$",
"description": "The mark price that fires this exit."
},
"limitPrice": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$",
"description": "The worst price the exit may fill at once fired; it executes as a market order within it."
}
},
"required": [
"triggerPrice",
"limitPrice"
],
"description": "A reduce-only market exit on the same size: fires at triggerPrice and fills no worse than limitPrice."
},
"PerpsTrailingStop": {
"type": "object",
"properties": {
"retracement": {
"anyOf": [
{
"type": "object",
"properties": {
"percent": {
"type": "string",
"pattern": "^(0|[1-9][0-9]?)(\\.[0-9]{0,3}[1-9])?$",
"description": "How far the mark price may reverse from its best since activation, in percent: `2` is 2%."
}
},
"required": [
"percent"
],
"description": "Trail by a percentage of the best mark price."
},
{
"type": "object",
"properties": {
"price": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$",
"description": "How far the mark price may reverse from its best since activation, in price units."
}
},
"required": [
"price"
],
"description": "Trail by a fixed price distance."
}
],
"description": "How far the mark price may reverse from its best before the stop fires."
},
"activationPrice": {
"anyOf": [
{
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,19})(\\.[0-9]{0,11}[1-9])?$"
},
{
"type": "null"
}
],
"description": "The mark price that starts the trailing; null to trail from placement."
}
},
"required": [
"retracement",
"activationPrice"
],
"description": "A reduce-only market exit on the same size that follows the mark price as it moves in the position's favour and fires once it reverses by the retracement."
},
"PerpsOrderOutcome": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"placed",
"rejected",
"uncertain",
"cancelled",
"applied",
"not_executed"
],
"description": "`placed` Hyperliquid accepted the order (see each placement), `rejected` it accepted none (or refused the margin change), `uncertain` the answer was lost and the host reconciles what is still unknown by client order id (a trailing stop with no answer only when one order matches its terms; a margin change from the account's own transaction list), `cancelled` the cancellation took effect, `applied` the margin change took effect, `not_executed` nothing was signed."
},
"placements": {
"maxItems": 4,
"type": "array",
"items": {
"$ref": "#/components/schemas/PerpsPlacementOutcome"
},
"description": "Each placement's own answer, in the order's order: entry, take-profit, stop-loss, then trailing stop."
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"description": "Why nothing was placed or the cancellation did not take effect, in Hyperliquid's or the host's words; null otherwise."
}
},
"required": [
"status",
"placements",
"reason"
],
"description": "The result of one approved perps order, cancellation or margin change."
},
"PerpsPlacementOutcome": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"entry",
"take_profit",
"stop_loss",
"trailing_stop"
],
"description": "Which part of the order: `entry`, `take_profit`, `stop_loss` or `trailing_stop`."
},
"cloid": {
"anyOf": [
{
"type": "string",
"pattern": "^0x[0-9a-f]{32}$"
},
{
"type": "null"
}
],
"description": "The client order id it is reconciled by; null for a trailing stop, which Hyperliquid gives none and the host matches by its terms instead."
},
"state": {
"type": "string",
"enum": [
"filled",
"resting",
"triggered_pending",
"triggered",
"cancelled",
"rejected",
"unknown"
],
"description": "`filled` executed (possibly partly; see `filledSize`), `resting` waits on the book, `triggered_pending` is an exit waiting for its trigger, `triggered` is an exit whose trigger fired and became a market order (its fill is in the account's fills, not here), `rejected` never placed, `unknown` not yet known: never resubmit it."
},
"oid": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "Hyperliquid's order id once it named one; null for a trigger it answered without one, or an answer not yet known."
},
"filledSize": {
"description": "How much filled, in the coin, as Hyperliquid wrote it; null when nothing filled or it did not say.",
"type": [
"string",
"null"
]
},
"averagePrice": {
"description": "The average fill price, as Hyperliquid wrote it; null when it did not say.",
"type": [
"string",
"null"
]
},
"error": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"description": "Hyperliquid's own refusal text for this placement; null otherwise."
}
},
"required": [
"role",
"cloid",
"state",
"oid",
"filledSize",
"averagePrice",
"error"
],
"description": "What one placement of an order came to on Hyperliquid."
},
"PerpsTransferInput": {
"type": "object",
"properties": {
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "Exact amount in six-decimal atomic units in either direction: 5 USDC is \"5000000\". A withdrawal returns USDC. A funding spends it from one USDC or USDT holding of the agent wallet (USDC on NEAR, Base, Arbitrum, Ethereum or Solana, or USDT on NEAR; any USDC that covers it before USDT) that alone covers it, never split across holdings, or, when it pays with a coin, that coin's value of it; Hyperliquid receives USDC. Never supply an address."
},
"maxValueLossBps": {
"type": "integer",
"minimum": 0,
"maximum": 300,
"description": "Explicit maximum value loss in basis points, including provider fees and any swap or cross-chain hop of the USDC, USDT or coin a funding spends. Required; no default."
},
"payWith": {
"description": "A funding only, approved in chat as one call: the coin it pays with instead of a USDC or USDT holding, and the most of it it may spend. A withdrawal never carries it.",
"$ref": "#/components/schemas/VenueFundingPayment"
}
},
"required": [
"amountRaw",
"maxValueLossBps"
],
"description": "An exact transfer between the agent's own wallet and its perps account, which holds USDC."
},
"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` (429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, 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` (429) — no capacity is free to run this right now; honour `Retry-After`\n- `execution_unavailable` (503) — the service that runs the agent could not take the work; `retryable` says whether to try again\n- `stop_pending` (409) — a stop is already in progress and its cleanup is not yet confirmed\n- `automation_changed` (409) — the automation changed while this request was handled; read it again and retry\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_paused` (409) — the automation is paused; resume it first\n- `automation_has_no_webhook` (409) — the automation does not run on incoming events, so it has no webhook\n- `automation_limit` (409) — the user already has as many automations as the deployment allows\n- `profile_unknown_tool` (400) — `profile.tools` names a tool this deployment does not have\n- `deployment_paused` (503) — an operator paused this kind of work for the deployment; try again later\n- `run_not_active` (409) — the run named in the path is not the conversation's live run\n- `withdrawal_changed` (409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amount\n- `swap_changed` (409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quote\n- `order_changed` (409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it again\n- `prediction_order_changed` (409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it again\n- `solana_trade_changed` (409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it again\n- `trade_not_recoverable` (409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be used\n- `order_not_cancelable` (409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it stands\n- `grid_not_active` (409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it stands\n- `grid_not_paused` (409) — the grid is not paused, so there is nothing to resume. Read the grid for where it stands\n- `suggestion_changed` (409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions again\n- `request_key_conflict` (409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new request\n- `question_not_pending` (409) — the questionnaire has already been answered, closed, or is not awaiting this submission\n- `flag_changed` (409) — the flag's targeting changed since you read it; read it again and retry\n- `group_changed` (409) — the group changed or was deleted since you read it; read it again and retry\n- `group_in_use` (409) — a flag's rules still name this group; take it out of those rules first\n- `group_name_taken` (409) — another group already has this name\n- `agent_wallet_required` (409) — create the agent wallet before opening a perps, prediction-market or Solana account\n- `wallet_account_unsupported` (409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session instead\n- `conversation_deleted` (410) — the conversation was deleted; its history stays readable\n- `automation_deleted` (410) — the automation was deleted\n- `grid_ended` (410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chat\n- `credential_expired` (401) — the user token has expired; obtain a fresh one\n- `account_disabled` (403) — an operator disabled the account\n- `perps_disabled` (403) — perps is not enabled for this user\n- `prediction_disabled` (403) — prediction-market trading is not enabled for this user\n- `solana_disabled` (403) — Solana trading is not enabled for this user\n- `no_account` (404) — the user has not opened the account this call reads; open it first\n- `not_available_in_region` (403) — perps funding is unavailable in the user's region for this request; withdrawals remain available\n- `steering_disabled` (403) — steering a working run is not turned on for this user; send the message with Start a run once the run ends\n- `baskets_disabled` (403) — idea baskets are not turned on for this user; hide the Ideas pages and their baskets\n- `basket_buying` (409) — the basket is still buying, so it cannot be deleted yet; try again once its result is in\n- `basket_awaiting_approval` (409) — an approval to buy this basket is still open; decline it in the chat, then delete the basket\n- `basket_step_not_failed` (409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket again\n- `basket_step_linked` (409) — another order is already linked to this step; a link is permanent, so read the basket again\n- `basket_order_not_linkable` (400) — the order cannot stand in for this step: it is not one of the step's `failures[].linkable` orders, or another basket step already holds it\n- `voice_disabled` (403) — voice input is not turned on for this user; let them type instead\n- `voice_unavailable` (503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type instead\n- `provider_unavailable` (503) — an external provider the call depends on did not answer\n- `quote_refused` (400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another network\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 verified credential is not permitted to make this call\n- `signature_required` (403) — creating the agent wallet needs the user's signature: send the user's signature of `creation.message` from Get the agent wallet as `authorization`\n- `asset_not_withdrawable` (403) — tokenized stocks cannot be withdrawn; sell them first\n- `asset_not_swappable` (403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with no `context.country`, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user's `earn` flag is off\n- `asset_not_tradable` (403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with no `context.country`, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user's `earn` flag is off\n- `solana_token_not_tradable` (403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landing\n- `limit_orders_disabled` (403) — limit orders are not enabled for this user\n- `grid_trading_disabled` (403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gated\n- `deposit_limit_exceeded` (429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. Read `depositLimit.availableCents` from Get balances for how much fits now, and deposit no more than that\n- `policy_change_throttled` (429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again once `Retry-After` has passed\n- `agent_slippage_exceeded` (403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (`max_slippage_bps`): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss bound\n- `agent_api_orders_unavailable` (403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signed\n- `destination_not_allowed` (403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signed\n- `rate_limited` (429) — the per-key or per-user limit is spent; honour `Retry-After`\n- `partner_request_capacity` (429) — this partner's request quota across all keys and replicas is spent; honour Retry-After\n- `partner_run_capacity` (429) — this partner's active run quota is full; honour Retry-After and reuse the same request identity\n- `stream_capacity` (429) — the partner, user or replica has no free stream capacity; honour `Retry-After`\n- `invalid_cursor` (400) — the `cursor` is not one this list minted\n- `invalid_question_answer` (400) — the questionnaire answer does not match its questions or allowed choices\n- `question_closed` (410) — the questionnaire expired or was cancelled\n- `unknown_target` (400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule names\n- `scope_invalid` (400) — a subject in the scope is not a subject id, or appears twice\n- `subject_unsupported` (404) — a subject in the scope is not one market briefs cover; list them with List market subjects\n- `brief_not_found` (404) — no market brief job with this id was created with your partner key\n- `briefs_busy` (429) — your market briefs are at their limit of briefs generating at once; retry after `Retry-After`\n- `market_briefs_disabled` (403) — market briefs are not turned on for your partner key\n- `story_not_found` (404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read",
"type": "string",
"enum": [
"run_active",
"budget_exhausted",
"approval_not_pending",
"execution_capacity",
"execution_unavailable",
"stop_pending",
"automation_changed",
"automation_held",
"automation_invalid",
"automation_paused",
"automation_has_no_webhook",
"automation_limit",
"profile_unknown_tool",
"deployment_paused",
"run_not_active",
"withdrawal_changed",
"swap_changed",
"order_changed",
"prediction_order_changed",
"solana_trade_changed",
"trade_not_recoverable",
"order_not_cancelable",
"grid_not_active",
"grid_not_paused",
"suggestion_changed",
"request_key_conflict",
"question_not_pending",
"flag_changed",
"group_changed",
"group_in_use",
"group_name_taken",
"agent_wallet_required",
"wallet_account_unsupported",
"conversation_deleted",
"automation_deleted",
"grid_ended",
"credential_expired",
"account_disabled",
"perps_disabled",
"prediction_disabled",
"solana_disabled",
"no_account",
"not_available_in_region",
"steering_disabled",
"baskets_disabled",
"basket_buying",
"basket_awaiting_approval",
"basket_step_not_failed",
"basket_step_linked",
"basket_order_not_linkable",
"voice_disabled",
"voice_unavailable",
"provider_unavailable",
"quote_refused",
"invalid_input",
"internal",
"partner_key_required",
"partner_key_invalid",
"subject_mismatch",
"origin_rejected",
"permission_required",
"signature_required",
"asset_not_withdrawable",
"asset_not_swappable",
"asset_not_tradable",
"solana_token_not_tradable",
"limit_orders_disabled",
"grid_trading_disabled",
"deposit_limit_exceeded",
"policy_change_throttled",
"agent_slippage_exceeded",
"agent_api_orders_unavailable",
"destination_not_allowed",
"rate_limited",
"partner_request_capacity",
"partner_run_capacity",
"stream_capacity",
"invalid_cursor",
"invalid_question_answer",
"question_closed",
"unknown_target",
"scope_invalid",
"subject_unsupported",
"brief_not_found",
"briefs_busy",
"market_briefs_disabled",
"story_not_found"
]
},
"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."
}
},
"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\n- `permission_required` — the verified credential is not permitted to make this call",
"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"
}
}
}
},
"TooManyRequests": {
"description": "A limit refused the request; wait for `Retry-After` when it is sent.\n\n- `rate_limited` — the per-key or per-user limit is spent; honour `Retry-After`\n- `partner_request_capacity` — this partner's request quota across all keys and replicas 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"
}
}
}
},
"Unavailable": {
"description": "The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); `retryable` says whether to try again.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "header",
"name": "X-Api-Key"
},
"userToken": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "fin_session_<opaque>",
"description": "A user's session token, from Create a session."
}
}
}
}