Resume an automation
Starts a paused automation again, under the trading permission it already has. Refused once that permission has been revoked; the user then sets the automation up again. For one fin paused for its owner, pass countMissedRun=true when the owner lets the missed run go, so it counts toward the run limit.
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
countMissedRunstringoptionalWhether the owner let the run fin paused over go, so it counts toward the run limit. Leave it out to keep watching: the run goes back to the limit, and the automation carries on. It runs nothing it missed.
Request example
Illustrative request. Replace the host, credentials and resource IDs with your own. If a request file is shown, create it from the schema above. Review the requested action before sending it.
curl --request POST 'https://api.example.test/v1/users/YOUR_USER_ID/automations/YOUR_AUTOMATION_ID/resume' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Authorization: Bearer YOUR_USER_TOKEN'
Responses
200 The automation, updated.
The automation, updated.
application/json · object
One automation: its rule and a readable summary of it, its current sources, its monitoring health, and its runs.
idstring · 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)$"
definitionVersionintegeroptionalThe saved revision number. Use it to ignore older cached reads after chat edits. This server always returns it; earlier servers may omit it.
Validation rules
- Greater than
0- Maximum
9007199254740991
namestringrequiredThe automation's name.
promptstringrequiredThe instructions given to the model each time this automation fires.
ruleobjectrequiredOne automation's rule: when it wakes, what condition it evaluates, and how it fires.
Show attributes
One automation's rule: when it wakes, what condition it evaluates, and how it fires.
schemaVersionnumberrequiredThe rule schema's version; always 1.
Validation rules
- Exact value
1
deliveryoneOfrequiredWhat happens when a new occurrence is ready before the previous one has finished.
Show attributes
What happens when a new occurrence is ready before the previous one has finished.
Validation rules
- Default
{"overlap":"queue","maxPendingOccurrences":100}
oneOf · 3 variants
Variant 1 · object
overlapstringrequiredQueue a new occurrence and run it once the active one finishes.
Validation rules
- Exact value
"queue"
maxPendingOccurrencesintegerrequiredHow many occurrences may wait in the queue, not counting the one currently active, including one whose run is itself waiting on an approval.
Validation rules
- Minimum
1- Maximum
100
Variant 2 · object
overlapstringrequiredClose the occurrence already pending as coalesced and record the new match as a fresh occurrence, rather than queuing a second.
Validation rules
- Exact value
"coalesce"
Variant 3 · object
overlapstringrequiredDrop a new match while an occurrence is already active.
Validation rules
- Exact value
"skip"
maxDeliveryLatenessSecondsintegerrequiredHow long a new occurrence may wait to be delivered before its deadline passes and it is refused, in seconds.
Validation rules
- Default
86400- Minimum
1- Maximum
86400
maxEvaluationGapSecondsintegerrequiredThe longest gap allowed between evaluations before firing.mode: rising_edge treats its history as broken and waits for a fresh baseline, in seconds.
Validation rules
- Default
600- Minimum
1- Maximum
2678400
wakesarrayrequiredOccasions to evaluate the rule's condition: alternatives, not an AND of conditions. At most one clock and one event stream.
Show attributes
Occasions to evaluate the rule's condition: alternatives, not an AND of conditions. At most one clock and one event stream.
Validation rules
- Minimum items
1- Maximum items
7
Array items · oneOf
oneOf · 5 variants
Variant 1 · kind: at
kindstringrequiredA one-time wake at an exact moment; exhausted after that check, even if its condition is false.
Validation rules
- Exact value
"at"
runAtstring · date-timerequiredThe exact moment this wake fires, as an ISO 8601 timestamp with an offset.
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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
misfireoneOfrequiredWhat happens when the engine could not evaluate this wake on time.
Show attributes
What happens when the engine could not evaluate this wake on time.
Validation rules
- Default
{"mode":"latest","maxLatenessSeconds":null}
oneOf · 3 variants
Variant 1 · object
modestringrequiredDrop a wake the engine could not evaluate in time; wait for the next one.
Validation rules
- Exact value
"skip"
graceSecondsintegerrequiredHow late this wake may still run before it counts as missed, in seconds.
Validation rules
- Default
5- Minimum
1- Maximum
60
Variant 2 · object
modestringrequiredRun once for the most recently missed wake, dropping any earlier ones.
Validation rules
- Exact value
"latest"
maxLatenessSecondsanyOfrequiredHow late a missed wake may still run, in seconds; null for no limit.
Show attributes
How late a missed wake may still run, in seconds; null for no limit.
Validation rules
- Default
null
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
1- Maximum
2678400
Variant 2 · null
Variant 3 · object
modestringrequiredRun once for every missed wake, oldest first.
Validation rules
- Exact value
"all"
maxLatenessSecondsanyOfrequiredHow late a missed wake may still run, in seconds; null for no limit.
Show attributes
How late a missed wake may still run, in seconds; null for no limit.
Validation rules
- Default
null
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
1- Maximum
2678400
Variant 2 · null
evaluationTimestringrequiredWhich moment this wake is evaluated as of: scheduled_time the time it was due, detection_time when the engine actually ran it.
Validation rules
- Default
"detection_time"- Allowed values
["scheduled_time","detection_time"]
Variant 2 · kind: interval
kindstringrequiredA wake that repeats on a fixed elapsed interval.
Validation rules
- Exact value
"interval"
intervalMinutesintegerrequiredHow often this wake repeats, in minutes.
Validation rules
- Minimum
1- Maximum
44640
misfireoneOfrequiredWhat happens when the engine could not evaluate this wake on time.
Show attributes
What happens when the engine could not evaluate this wake on time.
Validation rules
- Default
{"mode":"latest","maxLatenessSeconds":null}
oneOf · 3 variants
Variant 1 · object
modestringrequiredDrop a wake the engine could not evaluate in time; wait for the next one.
Validation rules
- Exact value
"skip"
graceSecondsintegerrequiredHow late this wake may still run before it counts as missed, in seconds.
Validation rules
- Default
5- Minimum
1- Maximum
60
Variant 2 · object
modestringrequiredRun once for the most recently missed wake, dropping any earlier ones.
Validation rules
- Exact value
"latest"
maxLatenessSecondsanyOfrequiredHow late a missed wake may still run, in seconds; null for no limit.
Show attributes
How late a missed wake may still run, in seconds; null for no limit.
Validation rules
- Default
null
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
1- Maximum
2678400
Variant 2 · null
Variant 3 · object
modestringrequiredRun once for every missed wake, oldest first.
Validation rules
- Exact value
"all"
maxLatenessSecondsanyOfrequiredHow late a missed wake may still run, in seconds; null for no limit.
Show attributes
How late a missed wake may still run, in seconds; null for no limit.
Validation rules
- Default
null
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
1- Maximum
2678400
Variant 2 · null
evaluationTimestringrequiredWhich moment this wake is evaluated as of: scheduled_time the time it was due, detection_time when the engine actually ran it.
Validation rules
- Default
"detection_time"- Allowed values
["scheduled_time","detection_time"]
Variant 3 · kind: calendar
kindstringrequiredA wake on a recurring calendar schedule: local times, weekdays, months and days of the month.
Validation rules
- Exact value
"calendar"
timeZonestringrequiredThe IANA time zone a calendar wake's local times are interpreted in.
Validation rules
- Minimum length
1- Maximum length
80
localTimesarrayrequiredThe times of day this wake fires, each in 24-hour HH:MM form, in timeZone.
Show attributes
The times of day this wake fires, each in 24-hour HH:MM form, in timeZone.
Validation rules
- Minimum items
1- Maximum items
24
Array items · string
Validation rules
- Pattern
"^([01]\\d|2[0-3]):[0-5]\\d$"
weekdaysarrayrequiredWhich ISO weekdays this wake fires on, 1 (Monday) through 7 (Sunday). Defaults to every day.
Show attributes
Which ISO weekdays this wake fires on, 1 (Monday) through 7 (Sunday). Defaults to every day.
Validation rules
- Default
[1,2,3,4,5,6,7]- Minimum items
1- Maximum items
7
Array items · integer
Validation rules
- Minimum
1- Maximum
7
monthsarrayrequiredWhich months this wake fires in, 1 (January) through 12 (December). Defaults to every month.
Show attributes
Which months this wake fires in, 1 (January) through 12 (December). Defaults to every month.
Validation rules
- Default
[1,2,3,4,5,6,7,8,9,10,11,12]- Minimum items
1- Maximum items
12
Array items · integer
Validation rules
- Minimum
1- Maximum
12
monthDaysarrayrequiredWhich days of the month this wake fires on, 1 through 31. Defaults to every day.
Show attributes
Which days of the month this wake fires on, 1 through 31. Defaults to every day.
Validation rules
- Default
[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31]- Minimum items
1- Maximum items
31
Array items · integer
Validation rules
- Minimum
1- Maximum
31
misfireoneOfrequiredWhat happens when the engine could not evaluate this wake on time.
Show attributes
What happens when the engine could not evaluate this wake on time.
Validation rules
- Default
{"mode":"latest","maxLatenessSeconds":null}
oneOf · 3 variants
Variant 1 · object
modestringrequiredDrop a wake the engine could not evaluate in time; wait for the next one.
Validation rules
- Exact value
"skip"
graceSecondsintegerrequiredHow late this wake may still run before it counts as missed, in seconds.
Validation rules
- Default
5- Minimum
1- Maximum
60
Variant 2 · object
modestringrequiredRun once for the most recently missed wake, dropping any earlier ones.
Validation rules
- Exact value
"latest"
maxLatenessSecondsanyOfrequiredHow late a missed wake may still run, in seconds; null for no limit.
Show attributes
How late a missed wake may still run, in seconds; null for no limit.
Validation rules
- Default
null
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
1- Maximum
2678400
Variant 2 · null
Variant 3 · object
modestringrequiredRun once for every missed wake, oldest first.
Validation rules
- Exact value
"all"
maxLatenessSecondsanyOfrequiredHow late a missed wake may still run, in seconds; null for no limit.
Show attributes
How late a missed wake may still run, in seconds; null for no limit.
Validation rules
- Default
null
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
1- Maximum
2678400
Variant 2 · null
evaluationTimestringrequiredWhich moment this wake is evaluated as of: scheduled_time the time it was due, detection_time when the engine actually ran it.
Validation rules
- Default
"detection_time"- Allowed values
["scheduled_time","detection_time"]
Variant 4 · kind: event
kindstringrequiredA wake evaluated each time a matching custom webhook event arrives.
Validation rules
- Exact value
"event"
eventTypestringrequiredThe event type this wake matches; a live webhook delivery of a different type is ignored before it reaches the condition.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_.:-]{0,79}$"
fieldsarrayrequiredThe data fields an event of this type is declared to carry.
Show attributes
The data fields an event of this type is declared to carry.
Validation rules
- Maximum items
32
Array items · object
One data field an event or a source's observation carries: where it lives, and its type.
patharrayrequiredThe keys to walk, in order, from an observation's top level down to this field.
Show attributes
The keys to walk, in order, from an observation's top level down to this field.
Validation rules
- Minimum items
1- Maximum items
8
Array items · string
Validation rules
- Pattern
"^[A-Za-z_][A-Za-z0-9_-]{0,63}$"
valueTypeoneOfrequiredWhat type this field's value has, and the unit it carries when it has one.
Show attributes
What type this field's value has, and the unit it carries when it has one.
oneOf · 4 variants
Variant 1 · type: boolean
typestringrequiredA true/false value.
Validation rules
- Exact value
"boolean"
Variant 2 · type: string
typestringrequiredA text value.
Validation rules
- Exact value
"string"
Variant 3 · type: integer
typestringrequiredA whole-number value, compared exactly.
Validation rules
- Exact value
"integer"
unitstringrequiredThe unit an integer or decimal value is measured in, as the source or literal declares it.
Validation rules
- Minimum length
1- Maximum length
64
Variant 4 · type: decimal
typestringrequiredAn exact decimal value, as text, compared exactly.
Validation rules
- Exact value
"decimal"
unitstringrequiredThe unit an integer or decimal value is measured in, as the source or literal declares it.
Validation rules
- Minimum length
1- Maximum length
64
optionalbooleanoptionalWhether the provider may genuinely not observe this field, rather than fail to read it. When true, a missing value resolves a condition over it to missing_field and the rule's verdict to unknown, rather than zero, null or false.
Variant 5 · kind: reader_update
kindstringrequiredA wake evaluated each time the named reader delivers a fresh observation.
Validation rules
- Exact value
"reader_update"
bindingstringrequiredThe binding name a rule or a plan gives one configured source.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_-]{0,31}$"
readersarrayrequiredThe named source bindings this rule reads from, referenced by condition and by each reader_update wake's binding.
Show attributes
The named source bindings this rule reads from, referenced by condition and by each reader_update wake's binding.
Validation rules
- Maximum items
4
Array items · object
namestringrequiredThe binding name a rule or a plan gives one configured source.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_-]{0,31}$"
readerIdstringrequiredThe installed source operation's id, as listed by List automation data sources.
Validation rules
- Pattern
"^[a-z][a-z0-9_.-]{0,79}$"
configobjectrequiredArbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 entries.
Show attributes
Arbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 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.
deliverystringoptionalUse reviewed push updates; omit for periodic snapshots.
Validation rules
- Exact value
"push"
pollIntervalSecondsintegerrequiredPolling cadence, or subscription lease/reconciliation cadence for push delivery, in seconds.
Validation rules
- Minimum
1- Maximum
2147483
maxAgeSecondsintegerrequiredMaximum retained input age at evaluation, matching requirement.maxAgeSeconds when present. Snapshots use observation time; events use trusted receipt time. Collection separately enforces the provider's acquisition-age guarantee.
Validation rules
- Minimum
1- Maximum
86400
requirementobjectoptionalWhat a reader needs from its source: how fresh an answer must be, and whether a slower one is still acceptable.
Show attributes
What a reader needs from its source: how fresh an answer must be, and whether a slower one is still acceptable.
maxLatencySecondsanyOfrequiredThe target delay between an observation and its delivery, in seconds; null when delivery has no target deadline.
Show attributes
The target delay between an observation and its delivery, in seconds; null when delivery has no target deadline.
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
1- Maximum
2147483
Variant 2 · null
maxAgeSecondsintegerrequiredMaximum acceptable input age at evaluation, matching the reader's maxAgeSeconds, measured from the provider's own observation time. The selected provider's acquisition guarantee must fit within this limit and does not reduce this evaluation window.
Validation rules
- Minimum
1- Maximum
86400
allowDegradedLatencybooleanrequiredWhether delivery slower than the target delay is still accepted.
maxAcceptedLatencySecondsintegeroptionalThe slowest delivery still accepted, in seconds, when allowDegradedLatency is set.
Validation rules
- Minimum
1- Maximum
2147483
conditionanyrequiredThe rule's condition tree, up to 8 levels deep and 128 nodes total, built from five node kinds: {op:"bool", value} a fixed true/false leaf; {op:"compare", comparator, left, right} one of eq/ne/lt/lte/gt/gte between two operands — lt/lte/gt/gte require both operands to be integer or decimal, and both sides must share the same type and, for integer/decimal, the same unit; {op:"all", args} / {op:"any", args} AND/OR over one or more child nodes; {op:"not", arg} negates one child node. An operand is either {kind:"field", binding, path} — a bound reader's name and the key path into its data — or {kind:"literal", type, value, unit?} with type one of boolean/string/integer/decimal (integer/decimal values are exact decimal strings and carry unit).
exitobjectoptionalThe exit watch, when this rule's automation has exit actions on its contract. Present exactly when the contract has an exit action.
Show attributes
The exit watch, when this rule's automation has exit actions on its contract. Present exactly when the contract has an exit action.
intervalSecondsintegerrequiredHow often this automation re-checks its exit guards, in seconds; at least 60 and at most 2678400 (31 days), the same span an interval wake may cover. Recommend 300.
Validation rules
- Minimum
60- Maximum
2678400
readersobjectrequiredThe two price bindings each exit guard is measured against; both must be the reviewed USD token-price operation.
Show attributes
The two price bindings each exit guard is measured against; both must be the reviewed USD token-price operation.
assetstringrequiredThe binding in readers that prices the asset this automation bought, in USD.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_-]{0,31}$"
quotestringrequiredThe binding in readers that prices the token this automation pays with, in USD.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_-]{0,31}$"
pushobjectoptionalAdditional push-delivered USD prices that may check exits between periodic 1Click checks.
Show attributes
Additional push-delivered USD prices that may check exits between periodic 1Click checks.
readersobjectrequiredThe supplementary price bindings for the bought asset and its paying token.
Show attributes
The supplementary price bindings for the bought asset and its paying token.
assetstringrequiredThe binding name a rule or a plan gives one configured source.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_-]{0,31}$"
quotestringrequiredThe binding name a rule or a plan gives one configured source.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_-]{0,31}$"
firingobjectrequiredHow this rule turns a qualifying evaluation into a firing: which ones count, how often, and how many.
Show attributes
How this rule turns a qualifying evaluation into a firing: which ones count, how often, and how many.
modestringrequiredWhen a qualifying evaluation fires: each_match fires on every qualifying evaluation, including the first; rising_edge fires only on a known false-to-true transition.
Validation rules
- Allowed values
["each_match","rising_edge"]
repeatstringrequiredWhether this rule fires at most once, or keeps watching after it fires.
Validation rules
- Allowed values
["once","repeating"]
maxRunsintegeroptionalMaximum deliverable runs recorded for this automation across pauses and resumes. Missed or refused deliveries do not count; recorded runs count even if later canceled, coalesced or failed. Omit for no finite limit beyond repeat=once.
Validation rules
- Minimum
1- Maximum
1000000
initialstringrequiredHow rising_edge treats the first known state: baseline records it without firing, fire_if_true fires immediately if it is already true.
Validation rules
- Allowed values
["baseline","fire_if_true"]
cooldownSecondsintegerrequiredThe minimum time between firings, in seconds; it does not require the condition to stay true that whole time. For rising_edge, a false-to-true edge that lands inside cooldown is discarded, not queued: it is not replayed once cooldown ends, so the rule needs an entirely fresh edge after cooldown lapses before it fires again — simply remaining true past the cooldown boundary does not trigger a firing.
Validation rules
- Minimum
0- Maximum
2678400
newsobjectoptionalPresent only on a news exit: the owner's own words, which Fin's news judge reads new stories against. Its rule is fixed: one news.judged event wake, no readers, the judged condition and one firing, over a reduce-only perps contract.
Show attributes
Present only on a news exit: the owner's own words, which Fin's news judge reads new stories against. Its rule is fixed: one news.judged event wake, no readers, the judged condition and one firing, over a reduce-only perps contract.
conditionstringrequiredThe owner's condition in their own words, exactly as they said it, such as right before Anthropic's IPO. Never paraphrased: the judge reads the news against these words.
Validation rules
- Minimum length
3- Maximum length
500
matchstringrequiredA few words every story the judge reads must contain in its headline or summary, such as Anthropic IPO: a broad filter, not the condition. The judge decides from the condition.
Validation rules
- Minimum length
2- Maximum length
80- Pattern
"^[\\p{L}\\p{N} .'&-]+$"
maxSnapshotSkewSecondsintegerrequiredThe most that bound readers' observation times may disagree before evaluation reports snapshot_skew, in seconds.
Validation rules
- Minimum
0- Maximum
86400
missedRunstringrequiredWhat happens to a run that can't go through before its deadline: skip counts it and keeps the schedule, ask pauses the automation until its owner decides. A failure only the owner can fix pauses either way.
Validation rules
- Allowed values
["skip","ask"]
summarystringrequiredWhen the automation runs, in one readable sentence or two: its condition, then its schedule and run limit. Times are in UTC unless the schedule names its own time zone.
sourcePlansarrayrequiredHow each of the rule's bindings will actually be collected.
Show attributes
How each of the rule's bindings will actually be collected.
Validation rules
- Maximum items
4
Array items · object
bindingstringrequiredThe binding name a rule or a plan gives one configured source.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_-]{0,31}$"
resultoneOfrequiredWhether this binding is ready, needs a connection, or is unsupported, and why.
Show attributes
Whether this binding is ready, needs a connection, or is unsupported, and why.
oneOf · 3 variants
Variant 1 · status: ready
statusstringrequiredThe binding is fully planned and ready to collect.
Validation rules
- Exact value
"ready"
planobjectrequiredHow one binding will actually be collected: the operation, its guarantees and its configuration.
Show attributes
How one binding will actually be collected: the operation, its guarantees and its configuration.
operationIdstringrequiredThe collection operation this plan uses.
Validation rules
- Pattern
"^[a-z][a-z0-9_.-]{0,79}$"
operationVersionintegerrequiredThe collection operation's version.
Validation rules
- Greater than
0- Maximum
9007199254740991
descriptorFingerprintstringrequiredA content hash of the source descriptor this plan was built from.
Validation rules
- Pattern
"^[a-f0-9]{64}$"
configobjectrequiredArbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 entries.
Show attributes
Arbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 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.
requirementobjectrequiredWhat a reader needs from its source: how fresh an answer must be, and whether a slower one is still acceptable.
Show attributes
What a reader needs from its source: how fresh an answer must be, and whether a slower one is still acceptable.
maxLatencySecondsanyOfrequiredThe target delay between an observation and its delivery, in seconds; null when delivery has no target deadline.
Show attributes
The target delay between an observation and its delivery, in seconds; null when delivery has no target deadline.
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
1- Maximum
2147483
Variant 2 · null
maxAgeSecondsintegerrequiredMaximum acceptable input age at evaluation, matching the reader's maxAgeSeconds, measured from the provider's own observation time. The selected provider's acquisition guarantee must fit within this limit and does not reduce this evaluation window.
Validation rules
- Minimum
1- Maximum
86400
allowDegradedLatencybooleanrequiredWhether delivery slower than the target delay is still accepted.
maxAcceptedLatencySecondsintegeroptionalThe slowest delivery still accepted, in seconds, when allowDegradedLatency is set.
Validation rules
- Minimum
1- Maximum
2147483
guaranteesobjectrequiredWhat an operation promises about the snapshots it serves: cadence, freshness and how many subjects it can batch. Describes sampled state; nothing here promises that a change between two polls was seen.
Show attributes
What an operation promises about the snapshots it serves: cadence, freshness and how many subjects it can batch. Describes sampled state; nothing here promises that a change between two polls was seen.
deliverystringoptionalPush delivery; absent means polling.
Validation rules
- Exact value
"push"
minCadenceSecondsintegerrequiredThe shortest interval between requests the provider permits, in seconds.
Validation rules
- Minimum
0- Maximum
2147483
expectedLatencySecondsanyOfrequiredHow stale the provider's own value may be when it answers, in seconds; null when the provider establishes no bound. A reader with a delivery deadline cannot use a source that promises nothing here.
Show attributes
How stale the provider's own value may be when it answers, in seconds; null when the provider establishes no bound. A reader with a delivery deadline cannot use a source that promises nothing here.
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
0- Maximum
2147483
Variant 2 · null
maxAgeSecondsintegerrequiredMaximum snapshot observation age accepted at collection. This acquisition guarantee does not shorten a reader's separately declared evaluation-age window.
Validation rules
- Minimum
0- Maximum
2147483
requestsPerMinuteanyOfrequiredThe provider's own rate limit for this source, when it publishes one.
Show attributes
The provider's own rate limit for this source, when it publishes one.
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Greater than
0- Maximum
9007199254740991
Variant 2 · null
observationReuseSecondsintegeroptionalHow long one provider observation may serve every reader watching the same subject under the same connection, in seconds. Absent or 0 means each reader causes its own request. A reused observation keeps the provider's own sourceTime, so declared freshness still governs; what reuse changes is how often the provider is asked, not how old an accepted observation may be. Keep it at or below the cadence readers are expected to poll at.
Validation rules
- Minimum
0- Maximum
2147483
batchLimitintegeroptionalHow many distinct subjects the provider can serve in one request. Absent or 1 means no batching. Only providers implementing readBatch may declare more: the framework cannot infer that an API accepts several subjects.
Validation rules
- Greater than
0- Maximum
1000
scopeKindstringrequiredWho this binding is scoped to: public data anyone can read, user data read under the owner's own connection.
Validation rules
- Allowed values
["public","user"]
explanationstringrequiredWhy this plan was chosen, in the reviewer's own words.
Validation rules
- Maximum length
2048
recipeobjectoptionalA 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}$"
degradedbooleanrequiredWhether this plan settled for weaker guarantees than the rule asked for.
Variant 2 · status: needs_connection
statusstringrequiredThe binding is plannable but needs a connection the owner has not granted yet.
Validation rules
- Exact value
"needs_connection"
candidatePlanobjectrequiredThe plan that would apply once the missing connection is granted.
Show attributes
The plan that would apply once the missing connection is granted.
operationIdstringrequiredThe collection operation this plan uses.
Validation rules
- Pattern
"^[a-z][a-z0-9_.-]{0,79}$"
operationVersionintegerrequiredThe collection operation's version.
Validation rules
- Greater than
0- Maximum
9007199254740991
descriptorFingerprintstringrequiredA content hash of the source descriptor this plan was built from.
Validation rules
- Pattern
"^[a-f0-9]{64}$"
configobjectrequiredArbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 entries.
Show attributes
Arbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 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.
requirementobjectrequiredWhat a reader needs from its source: how fresh an answer must be, and whether a slower one is still acceptable.
Show attributes
What a reader needs from its source: how fresh an answer must be, and whether a slower one is still acceptable.
maxLatencySecondsanyOfrequiredThe target delay between an observation and its delivery, in seconds; null when delivery has no target deadline.
Show attributes
The target delay between an observation and its delivery, in seconds; null when delivery has no target deadline.
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
1- Maximum
2147483
Variant 2 · null
maxAgeSecondsintegerrequiredMaximum acceptable input age at evaluation, matching the reader's maxAgeSeconds, measured from the provider's own observation time. The selected provider's acquisition guarantee must fit within this limit and does not reduce this evaluation window.
Validation rules
- Minimum
1- Maximum
86400
allowDegradedLatencybooleanrequiredWhether delivery slower than the target delay is still accepted.
maxAcceptedLatencySecondsintegeroptionalThe slowest delivery still accepted, in seconds, when allowDegradedLatency is set.
Validation rules
- Minimum
1- Maximum
2147483
guaranteesobjectrequiredWhat an operation promises about the snapshots it serves: cadence, freshness and how many subjects it can batch. Describes sampled state; nothing here promises that a change between two polls was seen.
Show attributes
What an operation promises about the snapshots it serves: cadence, freshness and how many subjects it can batch. Describes sampled state; nothing here promises that a change between two polls was seen.
deliverystringoptionalPush delivery; absent means polling.
Validation rules
- Exact value
"push"
minCadenceSecondsintegerrequiredThe shortest interval between requests the provider permits, in seconds.
Validation rules
- Minimum
0- Maximum
2147483
expectedLatencySecondsanyOfrequiredHow stale the provider's own value may be when it answers, in seconds; null when the provider establishes no bound. A reader with a delivery deadline cannot use a source that promises nothing here.
Show attributes
How stale the provider's own value may be when it answers, in seconds; null when the provider establishes no bound. A reader with a delivery deadline cannot use a source that promises nothing here.
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Minimum
0- Maximum
2147483
Variant 2 · null
maxAgeSecondsintegerrequiredMaximum snapshot observation age accepted at collection. This acquisition guarantee does not shorten a reader's separately declared evaluation-age window.
Validation rules
- Minimum
0- Maximum
2147483
requestsPerMinuteanyOfrequiredThe provider's own rate limit for this source, when it publishes one.
Show attributes
The provider's own rate limit for this source, when it publishes one.
anyOf · 2 variants
Variant 1 · integer
Validation rules
- Greater than
0- Maximum
9007199254740991
Variant 2 · null
observationReuseSecondsintegeroptionalHow long one provider observation may serve every reader watching the same subject under the same connection, in seconds. Absent or 0 means each reader causes its own request. A reused observation keeps the provider's own sourceTime, so declared freshness still governs; what reuse changes is how often the provider is asked, not how old an accepted observation may be. Keep it at or below the cadence readers are expected to poll at.
Validation rules
- Minimum
0- Maximum
2147483
batchLimitintegeroptionalHow many distinct subjects the provider can serve in one request. Absent or 1 means no batching. Only providers implementing readBatch may declare more: the framework cannot infer that an API accepts several subjects.
Validation rules
- Greater than
0- Maximum
1000
scopeKindstringrequiredWho this binding is scoped to: public data anyone can read, user data read under the owner's own connection.
Validation rules
- Allowed values
["public","user"]
explanationstringrequiredWhy this plan was chosen, in the reviewer's own words.
Validation rules
- Maximum length
2048
recipeobjectoptionalA 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}$"
degradedbooleanrequiredWhether this plan settled for weaker guarantees than the rule asked for.
reasonsarrayrequiredWhy this binding could not be planned as asked.
Show attributes
Why this binding could not be planned as asked.
Validation rules
- Minimum items
1- Maximum items
32
Array items · object
codestringrequiredA machine-readable reason code.
Validation rules
- Minimum length
1- Maximum length
80
pathstringoptionalThe field this reason is about, when it is about one.
Validation rules
- Maximum length
256
messagestringrequiredThe reason, in the reviewer's own words.
Validation rules
- Maximum length
2048
Variant 3 · status: unsupported
statusstringrequiredThe binding cannot be planned at all, as asked.
Validation rules
- Exact value
"unsupported"
reasonsarrayrequiredWhy this binding could not be planned as asked.
Show attributes
Why this binding could not be planned as asked.
Validation rules
- Minimum items
1- Maximum items
32
Array items · object
codestringrequiredA machine-readable reason code.
Validation rules
- Minimum length
1- Maximum length
80
pathstringoptionalThe field this reason is about, when it is about one.
Validation rules
- Maximum length
256
messagestringrequiredThe reason, in the reviewer's own words.
Validation rules
- Maximum length
2048
enabledbooleanrequiredWhether this automation is active: false while it is paused and once deleted.
createdAtstring · date-timerequiredWhen this automation was created.
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))$"
updatedAtstring · date-timerequiredWhen this automation was last changed.
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))$"
deletedAtanyOfrequiredWhen the automation was deleted; null while it exists.
Show attributes
When the automation was deleted; null while it exists.
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
holdanyOfrequiredAn operator's hold: why future work is stopped, so the owner does not read it as their own doing.
Show attributes
An operator's hold: why future work is stopped, so the owner does not read it as their own doing.
anyOf · 2 variants
Variant 1 · object
atstring · date-timerequiredWhen the hold 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))$"
reasonstring or nullrequiredWhy an operator placed the hold, when they gave one.
Variant 2 · null
waitingForOwneranyOfrequiredWhen fin paused this automation because only the owner can move it on: what it needs, and the run it stopped at when a run caused it. Null otherwise, including while the owner paused it themselves. Resuming clears it.
Show attributes
When fin paused this automation because only the owner can move it on: what it needs, and the run it stopped at when a run caused it. Null otherwise, including while the owner paused it themselves. Resuming clears it.
anyOf · 2 variants
Variant 1 · object
actionstringrequiredWhat it needs: add_funds, edit_automation, decide whether to act now or keep it as it is, or resume: it can no longer read the data it watches until the owner resumes it, which reads that data afresh.
Validation rules
- Allowed values
["add_funds","edit_automation","decide","resume"]
reasonstringrequiredWhy it stopped, one of the reasons a run gives: see reason on the automation run. A resume gives unavailable.
runIdanyOfrequiredThe automation run it paused over, or null for a resume, which no run caused.
Show attributes
The automation run it paused over, or null for a resume, which no run caused.
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
sincestring · date-timerequiredWhen it paused.
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
runCountintegerrequiredHow many numbered runs it has had, the number its latest numbered run's runNumber reached. Exits and skipped checks are not counted.
Validation rules
- Minimum
0- Maximum
9007199254740991
skippedRunCountintegerrequiredHow many of its runs were skipped: each failed, counted toward the run limit, and left the schedule as it was. A run it paused over is not one of them.
Validation rules
- Minimum
0- Maximum
9007199254740991
harvestCountintegerrequiredHow many times it has taken a gain: harvest runs that settled at least in part. A run that failed, is uncertain or found nothing to trade isn't counted. Zero for an automation that doesn't harvest.
Validation rules
- Minimum
0- Maximum
9007199254740991
nextFireAtanyOfrequiredWhen this automation's clock will next wake it, when it has a schedule and is enabled.
Show attributes
When this automation's clock will next wake it, when it has a schedule and is enabled.
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
monitoringobjectrequiredAn automation's current health: its sources, its most recent evaluation, and its inbound webhook, if it has one.
Show attributes
An automation's current health: its sources, its most recent evaluation, and its inbound webhook, if it has one.
statusstringrequiredThe automation's overall monitoring status: waiting no evaluation yet, healthy sources and evaluation are current, stale an input is older than expected, unavailable a source could not be reached, paused firing is paused, completed its run policy is spent. A news exit (rule.news) reads healthy while Fin's news judge checks the news for it and unavailable while news checks are paused for its owner.
Validation rules
- Allowed values
["waiting","healthy","stale","unavailable","paused","completed"]
lastCheckedAtanyOfrequiredWhen monitoring last checked this automation's sources.
Show attributes
When monitoring last checked this automation's sources.
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
sourcesarrayrequiredEach bound source's own health.
Show attributes
Each bound source's own health.
Validation rules
- Maximum items
5
Array items · object
bindingstringrequiredThe binding name a rule or a plan gives one configured source.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_-]{0,31}$"
sourceIdstringrequiredThe source's id within its provider.
checkobjectoptionalThe most recent recipe check against this source, when evidence review is configured.
Show attributes
The most recent recipe check against this source, when evidence review is configured.
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"]
statusstringrequiredThis source's health: waiting no observation yet, healthy fresh, stale older than expected, unavailable the provider could not be reached.
Validation rules
- Allowed values
["waiting","healthy","stale","unavailable"]
sourceTimeanyOfrequiredWhen the provider says the most recent observation was true.
Show attributes
When the provider says the most recent observation was true.
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
receivedAtanyOfrequiredWhen the engine received the most recent observation.
Show attributes
When the engine received the most recent observation.
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
reasonstring or nullrequiredWhy the source is not healthy, when it is not.
lastEvaluationanyOfrequiredThe rule's most recent evaluation, when it has run at least once.
Show attributes
The rule's most recent evaluation, when it has run at least once.
anyOf · 2 variants
Variant 1 · object
verdictstringrequiredWhether the condition holds: true it matches, false it does not, unknown usable input is missing. Firing policy, delivery, admission, budget and approvals separately decide whether matching can execute.
Validation rules
- Allowed values
["true","false","unknown"]
evaluatedAtstring · date-timerequiredWhen this evaluation ran.
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))$"
reasonsarrayrequiredWhy the verdict is what it is, one entry per condition node that did not cleanly resolve.
Show attributes
Why the verdict is what it is, one entry per condition node that did not cleanly resolve.
Validation rules
- Maximum items
256
Array items · object
nodePatharrayrequiredThe path to the condition node this reason explains, as indices into the rule tree.
Show attributes
The path to the condition node this reason explains, as indices into the rule tree.
Validation rules
- Maximum items
8
Array items · integer
Validation rules
- Minimum
0- Maximum
9007199254740991
codestringrequiredWhy this node could not cleanly resolve: missing_source no binding was configured, unavailable the provider did not answer, gap a break in coverage was recorded, stale or future a timestamp was out of range, missing_field the observation lacked this field, invalid_value the value did not match its declared type, snapshot_skew the inputs disagreed on when they were true.
Validation rules
- Allowed values
["missing_source","unavailable","gap","stale","future","missing_field","invalid_value","snapshot_skew"]
bindingstringoptionalThe binding name a rule or a plan gives one configured source.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_-]{0,31}$"
inputsarrayrequiredEach input this evaluation read, without its raw data.
Show attributes
Each input this evaluation read, without its raw data.
Validation rules
- Maximum items
5
Array items · oneOf
oneOf · 2 variants
Variant 1 · kind: snapshot
bindingstringrequiredThe binding name a rule or a plan gives one configured source.
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 observation or event's id.
Validation rules
- Minimum length
1- Maximum length
128
receivedAtstring · date-timerequiredWhen the engine received this observation.
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))$"
maxAgeSecondsintegerrequiredHow old this observation was allowed to be at evaluation, in seconds.
Validation rules
- Greater than
0- Maximum
9007199254740991
statusstringrequiredWhether this input was ready to evaluate, the provider was unavailable, or a gap was recorded instead.
Validation rules
- Allowed values
["ready","unavailable","gap"]
reasonanyOfrequiredWhy the input is not ready, when it is not.
Show attributes
Why the input is not ready, when it is not.
anyOf · 2 variants
Variant 1 · string
Validation rules
- Maximum length
512
Variant 2 · null
kindstringrequiredA point-in-time read of current state.
Validation rules
- Exact value
"snapshot"
sourceTimestring · date-timerequiredWhen the provider says this snapshot was true.
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 · kind: received_event
bindingstringrequiredThe binding name a rule or a plan gives one configured source.
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 observation or event's id.
Validation rules
- Minimum length
1- Maximum length
128
receivedAtstring · date-timerequiredWhen the engine received this observation.
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))$"
maxAgeSecondsintegerrequiredHow old this observation was allowed to be at evaluation, in seconds.
Validation rules
- Greater than
0- Maximum
9007199254740991
statusstringrequiredWhether this input was ready to evaluate, the provider was unavailable, or a gap was recorded instead.
Validation rules
- Allowed values
["ready","unavailable","gap"]
reasonanyOfrequiredWhy the input is not ready, when it is not.
Show attributes
Why the input is not ready, when it is not.
anyOf · 2 variants
Variant 1 · string
Validation rules
- Maximum length
512
Variant 2 · null
kindstringrequiredAn event the source pushed, or the engine collected as it happened.
Validation rules
- Exact value
"received_event"
sourceTimenullrequiredNot applicable to a received event; see occurredAt and providerPublishedAt instead.
providerPublishedAtanyOfrequiredWhen the provider says it published this event, when it reports one.
Show attributes
When the provider says it published this event, when it reports one.
anyOf · 2 variants
Variant 1 · string · date-time
Validation rules
- Maximum length
64- 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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
Variant 2 · null
occurredAtanyOfrequiredWhen the event actually happened, when the provider reports that separately from when it was published.
Show attributes
When the event actually happened, when the provider reports that separately from when it was published.
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
finalizedAtanyOfrequiredWhen the provider considers this event no longer subject to correction, when it reports one.
Show attributes
When the provider considers this event no longer subject to correction, when it reports one.
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
Variant 2 · null
webhookanyOfrequiredThis automation's owner webhook, when its rule has one; null for a news exit.
Show attributes
This automation's owner webhook, when its rule has one; null for a news exit.
anyOf · 2 variants
Variant 1 · object
configuredbooleanrequiredWhether a webhook secret has been minted.
keyIdanyOfrequiredThe current webhook secret's id, for rotation.
Show attributes
The current webhook secret's id, for rotation.
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
lastReceivedAtanyOfrequiredWhen the webhook last received a request.
Show attributes
When the webhook last received a request.
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
Variant 2 · null
reasonstring or nullrequiredWhy status is not healthy, when it is not.
activeRunanyOfrequiredThe automation run in progress or waiting to start, when there is one.
Show attributes
The automation run in progress or waiting to start, when there is one.
anyOf · 2 variants
Variant 1 · 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
Variant 2 · null
latestRunanyOfrequiredThe most recent automation run, finished or not, when there has been one.
Show attributes
The most recent automation run, finished or not, when there has been one.
anyOf · 2 variants
Variant 1 · 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
Variant 2 · null
contractanyOfrequiredThe standing financial authority this automation's engine-fired runs execute under; null for an automation without one.
Show attributes
The standing financial authority this automation's engine-fired runs execute under; null for an automation without one.
anyOf · 2 variants
Variant 1 · object
termsoneOfrequiredThe approved contract's exact terms.
Show attributes
The approved contract's exact terms.
oneOf · 4 variants
Variant 1 · type: near_intents_transfer
typestringrequiredWhich contract template this is.
Validation rules
- Exact value
"near_intents_transfer"
actionsarrayrequiredThe actions this contract authorizes, executed in order.
Show attributes
The actions this contract authorizes, executed in order.
Validation rules
- Minimum items
1- Maximum items
16
Array items · oneOf
oneOf · 4 variants
Variant 1 · kind: swap
kindstringrequiredExchange one asset for another; custody never leaves the agent wallet.
Validation rules
- Exact value
"swap"
inputanyOfrequiredThe asset this action spends: pinned to one token, or any token the agent wallet holds.
Show attributes
The asset this action spends: pinned to one token, or any token the agent wallet holds.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
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
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
quantityoneOfrequiredHow much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
Show attributes
How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
oneOf · 7 variants
Variant 1 · kind: exact_input_tokens
An exact quantity of the input token, not its USD value: exactly 5 USDC at decimals 6 is amountRaw "5000000". No floating-point arithmetic or bash.
kindstringrequiredSpend an exact amount of the input token.
Validation rules
- Exact value
"exact_input_tokens"
amountRawstringrequiredThe exact input amount, in the input token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: exact_input_value_usd
A USD value of the input token: "$5 worth of USDC" is value "5", never exactly 5 USDC. The host converts it at live prices.
kindstringrequiredSpend a USD-denominated value of the input token.
Validation rules
- Exact value
"exact_input_value_usd"
valuestringrequiredThe USD value to spend, as a decimal string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"
Variant 3 · kind: exact_output_tokens
An exact quantity of the output token, scaled by its verified decimals; the host calculates the input.
kindstringrequiredReceive an exact amount of the output token.
Validation rules
- Exact value
"exact_output_tokens"
amountRawstringrequiredThe exact output amount, in the output token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 4 · kind: all_of_input
kindstringrequiredSpend everything the agent wallet holds of the input asset.
Validation rules
- Exact value
"all_of_input"
Variant 5 · kind: fraction_of_input
kindstringrequiredSpend a fraction of the input asset.
Validation rules
- Exact value
"fraction_of_input"
bpsstringrequiredThe fraction to spend, in basis points of the input asset.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 6 · kind: fraction_of_position
A fraction of what THIS automation's own settled fills still hold of the input asset, never of the wallet balance; only on an action with an exit guard.
kindstringrequiredSell a fraction of this automation's own position in the input asset.
Validation rules
- Exact value
"fraction_of_position"
bpsstringrequiredThe fraction to sell, in basis points of this automation's own position; 10000 is all of it.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 7 · kind: gain_of_position
Only the gain on THIS automation's own position, priced in the token its buys paid with; only with a take_profit or harvest_every exit guard and a pinned output other than that token.
kindstringrequiredSell only the gain on this automation's own position in the input asset.
Validation rules
- Exact value
"gain_of_position"
outputanyOfrequiredThe asset this action produces: pinned to one token, or left open.
Show attributes
The asset this action produces: pinned to one token, or left open.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
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
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
exitoneOfoptionalOptional exit guard: this action sells only when the asset's price in its output token crosses the automation's own average cost by the approved amount.
Show attributes
Optional exit guard: this action sells only when the asset's price in its output token crosses the automation's own average cost by the approved amount.
oneOf · 3 variants
Variant 1 · kind: take_profit
A take-profit exit: sell once the price is up this much on average cost.
kindstringrequiredSell when the asset is this far ABOVE the automation's average cost.
Validation rules
- Exact value
"take_profit"
gainBpsstringrequiredHow far above the average cost the price must be, in basis points.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 2 · kind: stop_loss
A stop-loss exit: sell once the price is down this much on average cost.
kindstringrequiredSell when the asset is this far BELOW the automation's average cost.
Validation rules
- Exact value
"stop_loss"
lossBpsstringrequiredHow far below the average cost the price must be, in basis points.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 3 · kind: harvest_every
A scheduled harvest: only on a gain_of_position exit selling a curated yield vault's share token (earn_vaults). Every days days it sells only the gain, if there is any, and the automation keeps running.
kindstringrequiredTake profits on a schedule: sell only the gain every this many days, counted from the last harvest that settled, or from the first deposit that settled.
Validation rules
- Exact value
"harvest_every"
daysstringrequiredHow many days apart harvests are, 7 to 365, as a decimal string: "7" weekly, "30" monthly.
Validation rules
- Pattern
"^[1-9]\\d{0,2}$"
Variant 2 · kind: withdraw_to_owner
kindstringrequiredReturn an asset to the account that owns the agent wallet.
Validation rules
- Exact value
"withdraw_to_owner"
inputanyOfrequiredThe asset this action spends: pinned to one token, or any token the agent wallet holds.
Show attributes
The asset this action spends: pinned to one token, or any token the agent wallet holds.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
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
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
quantityoneOfrequiredHow much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
Show attributes
How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
oneOf · 7 variants
Variant 1 · kind: exact_input_tokens
An exact quantity of the input token, not its USD value: exactly 5 USDC at decimals 6 is amountRaw "5000000". No floating-point arithmetic or bash.
kindstringrequiredSpend an exact amount of the input token.
Validation rules
- Exact value
"exact_input_tokens"
amountRawstringrequiredThe exact input amount, in the input token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: exact_input_value_usd
A USD value of the input token: "$5 worth of USDC" is value "5", never exactly 5 USDC. The host converts it at live prices.
kindstringrequiredSpend a USD-denominated value of the input token.
Validation rules
- Exact value
"exact_input_value_usd"
valuestringrequiredThe USD value to spend, as a decimal string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"
Variant 3 · kind: exact_output_tokens
An exact quantity of the output token, scaled by its verified decimals; the host calculates the input.
kindstringrequiredReceive an exact amount of the output token.
Validation rules
- Exact value
"exact_output_tokens"
amountRawstringrequiredThe exact output amount, in the output token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 4 · kind: all_of_input
kindstringrequiredSpend everything the agent wallet holds of the input asset.
Validation rules
- Exact value
"all_of_input"
Variant 5 · kind: fraction_of_input
kindstringrequiredSpend a fraction of the input asset.
Validation rules
- Exact value
"fraction_of_input"
bpsstringrequiredThe fraction to spend, in basis points of the input asset.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 6 · kind: fraction_of_position
A fraction of what THIS automation's own settled fills still hold of the input asset, never of the wallet balance; only on an action with an exit guard.
kindstringrequiredSell a fraction of this automation's own position in the input asset.
Validation rules
- Exact value
"fraction_of_position"
bpsstringrequiredThe fraction to sell, in basis points of this automation's own position; 10000 is all of it.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 7 · kind: gain_of_position
Only the gain on THIS automation's own position, priced in the token its buys paid with; only with a take_profit or harvest_every exit guard and a pinned output other than that token.
kindstringrequiredSell only the gain on this automation's own position in the input asset.
Validation rules
- Exact value
"gain_of_position"
outputanyOfrequiredThe asset this action produces: pinned to one token, or left open.
Show attributes
The asset this action produces: pinned to one token, or left open.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
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
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
Variant 3 · kind: withdraw_transfer
kindstringrequiredPay the exact approved destination through the provider’s chain or Intents transfer route.
Validation rules
- Exact value
"withdraw_transfer"
inputanyOfrequiredThe asset this action spends: pinned to one token, or any token the agent wallet holds.
Show attributes
The asset this action spends: pinned to one token, or any token the agent wallet holds.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
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
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
quantityoneOfrequiredHow much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
Show attributes
How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
oneOf · 7 variants
Variant 1 · kind: exact_input_tokens
An exact quantity of the input token, not its USD value: exactly 5 USDC at decimals 6 is amountRaw "5000000". No floating-point arithmetic or bash.
kindstringrequiredSpend an exact amount of the input token.
Validation rules
- Exact value
"exact_input_tokens"
amountRawstringrequiredThe exact input amount, in the input token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: exact_input_value_usd
A USD value of the input token: "$5 worth of USDC" is value "5", never exactly 5 USDC. The host converts it at live prices.
kindstringrequiredSpend a USD-denominated value of the input token.
Validation rules
- Exact value
"exact_input_value_usd"
valuestringrequiredThe USD value to spend, as a decimal string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"
Variant 3 · kind: exact_output_tokens
An exact quantity of the output token, scaled by its verified decimals; the host calculates the input.
kindstringrequiredReceive an exact amount of the output token.
Validation rules
- Exact value
"exact_output_tokens"
amountRawstringrequiredThe exact output amount, in the output token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 4 · kind: all_of_input
kindstringrequiredSpend everything the agent wallet holds of the input asset.
Validation rules
- Exact value
"all_of_input"
Variant 5 · kind: fraction_of_input
kindstringrequiredSpend a fraction of the input asset.
Validation rules
- Exact value
"fraction_of_input"
bpsstringrequiredThe fraction to spend, in basis points of the input asset.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 6 · kind: fraction_of_position
A fraction of what THIS automation's own settled fills still hold of the input asset, never of the wallet balance; only on an action with an exit guard.
kindstringrequiredSell a fraction of this automation's own position in the input asset.
Validation rules
- Exact value
"fraction_of_position"
bpsstringrequiredThe fraction to sell, in basis points of this automation's own position; 10000 is all of it.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 7 · kind: gain_of_position
Only the gain on THIS automation's own position, priced in the token its buys paid with; only with a take_profit or harvest_every exit guard and a pinned output other than that token.
kindstringrequiredSell only the gain on this automation's own position in the input asset.
Validation rules
- Exact value
"gain_of_position"
outputanyOfrequiredThe asset this action produces: pinned to one token, or left open.
Show attributes
The asset this action produces: pinned to one token, or left open.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
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
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
recipientobjectrequiredThe exact approved payout rail, network and address.
Show attributes
The exact approved payout rail, network and address.
railstringrequiredA native blockchain transfer or a signed transfer within an Intents ledger.
Validation rules
- Allowed values
["chain","intents"]
networkstringrequiredExact network identifier from wallet capabilities; near-intents and near-intents-confidential are ledgers, not the NEAR blockchain.
Validation rules
- Pattern
"^[a-z][a-z0-9-]{0,63}$"
addressstringrequiredExact network address, preserving case and any routing metadata encoded in its native address format. Names must be resolved before approval.
Validation rules
- Pattern
"^[\\x21-\\x7e]{1,256}$"
memonullrequiredStandalone routing memos are unsupported; routing must be encoded in the approved address.
minimumReceivedRawanyOfrequiredMinimum acceptable payout in output-asset atomic units, or null when the approved all-in loss bound alone sets the floor.
Show attributes
Minimum acceptable payout in output-asset atomic units, or null when the approved all-in loss bound alone sets the floor.
anyOf · 2 variants
Variant 1 · string
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · null
maxFeeRawanyOfrequiredOptional separate withdrawal fee cap in output-asset atomic units; null means undisclosed, while all-in loss and minimum receive remain enforced.
Show attributes
Optional separate withdrawal fee cap in output-asset atomic units; null means undisclosed, while all-in loss and minimum receive remain enforced.
anyOf · 2 variants
Variant 1 · string
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · null
Variant 4 · kind: send
kindstringrequiredNot executable, and refused in new contracts: pay an address with withdraw_transfer.
Validation rules
- Exact value
"send"
inputanyOfrequiredThe asset this action spends: pinned to one token, or any token the agent wallet holds.
Show attributes
The asset this action spends: pinned to one token, or any token the agent wallet holds.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
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
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
quantityoneOfrequiredHow much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
Show attributes
How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
oneOf · 7 variants
Variant 1 · kind: exact_input_tokens
An exact quantity of the input token, not its USD value: exactly 5 USDC at decimals 6 is amountRaw "5000000". No floating-point arithmetic or bash.
kindstringrequiredSpend an exact amount of the input token.
Validation rules
- Exact value
"exact_input_tokens"
amountRawstringrequiredThe exact input amount, in the input token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: exact_input_value_usd
A USD value of the input token: "$5 worth of USDC" is value "5", never exactly 5 USDC. The host converts it at live prices.
kindstringrequiredSpend a USD-denominated value of the input token.
Validation rules
- Exact value
"exact_input_value_usd"
valuestringrequiredThe USD value to spend, as a decimal string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"
Variant 3 · kind: exact_output_tokens
An exact quantity of the output token, scaled by its verified decimals; the host calculates the input.
kindstringrequiredReceive an exact amount of the output token.
Validation rules
- Exact value
"exact_output_tokens"
amountRawstringrequiredThe exact output amount, in the output token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 4 · kind: all_of_input
kindstringrequiredSpend everything the agent wallet holds of the input asset.
Validation rules
- Exact value
"all_of_input"
Variant 5 · kind: fraction_of_input
kindstringrequiredSpend a fraction of the input asset.
Validation rules
- Exact value
"fraction_of_input"
bpsstringrequiredThe fraction to spend, in basis points of the input asset.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 6 · kind: fraction_of_position
A fraction of what THIS automation's own settled fills still hold of the input asset, never of the wallet balance; only on an action with an exit guard.
kindstringrequiredSell a fraction of this automation's own position in the input asset.
Validation rules
- Exact value
"fraction_of_position"
bpsstringrequiredThe fraction to sell, in basis points of this automation's own position; 10000 is all of it.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 7 · kind: gain_of_position
Only the gain on THIS automation's own position, priced in the token its buys paid with; only with a take_profit or harvest_every exit guard and a pinned output other than that token.
kindstringrequiredSell only the gain on this automation's own position in the input asset.
Validation rules
- Exact value
"gain_of_position"
outputanyOfrequiredThe asset this action produces: pinned to one token, or left open.
Show attributes
The asset this action produces: pinned to one token, or left open.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
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
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
recipientobjectrequiredThe pinned destination this action pays.
Show attributes
The pinned destination this action pays.
chainstringrequiredWhich chain the destination address is on.
Validation rules
- Minimum length
1- Maximum length
32
addressstringrequiredThe destination address on that chain.
Validation rules
- Pattern
"^[\\x21-\\x7e]{1,128}$"
validUntilstring · date-timerequiredWhen this contract's authority expires.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
maxExecutionsintegerrequiredHow many times this contract may be executed before it is exhausted.
Validation rules
- Minimum
1- Maximum
10000
maxTotalInputarrayoptionalOptional total cap on what all executions together may spend, per input token, in raw units. A $500 budget paid in USDC is 500 USDC. Every action input must be pinned and capped.
Show attributes
Optional total cap on what all executions together may spend, per input token, in raw units. A $500 budget paid in USDC is 500 USDC. Every action input must be pinned and capped.
Validation rules
- Minimum items
1- Maximum items
16
Array items · object
One capped input token and its total spend ceiling.
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
amountRawstringrequiredThe most this contract may spend of this token in total, across every execution, in the token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
boundsobjectrequiredThe value-loss and signature-lifetime limits every execution must respect.
Show attributes
The value-loss and signature-lifetime limits every execution must respect.
maxValueLossBpsstringrequiredThe most value an execution may give up to price movement and fees together, in basis points; 0 allows no loss.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
maxSignatureLifetimeSecondsintegerrequiredExplicit maximum lifetime of each released transfer signature, in seconds. 1Click confidential swaps require up to 259500 seconds (72 hours 5 minutes). This does not extend the execution window or approval validity.
Validation rules
- Minimum
1- Maximum
259500
executionanyOfoptionalOptional explicit recovery authority, signed with these exact actions and bounds; omitted on historical approvals.
Show attributes
Optional explicit recovery authority, signed with these exact actions and bounds; omitted on historical approvals.
anyOf · 2 variants
Variant 1 · object
modestringrequiredOrdered actions run in approved order. Parallel-independent actions run up to four concurrently after the complete initially funded request is reserved.
Validation rules
- Allowed values
["ordered","parallel_independent"]
maxPreparationAttemptsintegerrequiredThe maximum unsigned preparation attempts for each approved action, including its first attempt.
Validation rules
- Minimum
1- Maximum
3
dispatchWindowSecondsintegerrequiredThe maximum dispatch window in seconds for this operation, from when its approval opened: exactly 1200 for a new chat request, and up to its signed deadline for an automation's grant. Closing dispatch never proves a submitted transfer did not move; observation continues.
Validation rules
- Minimum
60- Maximum
86400
Variant 2 · object
modestringrequiredValidation rules
- Exact value
"dependency_graph"
dependenciesarrayrequiredOne row per requested action, listing its sorted unique predecessor action indices. A successor requires confirmed predecessor settlement. Every action must be funded from initial holdings.
Show attributes
One row per requested action, listing its sorted unique predecessor action indices. A successor requires confirmed predecessor settlement. Every action must be funded from initial holdings.
Validation rules
- Minimum items
1- Maximum items
16
Array items · array
Validation rules
- Maximum items
16
Array items · integer
Validation rules
- Minimum
0- Maximum
15
maxPreparationAttemptsintegerrequiredThe maximum unsigned preparation attempts for each approved action, including its first attempt.
Validation rules
- Minimum
1- Maximum
3
dispatchWindowSecondsintegerrequiredThe maximum dispatch window in seconds for this operation, from when its approval opened: exactly 1200 for a new chat request, and up to its signed deadline for an automation's grant. Closing dispatch never proves a submitted transfer did not move; observation continues.
Validation rules
- Minimum
60- Maximum
86400
Variant 2 · type: perps_automation
A standing approval for one perps automation: open the agent's own position while it holds nothing on the coin, reduce or close it, or add margin to its own account, each time its rule fires, up to its limits.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"perps_automation"
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
positionstringrequiredThe position the action is for. open acts only while the agent holds nothing on this coin; reduce and add_margin act only while it holds this side, and nothing happens otherwise.
Validation rules
- Allowed values
["long","short"]
actiononeOfrequiredWhat a perps automation does each time its rule fires: open the named position while the agent holds nothing on its coin, reduce the named position, or add margin to the agent's own perps account.
Show attributes
What a perps automation does each time its rule fires: open the named position while the agent holds nothing on its coin, reduce the named position, or add margin to the agent's own perps account.
oneOf · 3 variants
Variant 1 · kind: reduce
Close part or all of the position with a reduce-only market order.
kindstringrequiredReduce or close the position.
Validation rules
- Exact value
"reduce"
fractionBpsintegerrequiredHow much of the position to close, in basis points: 10000 closes it all.
Validation rules
- Minimum
1- Maximum
10000
maxSlippageBpsintegerrequiredThe worst fill allowed, in basis points from the mark when it fires.
Validation rules
- Minimum
1- Maximum
500
Variant 2 · kind: add_margin
Fund the agent's own perps account from its agent wallet.
kindstringrequiredAdd margin to the perps account.
Validation rules
- Exact value
"add_margin"
amountRawstringrequiredExact USDC moved from the agent wallet into the perps account, six decimals: 5 USDC is "5000000".
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
maxValueLossBpsintegerrequiredMaximum value lost to fees moving it, in basis points.
Validation rules
- Minimum
0- Maximum
300
Variant 3 · kind: open
Open the position with a market order, only while the agent holds nothing on this coin, optionally protected by a native take-profit and stop-loss.
kindstringrequiredOpen the position at market.
Validation rules
- Exact value
"open"
notionalUsdstringrequiredThe position's size in US dollars at the mark when it fires, at most two places: a $200 position is "200". The size in the coin is this over the mark, rounded down to the market's size precision.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,6})(\\.[0-9]{1,2})?$"
leverageintegerrequiredLeverage the user chose for this market, at most the market's maximum. Never assume it: ask the user.
Validation rules
- Minimum
1- Maximum
100
marginModestringrequiredHow the position is margined, which the user chose with the leverage: cross shares the account's margin, isolated risks only this position's own. An isolated-only market takes isolated. Never assume it: ask the user.
Validation rules
- Allowed values
["cross","isolated"]
maxSlippageBpsintegerrequiredThe worst fill allowed, in basis points from the mark when it fires; the take-profit and stop-loss fill within the same bound of their trigger.
Validation rules
- Minimum
1- Maximum
500
takeProfitPercentanyOfrequiredA native take-profit this far from the mark when it opens, in percent of price in the position's favour ("10" is 10%), or null for none.
Show attributes
A native take-profit this far from the mark when it opens, in percent of price in the position's favour ("10" is 10%), or null for none.
anyOf · 2 variants
Variant 1 · string
Validation rules
- Pattern
"^(0|[1-9][0-9]?)(\\.[0-9]{0,3}[1-9])?$"
Variant 2 · null
stopLossPercentanyOfrequiredA native stop-loss this far from the mark when it opens, in percent of price against the position ("5" is 5%), or null for none.
Show attributes
A native stop-loss this far from the mark when it opens, in percent of price against the position ("5" is 5%), or null for none.
anyOf · 2 variants
Variant 1 · string
Validation rules
- Pattern
"^(0|[1-9][0-9]?)(\\.[0-9]{0,3}[1-9])?$"
Variant 2 · null
maxExecutionsintegerrequiredHow many firings may act under this approval.
Validation rules
- Minimum
1- Maximum
100
validUntilstring · date-timerequiredThe deadline after which this approval authorizes nothing.
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 3 · type: prediction_automation
A standing approval for one Polymarket automation: buy one outcome with a USD budget at no more than a maximum price, or sell a share of the agent's holding of it at no less than a minimum price, each time its rule fires, up to its limits.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"prediction_automation"
marketobjectrequiredThe one Polymarket outcome this automation trades.
Show attributes
The one Polymarket outcome this automation trades.
marketIdstringrequiredThe market's id exactly as prediction_market returns it.
Validation rules
- Pattern
"^[1-9][0-9]{0,19}$"
conditionIdstringrequiredThe market's conditionId exactly as prediction_market returns it.
Validation rules
- Pattern
"^0x[0-9a-fA-F]{64}$"
assetIdstringrequiredThe outcome's CLOB token id, exactly the assetId prediction_market lists for that outcome. Yes and No are different tokens.
Validation rules
- Pattern
"^[1-9][0-9]{0,77}$"
marketQuestionstringrequiredThe market's question exactly as prediction_market returns it.
Validation rules
- Minimum length
1- Maximum length
1000
outcomestringrequiredThe outcome's name exactly as prediction_market returns it.
Validation rules
- Minimum length
1- Maximum length
256
actiononeOfrequiredWhat a Polymarket automation does each time its rule fires: buy the outcome with a USD budget at no more than a maximum price, or sell a share of the agent's holding of it at no less than a minimum price.
Show attributes
What a Polymarket automation does each time its rule fires: buy the outcome with a USD budget at no more than a maximum price, or sell a share of the agent's holding of it at no less than a minimum price.
oneOf · 2 variants
Variant 1 · kind: buy
Buy the outcome with a USD budget at no more than a maximum price.
kindstringrequiredBuy shares of the outcome.
Validation rules
- Exact value
"buy"
amountUsdDecimalstringrequiredThe USD each firing spends before fees, to the cent: "50" is $50. Each buy is an immediate order that fills what it can at once and cancels the rest.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,6})(\\.[0-9]{1,2})?$"
maxPriceUsdDecimalstringrequiredThe most a share may cost, as the market's chance: "0.32" never pays more than 32¢ a share. Use a price on the market's tick.
Validation rules
- Pattern
"^0\\.[0-9]{1,4}$"
maxFeeUsdDecimalstringrequiredThe most each firing may pay Polymarket in fees, in USD: "1" is $1.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,6})(\\.[0-9]{1,6})?$"
Variant 2 · kind: sell
Sell a share of the agent's holding of the outcome at no less than a minimum price.
kindstringrequiredSell shares of the outcome.
Validation rules
- Exact value
"sell"
fractionBpsintegerrequiredHow much of the agent's holding of the outcome each firing sells, in basis points: 10000 sells it all.
Validation rules
- Minimum
1- Maximum
10000
minPriceUsdDecimalstringrequiredThe least a share may sell for, as the market's chance: "0.7" never sells below 70¢ a share. Use a price on the market's tick.
Validation rules
- Pattern
"^0\\.[0-9]{1,4}$"
maxFeeUsdDecimalstringrequiredThe most each firing may pay Polymarket in fees, in USD: "1" is $1.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,6})(\\.[0-9]{1,6})?$"
maxExecutionsintegerrequiredHow many firings may trade under this approval; a buy spends at most maxExecutions × amountUsdDecimal in all.
Validation rules
- Minimum
1- Maximum
100
validUntilstring · date-timerequiredThe deadline after which this approval authorizes nothing.
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 4 · oneOf
A standing Solana grant: an exact buy, or a sale of a fraction of the holding for USDC, made exactly as approved each time the automation fires.
oneOf · 2 variants
Variant 1 · type: solana_buy
An approved Solana buy, executed only exactly as approved.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"solana_buy"
buyobjectrequiredThe exact approved token, payment, all-in loss bound and SOL top-up cap, and, for a buy whose funding pays with a coin, that coin and the most of it it may spend.
Show attributes
The exact approved token, payment, all-in loss bound and SOL top-up cap, and, for a buy whose funding pays with a coin, that coin and the most of it it may spend.
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})$"
maxExecutionsintegerrequiredHow many times this grant may execute: 1 for a one-shot approval.
Validation rules
- Minimum
1- Maximum
1000
validUntilstring · date-timerequiredWhen this grant's authority expires; for a one-shot approval, the approval's own expiry.
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 · type: solana_sell
An approved Solana sell, executed only exactly as approved.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"solana_sell"
sellobjectrequiredThe exact approved token, amount, proceeds and all-in loss bound.
Show attributes
The exact approved token, amount, proceeds and all-in loss bound.
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
maxExecutionsintegerrequiredHow many times this grant may execute: 1 for a one-shot approval.
Validation rules
- Minimum
1- Maximum
1000
validUntilstring · date-timerequiredWhen this grant's authority expires; for a one-shot approval, the approval's own expiry.
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))$"
approvedAtstring · date-timerequiredWhen the owner approved this contract.
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))$"
revokedAtanyOfrequiredWhen this contract was withdrawn, when it has been.
Show attributes
When this contract was withdrawn, 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
executionsUsedintegerrequiredExecutions that consumed the allowance. For a transfer contract, entry plans from the plan and leg ledger: an exit plan is exempt and never counted. For a perps automation, the firings whose exact order or funding was submitted. For a Solana grant, the firings whose trade or funding got past its first claim to sign.
Validation rules
- Minimum
0- Maximum
9007199254740991
spendUsedarrayrequiredOne entry for each capped input token, in the contract's order; empty when the contract has no total cap. The cap itself is terms.maxTotalInput, so the cap minus this is the most that is left: the policy worker, which signs, counts every debit it signed, refunded or not.
Show attributes
One entry for each capped input token, in the contract's order; empty when the contract has no total cap. The cap itself is terms.maxTotalInput, so the cap minus this is the most that is left: the policy worker, which signs, counts every debit it signed, refunded or not.
Validation rules
- Maximum items
16
Array items · object
tokenIdstringrequiredA capped input token of the approved contract.
Validation rules
- Minimum length
1
decimalsintegerrequiredThat token's decimals, copied from the approved cap.
Validation rules
- Minimum
0- Maximum
38
spentRawstringrequiredWhat the grant has spent of that token, raw. Claimed, signed, uncertain, settled and not-executed legs count, because a not-executed ending can follow a consumed deposit; only a refunded leg releases its part. The policy worker enforces the cap too and counts every debit it signed, refunded or not, so after a refund the room it grants can be smaller than this figure suggests.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
settledSpendarrayrequiredWhat has actually settled of each capped input token, in the same shape as spendUsed: show this as what the automation spent, and spendUsed for what room is left. Unlike spendUsed it leaves out legs still in flight, uncertain, not executed or refunded. An edited grant's figure includes what it carried over, which can hold a not-executed debit from before the edit.
Show attributes
What has actually settled of each capped input token, in the same shape as spendUsed: show this as what the automation spent, and spendUsed for what room is left. Unlike spendUsed it leaves out legs still in flight, uncertain, not executed or refunded. An edited grant's figure includes what it carried over, which can hold a not-executed debit from before the edit.
Array items · object
tokenIdstringrequiredA capped input token of the approved contract.
Validation rules
- Minimum length
1
decimalsintegerrequiredThat token's decimals, copied from the approved cap.
Validation rules
- Minimum
0- Maximum
38
spentRawstringrequiredWhat has settled of that token, raw. Only settled legs count: nothing in flight, uncertain or not executed. A refunded leg counts nothing, a partly refunded one included, even though part of it may have been spent.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · null
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
409 The operation lost to the current state.
The operation lost to the current state.
automation_held— an operator holds the automation; it fires again when releasedautomation_invalid— the automation's definition cannot run as writtenautomation_changed— the automation changed while this request was handled; read it again and retry
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
410 The resource still exists and stays readable, but can no longer take this request.
The resource still exists and stays readable, but can no longer take this request.
automation_deleted— the automation was deleted
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
413 The body exceeds the size this deployment accepts.
The body exceeds the size this deployment accepts.
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
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.resume",
"summary": "Resume an automation",
"tags": [
"automations"
],
"description": "Starts a paused automation again, under the trading permission it already has. Refused once that permission has been revoked; the user then sets the automation up again. For one fin paused for its owner, pass `countMissedRun=true` when the owner lets the missed run go, so it counts toward the run limit.",
"parameters": [
{
"schema": {
"type": "string"
},
"in": "query",
"name": "countMissedRun",
"required": false,
"description": "Whether the owner let the run fin paused over go, so it counts toward the run limit. Leave it out to keep watching: the run goes back to the limit, and the automation carries on. It runs nothing it missed."
},
{
"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, updated.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Automation"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidInput"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"description": "The operation lost to the current state.\n\n- `automation_held` — an operator holds the automation; it fires again when released\n- `automation_invalid` — the automation's definition cannot run as written\n- `automation_changed` — the automation changed while this request was handled; read it again and retry",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"410": {
"description": "The resource still exists and stays readable, but can no longer take this request.\n\n- `automation_deleted` — the automation was deleted",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
},
"500": {
"$ref": "#/components/responses/Internal"
},
"503": {
"$ref": "#/components/responses/Unavailable"
}
}
},
"components": {
"schemas": {
"Automation": {
"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's id."
},
"definitionVersion": {
"description": "The saved revision number. Use it to ignore older cached reads after chat edits. This server always returns it; earlier servers may omit it.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"name": {
"type": "string",
"description": "The automation's name."
},
"prompt": {
"type": "string",
"description": "The instructions given to the model each time this automation fires."
},
"rule": {
"$ref": "#/components/schemas/AutomationRule"
},
"missedRun": {
"type": "string",
"enum": [
"skip",
"ask"
],
"description": "What happens to a run that can't go through before its deadline: `skip` counts it and keeps the schedule, `ask` pauses the automation until its owner decides. A failure only the owner can fix pauses either way."
},
"summary": {
"type": "string",
"description": "When the automation runs, in one readable sentence or two: its condition, then its schedule and run limit. Times are in UTC unless the schedule names its own time zone."
},
"sourcePlans": {
"maxItems": 4,
"type": "array",
"items": {
"type": "object",
"properties": {
"binding": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding name a rule or a plan gives one configured source."
},
"result": {
"oneOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "ready",
"description": "The binding is fully planned and ready to collect."
},
"plan": {
"type": "object",
"properties": {
"operationId": {
"type": "string",
"pattern": "^[a-z][a-z0-9_.-]{0,79}$",
"description": "The collection operation this plan uses."
},
"operationVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The collection operation's version."
},
"descriptorFingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "A content hash of the source descriptor this plan was built from."
},
"config": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/components/schemas/AutomationJsonValue"
},
"description": "Arbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 entries."
},
"requirement": {
"type": "object",
"properties": {
"maxLatencySeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 2147483
},
{
"type": "null"
}
],
"description": "The target delay between an observation and its delivery, in seconds; null when delivery has no target deadline."
},
"maxAgeSeconds": {
"type": "integer",
"minimum": 1,
"maximum": 86400,
"description": "Maximum acceptable input age at evaluation, matching the reader's maxAgeSeconds, measured from the provider's own observation time. The selected provider's acquisition guarantee must fit within this limit and does not reduce this evaluation window."
},
"allowDegradedLatency": {
"type": "boolean",
"description": "Whether delivery slower than the target delay is still accepted."
},
"maxAcceptedLatencySeconds": {
"description": "The slowest delivery still accepted, in seconds, when `allowDegradedLatency` is set.",
"type": "integer",
"minimum": 1,
"maximum": 2147483
}
},
"required": [
"maxLatencySeconds",
"maxAgeSeconds",
"allowDegradedLatency"
],
"description": "What a reader needs from its source: how fresh an answer must be, and whether a slower one is still acceptable."
},
"guarantees": {
"type": "object",
"properties": {
"delivery": {
"description": "Push delivery; absent means polling.",
"type": "string",
"const": "push"
},
"minCadenceSeconds": {
"type": "integer",
"minimum": 0,
"maximum": 2147483,
"description": "The shortest interval between requests the provider permits, in seconds."
},
"expectedLatencySeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 2147483
},
{
"type": "null"
}
],
"description": "How stale the provider's own value may be when it answers, in seconds; null when the provider establishes no bound. A reader with a delivery deadline cannot use a source that promises nothing here."
},
"maxAgeSeconds": {
"type": "integer",
"minimum": 0,
"maximum": 2147483,
"description": "Maximum snapshot observation age accepted at collection. This acquisition guarantee does not shorten a reader's separately declared evaluation-age window."
},
"requestsPerMinute": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The provider's own rate limit for this source, when it publishes one."
},
"observationReuseSeconds": {
"description": "How long one provider observation may serve every reader watching the same subject under the same connection, in seconds. Absent or 0 means each reader causes its own request. A reused observation keeps the provider's own `sourceTime`, so declared freshness still governs; what reuse changes is how often the provider is asked, not how old an accepted observation may be. Keep it at or below the cadence readers are expected to poll at.",
"type": "integer",
"minimum": 0,
"maximum": 2147483
},
"batchLimit": {
"description": "How many distinct subjects the provider can serve in one request. Absent or 1 means no batching. Only providers implementing `readBatch` may declare more: the framework cannot infer that an API accepts several subjects.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 1000
}
},
"required": [
"minCadenceSeconds",
"expectedLatencySeconds",
"maxAgeSeconds",
"requestsPerMinute"
],
"description": "What an operation promises about the snapshots it serves: cadence, freshness and how many subjects it can batch. Describes sampled state; nothing here promises that a change between two polls was seen."
},
"scopeKind": {
"type": "string",
"enum": [
"public",
"user"
],
"description": "Who this binding is scoped to: `public` data anyone can read, `user` data read under the owner's own connection."
},
"explanation": {
"type": "string",
"maxLength": 2048,
"description": "Why this plan was chosen, in the reviewer's own words."
},
"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."
},
"degraded": {
"type": "boolean",
"description": "Whether this plan settled for weaker guarantees than the rule asked for."
}
},
"required": [
"operationId",
"operationVersion",
"descriptorFingerprint",
"config",
"requirement",
"guarantees",
"scopeKind",
"explanation",
"degraded"
],
"description": "How one binding will actually be collected: the operation, its guarantees and its configuration."
}
},
"required": [
"status",
"plan"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "needs_connection",
"description": "The binding is plannable but needs a connection the owner has not granted yet."
},
"candidatePlan": {
"type": "object",
"properties": {
"operationId": {
"type": "string",
"pattern": "^[a-z][a-z0-9_.-]{0,79}$",
"description": "The collection operation this plan uses."
},
"operationVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The collection operation's version."
},
"descriptorFingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "A content hash of the source descriptor this plan was built from."
},
"config": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/components/schemas/AutomationJsonValue"
},
"description": "Arbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 entries."
},
"requirement": {
"type": "object",
"properties": {
"maxLatencySeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 2147483
},
{
"type": "null"
}
],
"description": "The target delay between an observation and its delivery, in seconds; null when delivery has no target deadline."
},
"maxAgeSeconds": {
"type": "integer",
"minimum": 1,
"maximum": 86400,
"description": "Maximum acceptable input age at evaluation, matching the reader's maxAgeSeconds, measured from the provider's own observation time. The selected provider's acquisition guarantee must fit within this limit and does not reduce this evaluation window."
},
"allowDegradedLatency": {
"type": "boolean",
"description": "Whether delivery slower than the target delay is still accepted."
},
"maxAcceptedLatencySeconds": {
"description": "The slowest delivery still accepted, in seconds, when `allowDegradedLatency` is set.",
"type": "integer",
"minimum": 1,
"maximum": 2147483
}
},
"required": [
"maxLatencySeconds",
"maxAgeSeconds",
"allowDegradedLatency"
],
"description": "What a reader needs from its source: how fresh an answer must be, and whether a slower one is still acceptable."
},
"guarantees": {
"type": "object",
"properties": {
"delivery": {
"description": "Push delivery; absent means polling.",
"type": "string",
"const": "push"
},
"minCadenceSeconds": {
"type": "integer",
"minimum": 0,
"maximum": 2147483,
"description": "The shortest interval between requests the provider permits, in seconds."
},
"expectedLatencySeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 2147483
},
{
"type": "null"
}
],
"description": "How stale the provider's own value may be when it answers, in seconds; null when the provider establishes no bound. A reader with a delivery deadline cannot use a source that promises nothing here."
},
"maxAgeSeconds": {
"type": "integer",
"minimum": 0,
"maximum": 2147483,
"description": "Maximum snapshot observation age accepted at collection. This acquisition guarantee does not shorten a reader's separately declared evaluation-age window."
},
"requestsPerMinute": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The provider's own rate limit for this source, when it publishes one."
},
"observationReuseSeconds": {
"description": "How long one provider observation may serve every reader watching the same subject under the same connection, in seconds. Absent or 0 means each reader causes its own request. A reused observation keeps the provider's own `sourceTime`, so declared freshness still governs; what reuse changes is how often the provider is asked, not how old an accepted observation may be. Keep it at or below the cadence readers are expected to poll at.",
"type": "integer",
"minimum": 0,
"maximum": 2147483
},
"batchLimit": {
"description": "How many distinct subjects the provider can serve in one request. Absent or 1 means no batching. Only providers implementing `readBatch` may declare more: the framework cannot infer that an API accepts several subjects.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 1000
}
},
"required": [
"minCadenceSeconds",
"expectedLatencySeconds",
"maxAgeSeconds",
"requestsPerMinute"
],
"description": "What an operation promises about the snapshots it serves: cadence, freshness and how many subjects it can batch. Describes sampled state; nothing here promises that a change between two polls was seen."
},
"scopeKind": {
"type": "string",
"enum": [
"public",
"user"
],
"description": "Who this binding is scoped to: `public` data anyone can read, `user` data read under the owner's own connection."
},
"explanation": {
"type": "string",
"maxLength": 2048,
"description": "Why this plan was chosen, in the reviewer's own words."
},
"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."
},
"degraded": {
"type": "boolean",
"description": "Whether this plan settled for weaker guarantees than the rule asked for."
}
},
"required": [
"operationId",
"operationVersion",
"descriptorFingerprint",
"config",
"requirement",
"guarantees",
"scopeKind",
"explanation",
"degraded"
],
"description": "The plan that would apply once the missing connection is granted."
},
"reasons": {
"minItems": 1,
"maxItems": 32,
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "A machine-readable reason code."
},
"path": {
"description": "The field this reason is about, when it is about one.",
"type": "string",
"maxLength": 256
},
"message": {
"type": "string",
"maxLength": 2048,
"description": "The reason, in the reviewer's own words."
}
},
"required": [
"code",
"message"
]
},
"description": "Why this binding could not be planned as asked."
}
},
"required": [
"status",
"candidatePlan",
"reasons"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "unsupported",
"description": "The binding cannot be planned at all, as asked."
},
"reasons": {
"minItems": 1,
"maxItems": 32,
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "A machine-readable reason code."
},
"path": {
"description": "The field this reason is about, when it is about one.",
"type": "string",
"maxLength": 256
},
"message": {
"type": "string",
"maxLength": 2048,
"description": "The reason, in the reviewer's own words."
}
},
"required": [
"code",
"message"
]
},
"description": "Why this binding could not be planned as asked."
}
},
"required": [
"status",
"reasons"
]
}
],
"description": "Whether this binding is ready, needs a connection, or is unsupported, and why."
}
},
"required": [
"binding",
"result"
]
},
"description": "How each of the rule's bindings will actually be collected."
},
"enabled": {
"type": "boolean",
"description": "Whether this automation is active: false while it is paused and once deleted."
},
"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 was created."
},
"updatedAt": {
"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 was last changed."
},
"deletedAt": {
"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 the automation was deleted; null while it exists."
},
"hold": {
"anyOf": [
{
"type": "object",
"properties": {
"at": {
"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 hold began."
},
"reason": {
"description": "Why an operator placed the hold, when they gave one.",
"type": [
"string",
"null"
]
}
},
"required": [
"at",
"reason"
]
},
{
"type": "null"
}
],
"description": "An operator's hold: why future work is stopped, so the owner does not read it as their own doing."
},
"waitingForOwner": {
"anyOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"add_funds",
"edit_automation",
"decide",
"resume"
],
"description": "What it needs: `add_funds`, `edit_automation`, `decide` whether to act now or keep it as it is, or `resume`: it can no longer read the data it watches until the owner resumes it, which reads that data afresh."
},
"reason": {
"type": "string",
"description": "Why it stopped, one of the reasons a run gives: see `reason` on the automation run. A `resume` gives `unavailable`."
},
"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 automation run it paused over, or null for a `resume`, which no run caused."
},
"since": {
"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 it paused."
}
},
"required": [
"action",
"reason",
"runId",
"since"
]
},
{
"type": "null"
}
],
"description": "When fin paused this automation because only the owner can move it on: what it needs, and the run it stopped at when a run caused it. Null otherwise, including while the owner paused it themselves. Resuming clears it."
},
"runCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "How many numbered runs it has had, the number its latest numbered run's `runNumber` reached. Exits and skipped checks are not counted."
},
"skippedRunCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "How many of its runs were skipped: each failed, counted toward the run limit, and left the schedule as it was. A run it paused over is not one of them."
},
"harvestCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "How many times it has taken a gain: harvest runs that settled at least in part. A run that failed, is uncertain or found nothing to trade isn't counted. Zero for an automation that doesn't harvest."
},
"nextFireAt": {
"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's clock will next wake it, when it has a schedule and is enabled."
},
"monitoring": {
"$ref": "#/components/schemas/AutomationMonitoring"
},
"activeRun": {
"anyOf": [
{
"$ref": "#/components/schemas/AutomationRun"
},
{
"type": "null"
}
],
"description": "The automation run in progress or waiting to start, when there is one."
},
"latestRun": {
"anyOf": [
{
"$ref": "#/components/schemas/AutomationRun"
},
{
"type": "null"
}
],
"description": "The most recent automation run, finished or not, when there has been one."
},
"contract": {
"anyOf": [
{
"type": "object",
"properties": {
"terms": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "near_intents_transfer",
"description": "Which contract template this is."
},
"actions": {
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "swap",
"description": "Exchange one asset for another; custody never leaves the agent wallet."
},
"input": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"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."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action spends: pinned to one token, or any token the agent wallet holds."
},
"quantity": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_tokens",
"description": "Spend an exact amount of the input token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact input amount, in the input token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "An exact quantity of the input token, not its USD value: exactly 5 USDC at decimals 6 is amountRaw \"5000000\". No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_value_usd",
"description": "Spend a USD-denominated value of the input token."
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
"description": "The USD value to spend, as a decimal string."
}
},
"required": [
"kind",
"value"
],
"description": "A USD value of the input token: \"$5 worth of USDC\" is value \"5\", never exactly 5 USDC. The host converts it at live prices."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_output_tokens",
"description": "Receive an exact amount of the output token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact output amount, in the output token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "An exact quantity of the output token, scaled by its verified decimals; the host calculates the input."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "all_of_input",
"description": "Spend everything the agent wallet holds of the input asset."
}
},
"required": [
"kind"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_input",
"description": "Spend a fraction of the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to spend, in basis points of the input asset."
}
},
"required": [
"kind",
"bps"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_position",
"description": "Sell a fraction of this automation's own position in the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to sell, in basis points of this automation's own position; 10000 is all of it."
}
},
"required": [
"kind",
"bps"
],
"description": "A fraction of what THIS automation's own settled fills still hold of the input asset, never of the wallet balance; only on an action with an `exit` guard."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "gain_of_position",
"description": "Sell only the gain on this automation's own position in the input asset."
}
},
"required": [
"kind"
],
"description": "Only the gain on THIS automation's own position, priced in the token its buys paid with; only with a take_profit or harvest_every `exit` guard and a pinned output other than that token."
}
],
"description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
},
"output": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"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."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action produces: pinned to one token, or left open."
},
"exit": {
"description": "Optional exit guard: this action sells only when the asset's price in its output token crosses the automation's own average cost by the approved amount.",
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "take_profit",
"description": "Sell when the asset is this far ABOVE the automation's average cost."
},
"gainBps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "How far above the average cost the price must be, in basis points."
}
},
"required": [
"kind",
"gainBps"
],
"description": "A take-profit exit: sell once the price is up this much on average cost."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "stop_loss",
"description": "Sell when the asset is this far BELOW the automation's average cost."
},
"lossBps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "How far below the average cost the price must be, in basis points."
}
},
"required": [
"kind",
"lossBps"
],
"description": "A stop-loss exit: sell once the price is down this much on average cost."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "harvest_every",
"description": "Take profits on a schedule: sell only the gain every this many days, counted from the last harvest that settled, or from the first deposit that settled."
},
"days": {
"type": "string",
"pattern": "^[1-9]\\d{0,2}$",
"description": "How many days apart harvests are, 7 to 365, as a decimal string: \"7\" weekly, \"30\" monthly."
}
},
"required": [
"kind",
"days"
],
"description": "A scheduled harvest: only on a gain_of_position exit selling a curated yield vault's share token (earn_vaults). Every `days` days it sells only the gain, if there is any, and the automation keeps running."
}
]
}
},
"required": [
"kind",
"input",
"quantity",
"output"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "withdraw_to_owner",
"description": "Return an asset to the account that owns the agent wallet."
},
"input": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"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."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action spends: pinned to one token, or any token the agent wallet holds."
},
"quantity": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_tokens",
"description": "Spend an exact amount of the input token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact input amount, in the input token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "An exact quantity of the input token, not its USD value: exactly 5 USDC at decimals 6 is amountRaw \"5000000\". No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_value_usd",
"description": "Spend a USD-denominated value of the input token."
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
"description": "The USD value to spend, as a decimal string."
}
},
"required": [
"kind",
"value"
],
"description": "A USD value of the input token: \"$5 worth of USDC\" is value \"5\", never exactly 5 USDC. The host converts it at live prices."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_output_tokens",
"description": "Receive an exact amount of the output token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact output amount, in the output token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "An exact quantity of the output token, scaled by its verified decimals; the host calculates the input."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "all_of_input",
"description": "Spend everything the agent wallet holds of the input asset."
}
},
"required": [
"kind"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_input",
"description": "Spend a fraction of the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to spend, in basis points of the input asset."
}
},
"required": [
"kind",
"bps"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_position",
"description": "Sell a fraction of this automation's own position in the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to sell, in basis points of this automation's own position; 10000 is all of it."
}
},
"required": [
"kind",
"bps"
],
"description": "A fraction of what THIS automation's own settled fills still hold of the input asset, never of the wallet balance; only on an action with an `exit` guard."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "gain_of_position",
"description": "Sell only the gain on this automation's own position in the input asset."
}
},
"required": [
"kind"
],
"description": "Only the gain on THIS automation's own position, priced in the token its buys paid with; only with a take_profit or harvest_every `exit` guard and a pinned output other than that token."
}
],
"description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
},
"output": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"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."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action produces: pinned to one token, or left open."
}
},
"required": [
"kind",
"input",
"quantity",
"output"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "withdraw_transfer",
"description": "Pay the exact approved destination through the provider’s chain or Intents transfer route."
},
"input": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"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."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action spends: pinned to one token, or any token the agent wallet holds."
},
"quantity": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_tokens",
"description": "Spend an exact amount of the input token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact input amount, in the input token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "An exact quantity of the input token, not its USD value: exactly 5 USDC at decimals 6 is amountRaw \"5000000\". No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_value_usd",
"description": "Spend a USD-denominated value of the input token."
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
"description": "The USD value to spend, as a decimal string."
}
},
"required": [
"kind",
"value"
],
"description": "A USD value of the input token: \"$5 worth of USDC\" is value \"5\", never exactly 5 USDC. The host converts it at live prices."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_output_tokens",
"description": "Receive an exact amount of the output token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact output amount, in the output token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "An exact quantity of the output token, scaled by its verified decimals; the host calculates the input."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "all_of_input",
"description": "Spend everything the agent wallet holds of the input asset."
}
},
"required": [
"kind"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_input",
"description": "Spend a fraction of the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to spend, in basis points of the input asset."
}
},
"required": [
"kind",
"bps"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_position",
"description": "Sell a fraction of this automation's own position in the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to sell, in basis points of this automation's own position; 10000 is all of it."
}
},
"required": [
"kind",
"bps"
],
"description": "A fraction of what THIS automation's own settled fills still hold of the input asset, never of the wallet balance; only on an action with an `exit` guard."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "gain_of_position",
"description": "Sell only the gain on this automation's own position in the input asset."
}
},
"required": [
"kind"
],
"description": "Only the gain on THIS automation's own position, priced in the token its buys paid with; only with a take_profit or harvest_every `exit` guard and a pinned output other than that token."
}
],
"description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
},
"output": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"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."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action produces: pinned to one token, or left open."
},
"recipient": {
"type": "object",
"properties": {
"rail": {
"type": "string",
"enum": [
"chain",
"intents"
],
"description": "A native blockchain transfer or a signed transfer within an Intents ledger."
},
"network": {
"type": "string",
"pattern": "^[a-z][a-z0-9-]{0,63}$",
"description": "Exact network identifier from wallet capabilities; near-intents and near-intents-confidential are ledgers, not the NEAR blockchain."
},
"address": {
"type": "string",
"pattern": "^[\\x21-\\x7e]{1,256}$",
"description": "Exact network address, preserving case and any routing metadata encoded in its native address format. Names must be resolved before approval."
},
"memo": {
"type": "null",
"description": "Standalone routing memos are unsupported; routing must be encoded in the approved address."
}
},
"required": [
"rail",
"network",
"address",
"memo"
],
"description": "The exact approved payout rail, network and address."
},
"minimumReceivedRaw": {
"anyOf": [
{
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
{
"type": "null"
}
],
"description": "Minimum acceptable payout in output-asset atomic units, or null when the approved all-in loss bound alone sets the floor."
},
"maxFeeRaw": {
"anyOf": [
{
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
{
"type": "null"
}
],
"description": "Optional separate withdrawal fee cap in output-asset atomic units; null means undisclosed, while all-in loss and minimum receive remain enforced."
}
},
"required": [
"kind",
"input",
"quantity",
"output",
"recipient",
"minimumReceivedRaw",
"maxFeeRaw"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "send",
"description": "Not executable, and refused in new contracts: pay an address with withdraw_transfer."
},
"input": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"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."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action spends: pinned to one token, or any token the agent wallet holds."
},
"quantity": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_tokens",
"description": "Spend an exact amount of the input token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact input amount, in the input token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "An exact quantity of the input token, not its USD value: exactly 5 USDC at decimals 6 is amountRaw \"5000000\". No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_value_usd",
"description": "Spend a USD-denominated value of the input token."
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
"description": "The USD value to spend, as a decimal string."
}
},
"required": [
"kind",
"value"
],
"description": "A USD value of the input token: \"$5 worth of USDC\" is value \"5\", never exactly 5 USDC. The host converts it at live prices."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_output_tokens",
"description": "Receive an exact amount of the output token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact output amount, in the output token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "An exact quantity of the output token, scaled by its verified decimals; the host calculates the input."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "all_of_input",
"description": "Spend everything the agent wallet holds of the input asset."
}
},
"required": [
"kind"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_input",
"description": "Spend a fraction of the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to spend, in basis points of the input asset."
}
},
"required": [
"kind",
"bps"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_position",
"description": "Sell a fraction of this automation's own position in the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to sell, in basis points of this automation's own position; 10000 is all of it."
}
},
"required": [
"kind",
"bps"
],
"description": "A fraction of what THIS automation's own settled fills still hold of the input asset, never of the wallet balance; only on an action with an `exit` guard."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "gain_of_position",
"description": "Sell only the gain on this automation's own position in the input asset."
}
},
"required": [
"kind"
],
"description": "Only the gain on THIS automation's own position, priced in the token its buys paid with; only with a take_profit or harvest_every `exit` guard and a pinned output other than that token."
}
],
"description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
},
"output": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"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."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action produces: pinned to one token, or left open."
},
"recipient": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"minLength": 1,
"maxLength": 32,
"description": "Which chain the destination address is on."
},
"address": {
"type": "string",
"pattern": "^[\\x21-\\x7e]{1,128}$",
"description": "The destination address on that chain."
}
},
"required": [
"chain",
"address"
],
"description": "The pinned destination this action pays."
}
},
"required": [
"kind",
"input",
"quantity",
"output",
"recipient"
]
}
]
},
"description": "The actions this contract authorizes, executed in order."
},
"validUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When this contract's authority expires."
},
"maxExecutions": {
"type": "integer",
"minimum": 1,
"maximum": 10000,
"description": "How many times this contract may be executed before it is exhausted."
},
"maxTotalInput": {
"description": "Optional total cap on what all executions together may spend, per input token, in raw units. A $500 budget paid in USDC is 500 USDC. Every action input must be pinned and capped.",
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"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."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The most this contract may spend of this token in total, across every execution, in the token's smallest unit."
}
},
"required": [
"tokenId",
"decimals",
"amountRaw"
],
"description": "One capped input token and its total spend ceiling."
}
},
"bounds": {
"type": "object",
"properties": {
"maxValueLossBps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The most value an execution may give up to price movement and fees together, in basis points; 0 allows no loss."
},
"maxSignatureLifetimeSeconds": {
"type": "integer",
"minimum": 1,
"maximum": 259500,
"description": "Explicit maximum lifetime of each released transfer signature, in seconds. 1Click confidential swaps require up to 259500 seconds (72 hours 5 minutes). This does not extend the execution window or approval validity."
}
},
"required": [
"maxValueLossBps",
"maxSignatureLifetimeSeconds"
],
"description": "The value-loss and signature-lifetime limits every execution must respect."
},
"execution": {
"description": "Optional explicit recovery authority, signed with these exact actions and bounds; omitted on historical approvals.",
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"ordered",
"parallel_independent"
],
"description": "Ordered actions run in approved order. Parallel-independent actions run up to four concurrently after the complete initially funded request is reserved."
},
"maxPreparationAttempts": {
"type": "integer",
"minimum": 1,
"maximum": 3,
"description": "The maximum unsigned preparation attempts for each approved action, including its first attempt."
},
"dispatchWindowSeconds": {
"type": "integer",
"minimum": 60,
"maximum": 86400,
"description": "The maximum dispatch window in seconds for this operation, from when its approval opened: exactly 1200 for a new chat request, and up to its signed deadline for an automation's grant. Closing dispatch never proves a submitted transfer did not move; observation continues."
}
},
"required": [
"mode",
"maxPreparationAttempts",
"dispatchWindowSeconds"
]
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "dependency_graph"
},
"dependencies": {
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"maxItems": 16,
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 15
}
},
"description": "One row per requested action, listing its sorted unique predecessor action indices. A successor requires confirmed predecessor settlement. Every action must be funded from initial holdings."
},
"maxPreparationAttempts": {
"type": "integer",
"minimum": 1,
"maximum": 3,
"description": "The maximum unsigned preparation attempts for each approved action, including its first attempt."
},
"dispatchWindowSeconds": {
"type": "integer",
"minimum": 60,
"maximum": 86400,
"description": "The maximum dispatch window in seconds for this operation, from when its approval opened: exactly 1200 for a new chat request, and up to its signed deadline for an automation's grant. Closing dispatch never proves a submitted transfer did not move; observation continues."
}
},
"required": [
"mode",
"dependencies",
"maxPreparationAttempts",
"dispatchWindowSeconds"
]
}
]
}
},
"required": [
"type",
"actions",
"validUntil",
"maxExecutions",
"bounds"
]
},
{
"$ref": "#/components/schemas/PerpsAutomationContract"
},
{
"$ref": "#/components/schemas/PredictionAutomationContract"
},
{
"oneOf": [
{
"$ref": "#/components/schemas/SolanaBuyContract"
},
{
"$ref": "#/components/schemas/SolanaSellContract"
}
],
"description": "A standing Solana grant: an exact buy, or a sale of a fraction of the holding for USDC, made exactly as approved each time the automation fires."
}
],
"description": "The approved contract's exact terms."
},
"approvedAt": {
"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 owner approved this contract."
},
"revokedAt": {
"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 contract was withdrawn, when it has been."
},
"executionsUsed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Executions that consumed the allowance. For a transfer contract, entry plans from the plan and leg ledger: an exit plan is exempt and never counted. For a perps automation, the firings whose exact order or funding was submitted. For a Solana grant, the firings whose trade or funding got past its first claim to sign."
},
"spendUsed": {
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"minLength": 1,
"description": "A capped input token of the approved contract."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "That token's decimals, copied from the approved cap."
},
"spentRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "What the grant has spent of that token, raw. Claimed, signed, uncertain, settled and not-executed legs count, because a not-executed ending can follow a consumed deposit; only a refunded leg releases its part. The policy worker enforces the cap too and counts every debit it signed, refunded or not, so after a refund the room it grants can be smaller than this figure suggests."
}
},
"required": [
"tokenId",
"decimals",
"spentRaw"
]
},
"description": "One entry for each capped input token, in the contract's order; empty when the contract has no total cap. The cap itself is terms.maxTotalInput, so the cap minus this is the most that is left: the policy worker, which signs, counts every debit it signed, refunded or not."
},
"settledSpend": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"minLength": 1,
"description": "A capped input token of the approved contract."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "That token's decimals, copied from the approved cap."
},
"spentRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "What has settled of that token, raw. Only settled legs count: nothing in flight, uncertain or not executed. A refunded leg counts nothing, a partly refunded one included, even though part of it may have been spent."
}
},
"required": [
"tokenId",
"decimals",
"spentRaw"
]
},
"description": "What has actually settled of each capped input token, in the same shape as `spendUsed`: show this as what the automation spent, and `spendUsed` for what room is left. Unlike `spendUsed` it leaves out legs still in flight, uncertain, not executed or refunded. An edited grant's figure includes what it carried over, which can hold a not-executed debit from before the edit."
}
},
"required": [
"terms",
"approvedAt",
"revokedAt",
"executionsUsed",
"spendUsed",
"settledSpend"
]
},
{
"type": "null"
}
],
"description": "The standing financial authority this automation's engine-fired runs execute under; null for an automation without one."
}
},
"required": [
"id",
"name",
"prompt",
"rule",
"missedRun",
"summary",
"sourcePlans",
"enabled",
"createdAt",
"updatedAt",
"deletedAt",
"hold",
"waitingForOwner",
"runCount",
"skippedRunCount",
"harvestCount",
"nextFireAt",
"monitoring",
"activeRun",
"latestRun",
"contract"
],
"description": "One automation: its rule and a readable summary of it, its current sources, its monitoring health, and its runs."
},
"AutomationRule": {
"type": "object",
"properties": {
"schemaVersion": {
"type": "number",
"const": 1,
"description": "The rule schema's version; always `1`."
},
"delivery": {
"default": {
"overlap": "queue",
"maxPendingOccurrences": 100
},
"oneOf": [
{
"type": "object",
"properties": {
"overlap": {
"type": "string",
"const": "queue",
"description": "Queue a new occurrence and run it once the active one finishes."
},
"maxPendingOccurrences": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "How many occurrences may wait in the queue, not counting the one currently active, including one whose run is itself waiting on an approval."
}
},
"required": [
"overlap",
"maxPendingOccurrences"
]
},
{
"type": "object",
"properties": {
"overlap": {
"type": "string",
"const": "coalesce",
"description": "Close the occurrence already pending as `coalesced` and record the new match as a fresh occurrence, rather than queuing a second."
}
},
"required": [
"overlap"
]
},
{
"type": "object",
"properties": {
"overlap": {
"type": "string",
"const": "skip",
"description": "Drop a new match while an occurrence is already active."
}
},
"required": [
"overlap"
]
}
],
"description": "What happens when a new occurrence is ready before the previous one has finished."
},
"maxDeliveryLatenessSeconds": {
"default": 86400,
"description": "How long a new occurrence may wait to be delivered before its deadline passes and it is refused, in seconds.",
"type": "integer",
"minimum": 1,
"maximum": 86400
},
"maxEvaluationGapSeconds": {
"default": 600,
"description": "The longest gap allowed between evaluations before `firing.mode: rising_edge` treats its history as broken and waits for a fresh baseline, in seconds.",
"type": "integer",
"minimum": 1,
"maximum": 2678400
},
"wakes": {
"minItems": 1,
"maxItems": 7,
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "at",
"description": "A one-time wake at an exact moment; exhausted after that check, even if its condition is false."
},
"runAt": {
"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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "The exact moment this wake fires, as an ISO 8601 timestamp with an offset."
},
"misfire": {
"default": {
"mode": "latest",
"maxLatenessSeconds": null
},
"oneOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "skip",
"description": "Drop a wake the engine could not evaluate in time; wait for the next one."
},
"graceSeconds": {
"default": 5,
"description": "How late this wake may still run before it counts as missed, in seconds.",
"type": "integer",
"minimum": 1,
"maximum": 60
}
},
"required": [
"mode",
"graceSeconds"
]
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "latest",
"description": "Run once for the most recently missed wake, dropping any earlier ones."
},
"maxLatenessSeconds": {
"default": null,
"description": "How late a missed wake may still run, in seconds; null for no limit.",
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 2678400
},
{
"type": "null"
}
]
}
},
"required": [
"mode",
"maxLatenessSeconds"
]
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "all",
"description": "Run once for every missed wake, oldest first."
},
"maxLatenessSeconds": {
"default": null,
"description": "How late a missed wake may still run, in seconds; null for no limit.",
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 2678400
},
{
"type": "null"
}
]
}
},
"required": [
"mode",
"maxLatenessSeconds"
]
}
],
"description": "What happens when the engine could not evaluate this wake on time."
},
"evaluationTime": {
"default": "detection_time",
"description": "Which moment this wake is evaluated as of: `scheduled_time` the time it was due, `detection_time` when the engine actually ran it.",
"type": "string",
"enum": [
"scheduled_time",
"detection_time"
]
}
},
"required": [
"kind",
"runAt",
"misfire",
"evaluationTime"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "interval",
"description": "A wake that repeats on a fixed elapsed interval."
},
"intervalMinutes": {
"type": "integer",
"minimum": 1,
"maximum": 44640,
"description": "How often this wake repeats, in minutes."
},
"misfire": {
"default": {
"mode": "latest",
"maxLatenessSeconds": null
},
"oneOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "skip",
"description": "Drop a wake the engine could not evaluate in time; wait for the next one."
},
"graceSeconds": {
"default": 5,
"description": "How late this wake may still run before it counts as missed, in seconds.",
"type": "integer",
"minimum": 1,
"maximum": 60
}
},
"required": [
"mode",
"graceSeconds"
]
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "latest",
"description": "Run once for the most recently missed wake, dropping any earlier ones."
},
"maxLatenessSeconds": {
"default": null,
"description": "How late a missed wake may still run, in seconds; null for no limit.",
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 2678400
},
{
"type": "null"
}
]
}
},
"required": [
"mode",
"maxLatenessSeconds"
]
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "all",
"description": "Run once for every missed wake, oldest first."
},
"maxLatenessSeconds": {
"default": null,
"description": "How late a missed wake may still run, in seconds; null for no limit.",
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 2678400
},
{
"type": "null"
}
]
}
},
"required": [
"mode",
"maxLatenessSeconds"
]
}
],
"description": "What happens when the engine could not evaluate this wake on time."
},
"evaluationTime": {
"default": "detection_time",
"description": "Which moment this wake is evaluated as of: `scheduled_time` the time it was due, `detection_time` when the engine actually ran it.",
"type": "string",
"enum": [
"scheduled_time",
"detection_time"
]
}
},
"required": [
"kind",
"intervalMinutes",
"misfire",
"evaluationTime"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "calendar",
"description": "A wake on a recurring calendar schedule: local times, weekdays, months and days of the month."
},
"timeZone": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "The IANA time zone a calendar wake's local times are interpreted in."
},
"localTimes": {
"minItems": 1,
"maxItems": 24,
"type": "array",
"items": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"description": "The times of day this wake fires, each in 24-hour `HH:MM` form, in `timeZone`."
},
"weekdays": {
"default": [
1,
2,
3,
4,
5,
6,
7
],
"description": "Which ISO weekdays this wake fires on, 1 (Monday) through 7 (Sunday). Defaults to every day.",
"minItems": 1,
"maxItems": 7,
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 7
}
},
"months": {
"default": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"description": "Which months this wake fires in, 1 (January) through 12 (December). Defaults to every month.",
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 12
}
},
"monthDays": {
"default": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"description": "Which days of the month this wake fires on, 1 through 31. Defaults to every day.",
"minItems": 1,
"maxItems": 31,
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 31
}
},
"misfire": {
"default": {
"mode": "latest",
"maxLatenessSeconds": null
},
"oneOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "skip",
"description": "Drop a wake the engine could not evaluate in time; wait for the next one."
},
"graceSeconds": {
"default": 5,
"description": "How late this wake may still run before it counts as missed, in seconds.",
"type": "integer",
"minimum": 1,
"maximum": 60
}
},
"required": [
"mode",
"graceSeconds"
]
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "latest",
"description": "Run once for the most recently missed wake, dropping any earlier ones."
},
"maxLatenessSeconds": {
"default": null,
"description": "How late a missed wake may still run, in seconds; null for no limit.",
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 2678400
},
{
"type": "null"
}
]
}
},
"required": [
"mode",
"maxLatenessSeconds"
]
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "all",
"description": "Run once for every missed wake, oldest first."
},
"maxLatenessSeconds": {
"default": null,
"description": "How late a missed wake may still run, in seconds; null for no limit.",
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 2678400
},
{
"type": "null"
}
]
}
},
"required": [
"mode",
"maxLatenessSeconds"
]
}
],
"description": "What happens when the engine could not evaluate this wake on time."
},
"evaluationTime": {
"default": "detection_time",
"description": "Which moment this wake is evaluated as of: `scheduled_time` the time it was due, `detection_time` when the engine actually ran it.",
"type": "string",
"enum": [
"scheduled_time",
"detection_time"
]
}
},
"required": [
"kind",
"timeZone",
"localTimes",
"weekdays",
"months",
"monthDays",
"misfire",
"evaluationTime"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "event",
"description": "A wake evaluated each time a matching custom webhook event arrives."
},
"eventType": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,79}$",
"description": "The event `type` this wake matches; a live webhook delivery of a different type is ignored before it reaches the condition."
},
"fields": {
"maxItems": 32,
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"minItems": 1,
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_-]{0,63}$"
},
"description": "The keys to walk, in order, from an observation's top level down to this field."
},
"valueType": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "boolean",
"description": "A true/false value."
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "string",
"description": "A text value."
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "integer",
"description": "A whole-number value, compared exactly."
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The unit an integer or decimal value is measured in, as the source or literal declares it."
}
},
"required": [
"type",
"unit"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "decimal",
"description": "An exact decimal value, as text, compared exactly."
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The unit an integer or decimal value is measured in, as the source or literal declares it."
}
},
"required": [
"type",
"unit"
]
}
],
"description": "What type this field's value has, and the unit it carries when it has one."
},
"optional": {
"description": "Whether the provider may genuinely not observe this field, rather than fail to read it. When true, a missing value resolves a condition over it to `missing_field` and the rule's verdict to `unknown`, rather than zero, null or false.",
"type": "boolean"
}
},
"required": [
"path",
"valueType"
],
"description": "One data field an event or a source's observation carries: where it lives, and its type."
},
"description": "The data fields an event of this type is declared to carry."
}
},
"required": [
"kind",
"eventType",
"fields"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "reader_update",
"description": "A wake evaluated each time the named reader delivers a fresh observation."
},
"binding": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding name a rule or a plan gives one configured source."
}
},
"required": [
"kind",
"binding"
]
}
]
},
"description": "Occasions to evaluate the rule's condition: alternatives, not an AND of conditions. At most one clock and one event stream."
},
"readers": {
"maxItems": 4,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding name a rule or a plan gives one configured source."
},
"readerId": {
"type": "string",
"pattern": "^[a-z][a-z0-9_.-]{0,79}$",
"description": "The installed source operation's id, as listed by List automation data sources."
},
"config": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/components/schemas/AutomationJsonValue"
},
"description": "Arbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 entries."
},
"delivery": {
"description": "Use reviewed push updates; omit for periodic snapshots.",
"type": "string",
"const": "push"
},
"pollIntervalSeconds": {
"type": "integer",
"minimum": 1,
"maximum": 2147483,
"description": "Polling cadence, or subscription lease/reconciliation cadence for push delivery, in seconds."
},
"maxAgeSeconds": {
"type": "integer",
"minimum": 1,
"maximum": 86400,
"description": "Maximum retained input age at evaluation, matching requirement.maxAgeSeconds when present. Snapshots use observation time; events use trusted receipt time. Collection separately enforces the provider's acquisition-age guarantee."
},
"requirement": {
"type": "object",
"properties": {
"maxLatencySeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 2147483
},
{
"type": "null"
}
],
"description": "The target delay between an observation and its delivery, in seconds; null when delivery has no target deadline."
},
"maxAgeSeconds": {
"type": "integer",
"minimum": 1,
"maximum": 86400,
"description": "Maximum acceptable input age at evaluation, matching the reader's maxAgeSeconds, measured from the provider's own observation time. The selected provider's acquisition guarantee must fit within this limit and does not reduce this evaluation window."
},
"allowDegradedLatency": {
"type": "boolean",
"description": "Whether delivery slower than the target delay is still accepted."
},
"maxAcceptedLatencySeconds": {
"description": "The slowest delivery still accepted, in seconds, when `allowDegradedLatency` is set.",
"type": "integer",
"minimum": 1,
"maximum": 2147483
}
},
"required": [
"maxLatencySeconds",
"maxAgeSeconds",
"allowDegradedLatency"
],
"description": "What a reader needs from its source: how fresh an answer must be, and whether a slower one is still acceptable."
}
},
"required": [
"name",
"readerId",
"config",
"pollIntervalSeconds",
"maxAgeSeconds"
]
},
"description": "The named source bindings this rule reads from, referenced by `condition` and by each `reader_update` wake's `binding`."
},
"condition": {
"description": "The rule's condition tree, up to 8 levels deep and 128 nodes total, built from five node kinds: `{op:\"bool\", value}` a fixed true/false leaf; `{op:\"compare\", comparator, left, right}` one of `eq`/`ne`/`lt`/`lte`/`gt`/`gte` between two operands — `lt`/`lte`/`gt`/`gte` require both operands to be `integer` or `decimal`, and both sides must share the same type and, for `integer`/`decimal`, the same unit; `{op:\"all\", args}` / `{op:\"any\", args}` AND/OR over one or more child nodes; `{op:\"not\", arg}` negates one child node. An operand is either `{kind:\"field\", binding, path}` — a bound reader's name and the key path into its data — or `{kind:\"literal\", type, value, unit?}` with `type` one of `boolean`/`string`/`integer`/`decimal` (`integer`/`decimal` values are exact decimal strings and carry `unit`)."
},
"exit": {
"description": "The exit watch, when this rule's automation has exit actions on its contract. Present exactly when the contract has an exit action.",
"type": "object",
"properties": {
"intervalSeconds": {
"type": "integer",
"minimum": 60,
"maximum": 2678400,
"description": "How often this automation re-checks its exit guards, in seconds; at least 60 and at most 2678400 (31 days), the same span an interval wake may cover. Recommend 300."
},
"readers": {
"type": "object",
"properties": {
"asset": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding in `readers` that prices the asset this automation bought, in USD."
},
"quote": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding in `readers` that prices the token this automation pays with, in USD."
}
},
"required": [
"asset",
"quote"
],
"description": "The two price bindings each exit guard is measured against; both must be the reviewed USD token-price operation."
},
"push": {
"description": "Additional push-delivered USD prices that may check exits between periodic 1Click checks.",
"type": "object",
"properties": {
"readers": {
"type": "object",
"properties": {
"asset": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding name a rule or a plan gives one configured source."
},
"quote": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding name a rule or a plan gives one configured source."
}
},
"required": [
"asset",
"quote"
],
"description": "The supplementary price bindings for the bought asset and its paying token."
}
},
"required": [
"readers"
]
}
},
"required": [
"intervalSeconds",
"readers"
]
},
"firing": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"each_match",
"rising_edge"
],
"description": "When a qualifying evaluation fires: `each_match` fires on every qualifying evaluation, including the first; `rising_edge` fires only on a known false-to-true transition."
},
"repeat": {
"type": "string",
"enum": [
"once",
"repeating"
],
"description": "Whether this rule fires at most once, or keeps watching after it fires."
},
"maxRuns": {
"description": "Maximum deliverable runs recorded for this automation across pauses and resumes. Missed or refused deliveries do not count; recorded runs count even if later canceled, coalesced or failed. Omit for no finite limit beyond repeat=once.",
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"initial": {
"type": "string",
"enum": [
"baseline",
"fire_if_true"
],
"description": "How `rising_edge` treats the first known state: `baseline` records it without firing, `fire_if_true` fires immediately if it is already true."
},
"cooldownSeconds": {
"type": "integer",
"minimum": 0,
"maximum": 2678400,
"description": "The minimum time between firings, in seconds; it does not require the condition to stay true that whole time. For `rising_edge`, a false-to-true edge that lands inside cooldown is discarded, not queued: it is not replayed once cooldown ends, so the rule needs an entirely fresh edge after cooldown lapses before it fires again — simply remaining true past the cooldown boundary does not trigger a firing."
}
},
"required": [
"mode",
"repeat",
"initial",
"cooldownSeconds"
],
"description": "How this rule turns a qualifying evaluation into a firing: which ones count, how often, and how many."
},
"news": {
"description": "Present only on a news exit: the owner's own words, which Fin's news judge reads new stories against. Its rule is fixed: one `news.judged` event wake, no readers, the judged condition and one firing, over a reduce-only perps contract.",
"type": "object",
"properties": {
"condition": {
"type": "string",
"minLength": 3,
"maxLength": 500,
"description": "The owner's condition in their own words, exactly as they said it, such as `right before Anthropic's IPO`. Never paraphrased: the judge reads the news against these words."
},
"match": {
"type": "string",
"minLength": 2,
"maxLength": 80,
"pattern": "^[\\p{L}\\p{N} .'&-]+$",
"description": "A few words every story the judge reads must contain in its headline or summary, such as `Anthropic IPO`: a broad filter, not the condition. The judge decides from the condition."
}
},
"required": [
"condition",
"match"
]
},
"maxSnapshotSkewSeconds": {
"type": "integer",
"minimum": 0,
"maximum": 86400,
"description": "The most that bound readers' observation times may disagree before evaluation reports `snapshot_skew`, in seconds."
}
},
"required": [
"schemaVersion",
"delivery",
"maxDeliveryLatenessSeconds",
"maxEvaluationGapSeconds",
"wakes",
"readers",
"condition",
"firing",
"maxSnapshotSkewSeconds"
],
"description": "One automation's rule: when it wakes, what condition it evaluates, and how it fires."
},
"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"
}
}
]
},
"AutomationMonitoring": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"waiting",
"healthy",
"stale",
"unavailable",
"paused",
"completed"
],
"description": "The automation's overall monitoring status: `waiting` no evaluation yet, `healthy` sources and evaluation are current, `stale` an input is older than expected, `unavailable` a source could not be reached, `paused` firing is paused, `completed` its run policy is spent. A news exit (`rule.news`) reads `healthy` while Fin's news judge checks the news for it and `unavailable` while news checks are paused for its owner."
},
"lastCheckedAt": {
"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 monitoring last checked this automation's sources."
},
"sources": {
"maxItems": 5,
"type": "array",
"items": {
"type": "object",
"properties": {
"binding": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding name a rule or a plan gives one configured source."
},
"sourceId": {
"type": "string",
"description": "The source's id within its provider."
},
"check": {
"description": "The most recent recipe check against this source, when evidence review is configured.",
"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"
]
},
"status": {
"type": "string",
"enum": [
"waiting",
"healthy",
"stale",
"unavailable"
],
"description": "This source's health: `waiting` no observation yet, `healthy` fresh, `stale` older than expected, `unavailable` the provider could not be reached."
},
"sourceTime": {
"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 the provider says the most recent observation was true."
},
"receivedAt": {
"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 the engine received the most recent observation."
},
"reason": {
"description": "Why the source is not healthy, when it is not.",
"type": [
"string",
"null"
]
}
},
"required": [
"binding",
"sourceId",
"status",
"sourceTime",
"receivedAt",
"reason"
]
},
"description": "Each bound source's own health."
},
"lastEvaluation": {
"anyOf": [
{
"type": "object",
"properties": {
"verdict": {
"type": "string",
"enum": [
"true",
"false",
"unknown"
],
"description": "Whether the condition holds: `true` it matches, `false` it does not, `unknown` usable input is missing. Firing policy, delivery, admission, budget and approvals separately decide whether matching can execute."
},
"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 evaluation ran."
},
"reasons": {
"maxItems": 256,
"type": "array",
"items": {
"type": "object",
"properties": {
"nodePath": {
"maxItems": 8,
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"description": "The path to the condition node this reason explains, as indices into the rule tree."
},
"code": {
"type": "string",
"enum": [
"missing_source",
"unavailable",
"gap",
"stale",
"future",
"missing_field",
"invalid_value",
"snapshot_skew"
],
"description": "Why this node could not cleanly resolve: `missing_source` no binding was configured, `unavailable` the provider did not answer, `gap` a break in coverage was recorded, `stale` or `future` a timestamp was out of range, `missing_field` the observation lacked this field, `invalid_value` the value did not match its declared type, `snapshot_skew` the inputs disagreed on when they were true."
},
"binding": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding name a rule or a plan gives one configured source."
}
},
"required": [
"nodePath",
"code"
]
},
"description": "Why the verdict is what it is, one entry per condition node that did not cleanly resolve."
},
"inputs": {
"maxItems": 5,
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"binding": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding name a rule or a plan gives one configured source."
},
"sourceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "The source's id within its provider."
},
"eventId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "The observation or event's id."
},
"receivedAt": {
"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 engine received this observation."
},
"maxAgeSeconds": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "How old this observation was allowed to be at evaluation, in seconds."
},
"status": {
"type": "string",
"enum": [
"ready",
"unavailable",
"gap"
],
"description": "Whether this input was ready to evaluate, the provider was unavailable, or a gap was recorded instead."
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"description": "Why the input is not ready, when it is not."
},
"kind": {
"type": "string",
"const": "snapshot",
"description": "A point-in-time read of current state."
},
"sourceTime": {
"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 provider says this snapshot was true."
}
},
"required": [
"binding",
"sourceId",
"eventId",
"receivedAt",
"maxAgeSeconds",
"status",
"reason",
"kind",
"sourceTime"
]
},
{
"type": "object",
"properties": {
"binding": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$",
"description": "The binding name a rule or a plan gives one configured source."
},
"sourceId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "The source's id within its provider."
},
"eventId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "The observation or event's id."
},
"receivedAt": {
"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 engine received this observation."
},
"maxAgeSeconds": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "How old this observation was allowed to be at evaluation, in seconds."
},
"status": {
"type": "string",
"enum": [
"ready",
"unavailable",
"gap"
],
"description": "Whether this input was ready to evaluate, the provider was unavailable, or a gap was recorded instead."
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"description": "Why the input is not ready, when it is not."
},
"kind": {
"type": "string",
"const": "received_event",
"description": "An event the source pushed, or the engine collected as it happened."
},
"sourceTime": {
"type": "null",
"description": "Not applicable to a received event; see `occurredAt` and `providerPublishedAt` instead."
},
"providerPublishedAt": {
"anyOf": [
{
"type": "string",
"maxLength": 64,
"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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
],
"description": "When the provider says it published this event, when it reports one."
},
"occurredAt": {
"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 the event actually happened, when the provider reports that separately from when it was published."
},
"finalizedAt": {
"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 the provider considers this event no longer subject to correction, when it reports one."
}
},
"required": [
"binding",
"sourceId",
"eventId",
"receivedAt",
"maxAgeSeconds",
"status",
"reason",
"kind",
"sourceTime",
"providerPublishedAt",
"occurredAt",
"finalizedAt"
]
}
]
},
"description": "Each input this evaluation read, without its raw data."
}
},
"required": [
"verdict",
"evaluatedAt",
"reasons",
"inputs"
]
},
{
"type": "null"
}
],
"description": "The rule's most recent evaluation, when it has run at least once."
},
"webhook": {
"anyOf": [
{
"type": "object",
"properties": {
"configured": {
"type": "boolean",
"description": "Whether a webhook secret has been minted."
},
"keyId": {
"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 current webhook secret's id, for rotation."
},
"lastReceivedAt": {
"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 the webhook last received a request."
}
},
"required": [
"configured",
"keyId",
"lastReceivedAt"
]
},
{
"type": "null"
}
],
"description": "This automation's owner webhook, when its rule has one; null for a news exit."
},
"reason": {
"description": "Why status is not healthy, when it is not.",
"type": [
"string",
"null"
]
}
},
"required": [
"status",
"lastCheckedAt",
"sources",
"lastEvaluation",
"webhook",
"reason"
],
"description": "An automation's current health: its sources, its most recent evaluation, and its inbound webhook, if it has one."
},
"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."
},
"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."
},
"PerpsAutomationContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "perps_automation",
"description": "Which authorization contract this is."
},
"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."
},
"position": {
"type": "string",
"enum": [
"long",
"short"
],
"description": "The position the action is for. `open` acts only while the agent holds nothing on this coin; `reduce` and `add_margin` act only while it holds this side, and nothing happens otherwise."
},
"action": {
"$ref": "#/components/schemas/PerpsAutomationAction"
},
"maxExecutions": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "How many firings may act under this approval."
},
"validUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "The deadline after which this approval authorizes nothing."
}
},
"required": [
"type",
"coin",
"asset",
"position",
"action",
"maxExecutions",
"validUntil"
],
"description": "A standing approval for one perps automation: open the agent's own position while it holds nothing on the coin, reduce or close it, or add margin to its own account, each time its rule fires, up to its limits."
},
"PerpsAutomationAction": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "reduce",
"description": "Reduce or close the position."
},
"fractionBps": {
"type": "integer",
"minimum": 1,
"maximum": 10000,
"description": "How much of the position to close, in basis points: 10000 closes it all."
},
"maxSlippageBps": {
"type": "integer",
"minimum": 1,
"maximum": 500,
"description": "The worst fill allowed, in basis points from the mark when it fires."
}
},
"required": [
"kind",
"fractionBps",
"maxSlippageBps"
],
"description": "Close part or all of the position with a reduce-only market order."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "add_margin",
"description": "Add margin to the perps account."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "Exact USDC moved from the agent wallet into the perps account, six decimals: 5 USDC is \"5000000\"."
},
"maxValueLossBps": {
"type": "integer",
"minimum": 0,
"maximum": 300,
"description": "Maximum value lost to fees moving it, in basis points."
}
},
"required": [
"kind",
"amountRaw",
"maxValueLossBps"
],
"description": "Fund the agent's own perps account from its agent wallet."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "open",
"description": "Open the position at market."
},
"notionalUsd": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,6})(\\.[0-9]{1,2})?$",
"description": "The position's size in US dollars at the mark when it fires, at most two places: a $200 position is \"200\". The size in the coin is this over the mark, rounded down to the market's size precision."
},
"leverage": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Leverage the user chose for this market, at most the market's maximum. Never assume it: ask the user."
},
"marginMode": {
"type": "string",
"enum": [
"cross",
"isolated"
],
"description": "How the position is margined, which the user chose with the leverage: `cross` shares the account's margin, `isolated` risks only this position's own. An isolated-only market takes `isolated`. Never assume it: ask the user."
},
"maxSlippageBps": {
"type": "integer",
"minimum": 1,
"maximum": 500,
"description": "The worst fill allowed, in basis points from the mark when it fires; the take-profit and stop-loss fill within the same bound of their trigger."
},
"takeProfitPercent": {
"anyOf": [
{
"type": "string",
"pattern": "^(0|[1-9][0-9]?)(\\.[0-9]{0,3}[1-9])?$"
},
{
"type": "null"
}
],
"description": "A native take-profit this far from the mark when it opens, in percent of price in the position's favour (\"10\" is 10%), or null for none."
},
"stopLossPercent": {
"anyOf": [
{
"type": "string",
"pattern": "^(0|[1-9][0-9]?)(\\.[0-9]{0,3}[1-9])?$"
},
{
"type": "null"
}
],
"description": "A native stop-loss this far from the mark when it opens, in percent of price against the position (\"5\" is 5%), or null for none."
}
},
"required": [
"kind",
"notionalUsd",
"leverage",
"marginMode",
"maxSlippageBps",
"takeProfitPercent",
"stopLossPercent"
],
"description": "Open the position with a market order, only while the agent holds nothing on this coin, optionally protected by a native take-profit and stop-loss."
}
],
"description": "What a perps automation does each time its rule fires: open the named position while the agent holds nothing on its coin, reduce the named position, or add margin to the agent's own perps account."
},
"PredictionAutomationContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "prediction_automation",
"description": "Which authorization contract this is."
},
"market": {
"type": "object",
"properties": {
"marketId": {
"type": "string",
"pattern": "^[1-9][0-9]{0,19}$",
"description": "The market's id exactly as prediction_market returns it."
},
"conditionId": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{64}$",
"description": "The market's conditionId exactly as prediction_market returns it."
},
"assetId": {
"type": "string",
"pattern": "^[1-9][0-9]{0,77}$",
"description": "The outcome's CLOB token id, exactly the assetId prediction_market lists for that outcome. Yes and No are different tokens."
},
"marketQuestion": {
"type": "string",
"minLength": 1,
"maxLength": 1000,
"description": "The market's question exactly as prediction_market returns it."
},
"outcome": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The outcome's name exactly as prediction_market returns it."
}
},
"required": [
"marketId",
"conditionId",
"assetId",
"marketQuestion",
"outcome"
],
"description": "The one Polymarket outcome this automation trades."
},
"action": {
"$ref": "#/components/schemas/PredictionAutomationAction"
},
"maxExecutions": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "How many firings may trade under this approval; a buy spends at most maxExecutions × amountUsdDecimal in all."
},
"validUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "The deadline after which this approval authorizes nothing."
}
},
"required": [
"type",
"market",
"action",
"maxExecutions",
"validUntil"
],
"description": "A standing approval for one Polymarket automation: buy one outcome with a USD budget at no more than a maximum price, or sell a share of the agent's holding of it at no less than a minimum price, each time its rule fires, up to its limits."
},
"PredictionAutomationAction": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "buy",
"description": "Buy shares of the outcome."
},
"amountUsdDecimal": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,6})(\\.[0-9]{1,2})?$",
"description": "The USD each firing spends before fees, to the cent: \"50\" is $50. Each buy is an immediate order that fills what it can at once and cancels the rest."
},
"maxPriceUsdDecimal": {
"type": "string",
"pattern": "^0\\.[0-9]{1,4}$",
"description": "The most a share may cost, as the market's chance: \"0.32\" never pays more than 32¢ a share. Use a price on the market's tick."
},
"maxFeeUsdDecimal": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,6})(\\.[0-9]{1,6})?$",
"description": "The most each firing may pay Polymarket in fees, in USD: \"1\" is $1."
}
},
"required": [
"kind",
"amountUsdDecimal",
"maxPriceUsdDecimal",
"maxFeeUsdDecimal"
],
"description": "Buy the outcome with a USD budget at no more than a maximum price."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "sell",
"description": "Sell shares of the outcome."
},
"fractionBps": {
"type": "integer",
"minimum": 1,
"maximum": 10000,
"description": "How much of the agent's holding of the outcome each firing sells, in basis points: 10000 sells it all."
},
"minPriceUsdDecimal": {
"type": "string",
"pattern": "^0\\.[0-9]{1,4}$",
"description": "The least a share may sell for, as the market's chance: \"0.7\" never sells below 70¢ a share. Use a price on the market's tick."
},
"maxFeeUsdDecimal": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,6})(\\.[0-9]{1,6})?$",
"description": "The most each firing may pay Polymarket in fees, in USD: \"1\" is $1."
}
},
"required": [
"kind",
"fractionBps",
"minPriceUsdDecimal",
"maxFeeUsdDecimal"
],
"description": "Sell a share of the agent's holding of the outcome at no less than a minimum price."
}
],
"description": "What a Polymarket automation does each time its rule fires: buy the outcome with a USD budget at no more than a maximum price, or sell a share of the agent's holding of it at no less than a minimum price."
},
"SolanaBuyContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "solana_buy",
"description": "Which authorization contract this is."
},
"buy": {
"description": "The exact approved token, payment, all-in loss bound and SOL top-up cap, and, for a buy whose funding pays with a coin, that coin and the most of it it may spend.",
"$ref": "#/components/schemas/SolanaBuyInput"
},
"maxExecutions": {
"type": "integer",
"minimum": 1,
"maximum": 1000,
"description": "How many times this grant may execute: 1 for a one-shot approval."
},
"validUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When this grant's authority expires; for a one-shot approval, the approval's own expiry."
}
},
"required": [
"type",
"buy",
"maxExecutions",
"validUntil"
],
"description": "An approved Solana buy, executed only exactly as approved."
},
"SolanaSellContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "solana_sell",
"description": "Which authorization contract this is."
},
"sell": {
"description": "The exact approved token, amount, proceeds and all-in loss bound.",
"$ref": "#/components/schemas/SolanaSellInput"
},
"maxExecutions": {
"type": "integer",
"minimum": 1,
"maximum": 1000,
"description": "How many times this grant may execute: 1 for a one-shot approval."
},
"validUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When this grant's authority expires; for a one-shot approval, the approval's own expiry."
}
},
"required": [
"type",
"sell",
"maxExecutions",
"validUntil"
],
"description": "An approved Solana sell, executed only exactly as approved."
},
"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"
}
}
}
},
"PayloadTooLarge": {
"description": "The body exceeds the size this deployment accepts.",
"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."
}
}
}
}