List a conversation's events
Returns a conversation's saved events, oldest first: messages, runs, approvals and trade updates. Use it to load history or catch up after being offline; pass nextCursor back as cursor to continue. For live updates use Stream a conversation's events.
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}$"
conversationIdstring · uuidrequiredThe 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)$"
Query parameters
cursorstringoptionalAn after cursor from the previous page; omit to read from the beginning.
Validation rules
- Maximum length
256
limitintegeroptionalHow many events to answer, at most 1000
Validation rules
- Default
500- Minimum
1- Maximum
1000
Request example
Illustrative request. Replace the host, credentials and resource IDs with your own. If a request file is shown, create it from the schema above. Review the requested action before sending it.
curl --request GET 'https://api.example.test/v1/users/YOUR_USER_ID/conversations/YOUR_CONVERSATION_ID/events' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Authorization: Bearer YOUR_USER_TOKEN'
Responses
200 A page of the conversation's saved events.
A page of the conversation's saved events.
application/json · object
dataarrayrequiredThis page's events, oldest first.
Show attributes
This page's events, oldest first.
Array items · oneOf
One journal entry: the event type and its payload, in the order it happened.
oneOf · 26 variants
Variant 1 · type: run.started
Opens a new run: the engine admitted it and is about to process the input, whether an ordinary turn or an automation firing. Emitted once, at admission — a run resumed after an approval does not get a second one. run.ended closes what this event opened.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a run.started event.
Validation rules
- Exact value
"run.started"
payloadobjectrequiredThe run.started event's own fields.
Show attributes
The run.started event's own fields.
inputstringrequiredThe user's message, or the automation's triggering text, that this run processes.
originobjectoptionalWhich automation triggered this run; absent for an ordinary user turn.
Show attributes
Which automation triggered this run; absent for an ordinary user turn.
automationIdstringrequiredThe automation that started this run.
namestringrequiredThe automation's name at the time it started this run.
runIdstring · uuidrequiredThe run this event opened, so a client following the stream can name it (to stop it).
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 · type: run.ended
The root run reached a terminal state: completed, failed or aborted. Its runId is the same as run.started and every pause/resume. Waiting for approval emits run.paused instead. Accounting includes all continuation segments.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a run.ended event.
Validation rules
- Exact value
"run.ended"
payloadobjectrequiredThe run.ended event's own fields.
Show attributes
The run.ended event's own fields.
runIdstring · uuidrequiredThe admitted root run that reached its terminal state.
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)$"
statusstringrequiredThe terminal result of the root run; approval waits do not end it.
Validation rules
- Allowed values
["completed","aborted","failed"]
usageobjectoptionalToken counts and cost for this run, once its accounting settles.
Show attributes
Token counts and cost for this run, once its accounting settles.
inputTokensnumberrequiredHow many input tokens the run consumed.
outputTokensnumberrequiredHow many output tokens the run produced.
costCentsstringrequiredThe run's cost, in whole USD cents.
Validation rules
- Pattern
"^(0|[1-9]\\d*)$"
costUncertainbooleanrequiredTrue when the exact provider cost could not be confirmed and costCents is a best-effort estimate.
errorstringoptionalThe run's failure message, present when status is failed.
failureobjectoptionalStructured cause of a failed run: its code, stage and optional provider detail. Present when status is failed; absent on runs that failed before this field existed.
Show attributes
Structured cause of a failed run: its code, stage and optional provider detail. Present when status is failed; absent on runs that failed before this field existed.
codestringrequiredWhy the execution failed: model_timeout (the model was too slow to respond), execution_deadline (the run's active time limit elapsed before it finished), provider_rate_limit or provider_unavailable (classified from HTTP status or a connection/body-read failure observed by the host), model_invalid_output (terminal structured output still failed its required format after bounded repair), context_too_large (the request stayed over the model's context window after the host condensed earlier history and retried once), daily_budget_exhausted, monthly_budget_exhausted or budget_frozen (the user's AI budget for the UTC day or month, or an operator's freeze on it, left no room for the run's next model request), partner_daily_budget_exhausted or partner_monthly_budget_exhausted (the partner account's AI spend limit for the UTC day or month left no room for it), internal_error (a host-side fault), or unknown when nothing more specific was classified. A budget or spend-limit code means a limit stopped the run, not that the model failed; trying again fails the same way until the limit clears. A raised user budget or a lifted freeze applies at once; a raised partner limit applies from the next UTC day or month, because the open period keeps the cap it started with.
Validation rules
- Allowed values
["model_timeout","model_invalid_output","execution_deadline","provider_rate_limit","provider_unavailable","provider_authentication","internal_error","context_too_large","daily_budget_exhausted","monthly_budget_exhausted","budget_frozen","partner_daily_budget_exhausted","partner_monthly_budget_exhausted","unknown"]
stagestringrequiredWhich phase of the run was executing when it failed: model_request while calling or awaiting the model provider, tool_execution while running or resuming a tool call, or finalization while settling the run's output and accounting after the model finished.
Validation rules
- Allowed values
["model_request","tool_execution","finalization"]
providerMessagestringoptionalThe model provider's own error text, when one was available: credential values are redacted and it is cut to 256 characters, but it is not a content classifier, so other sensitive detail may remain. Treat it as diagnostic context only — never branch on it, and review before showing it to an end user.
Validation rules
- Minimum length
1- Maximum length
256
diagnosticReferencestring · uuidrequiredThis failed run's own id, repeated here as one field to cite when asking support to check the host's internal logs for this execution; it carries no meaning beyond that.
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 3 · type: run.paused
The run is waiting for human input or approval. Its identity and original request remain unchanged.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a run.paused event.
Validation rules
- Exact value
"run.paused"
payloadobjectrequiredThe run is waiting for approval; it has not finished.
Show attributes
The run is waiting for approval; it has not finished.
runIdstring · uuidrequiredThe admitted root run, retained across approval waits and continuations.
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 4 · type: run.resumed
An approval decision resumed the same root run. No new instruction or run identity was created.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a run.resumed event.
Validation rules
- Exact value
"run.resumed"
payloadobjectrequiredThe paused run has resumed after an approval decision.
Show attributes
The paused run has resumed after an approval decision.
runIdstring · uuidrequiredThe same root run that paused.
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 5 · type: run.steered
The agent read a message the user sent while the run was working (Steer a run). Emitted at the agent's next step, before its next reply, so it lands in the conversation where the agent saw it; steerId matches the run's steers entry. Several messages sent within one step each get their own event, in the order sent. The same run continues; a message the run ended before reading never gets one.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a run.steered event.
Validation rules
- Exact value
"run.steered"
payloadobjectrequiredThe run.steered event's own fields.
Show attributes
The run.steered event's own fields.
runIdstring · uuidrequiredThe run the message was sent to; it keeps working.
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)$"
steerIdstring · uuidrequiredThe message's id, as the run's steers entry names it.
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)$"
textstringrequiredThe user's message, as they sent it.
Variant 6 · type: agent.entry
One durable message in the conversation: the user's message, the assistant's completed reply, or a tool's display text once it resolves. Streaming assistant text arrives first as agent.text_delta and lands here only when the turn completes.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as an agent.entry event.
Validation rules
- Exact value
"agent.entry"
payloadobjectrequiredThe agent.entry event's own fields.
Show attributes
The agent.entry event's own fields.
rolestringrequiredWho this message is from: user, assistant, or tool for a tool's own display text.
Validation rules
- Allowed values
["user","assistant","tool"]
textstringrequiredThe message's display text.
interruptedbooleanoptionalPresent on an assistant draft whose model response did not complete. Preserve it as interrupted even if the run later recovers and completes.
Validation rules
- Exact value
true
toolobjectoptionalWhich tool this entry displays the result of; present only when role is tool.
Show attributes
Which tool this entry displays the result of; present only when role is tool.
namestringrequiredThe tool's public name.
outcomeoneOfrequiredThe call's outcome: completed, denied, parked for approval or input, or failed.
Show attributes
The call's outcome: completed, denied, parked for approval or input, or failed.
oneOf · 5 variants
Variant 1 · status: completed
statusstringrequiredThe tool ran and returned a result.
Validation rules
- Exact value
"completed"
resultanyrequiredThe tool's own result value.
financialFailuresobjectoptionalBounded financial failure display evidence. The tool result and spending authority are unchanged.
Show attributes
Bounded financial failure display evidence. The tool result and spending authority are unchanged.
nodeFailuresarrayoptionalShow attributes
Validation rules
- Minimum items
1- Maximum items
16
Array items · object
indexintegerrequiredValidation rules
- Minimum
0- Maximum
15
reasonstringrequiredValidation 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"]
categorystringrequiredValidation rules
- Allowed values
["price_limit","insufficient_funds","unavailable","integrity","dependency","expired","authority","conflict","stopped","request_blocked","unknown"]
diagnosticobjectoptionalShow attributes
rulestringrequiredValidation rules
- Allowed values
["quote_floor","quote_ceiling"]
classificationstringrequiredValidation rules
- Exact value
"terms"
expectedAtomicstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
observedAtomicstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
inputTokenIdstringrequiredThe exact ledger asset identifier, including its token standard namespace.
Validation rules
- Maximum length
256- Pattern
"^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$"
outputTokenIdstringrequiredThe exact ledger asset identifier, including its token standard namespace.
Validation rules
- Maximum length
256- Pattern
"^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$"
preflightFailureobjectoptionalShow attributes
reasonstringrequiredValidation 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"]
indexintegeroptionalValidation rules
- Minimum
0- Maximum
15
diagnosticobjectoptionalShow attributes
rulestringrequiredValidation rules
- Allowed values
["quote_floor","quote_ceiling"]
classificationstringrequiredValidation rules
- Exact value
"terms"
expectedAtomicstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
observedAtomicstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
inputTokenIdstringrequiredThe exact ledger asset identifier, including its token standard namespace.
Validation rules
- Maximum length
256- Pattern
"^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$"
outputTokenIdstringrequiredThe exact ledger asset identifier, including its token standard namespace.
Validation rules
- Maximum length
256- Pattern
"^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$"
recoverablearrayoptionalShow attributes
Validation rules
- Maximum items
16
Array items · object
indexintegerrequiredValidation rules
- Minimum
0- Maximum
15
kindstringrequiredValidation rules
- Allowed values
["unclaimed","refunded","not_executed"]
recoveryanyOfoptionalRoot operations omit this. A recovery child carries a proved original-action map, or null when no safe map is available; null disables recovery controls.
Show attributes
Root operations omit this. A recovery child carries a proved original-action map, or null when no safe map is available; null disables recovery controls.
anyOf · 2 variants
Variant 1 · object
operationIdstring · uuidrequiredValidation 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)$"
originalIndicesarrayrequiredShow attributes
Validation rules
- Minimum items
1- Maximum items
16
Array items · integer
Validation rules
- Minimum
0- Maximum
15
maxValueLossBpsstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 2 · null
providerRefstringoptionalThe upstream provider's own reference, when it returned one.
Variant 2 · status: denied
statusstringrequiredThe call was refused before it ran.
Validation rules
- Exact value
"denied"
errorobjectrequiredWhy the call was denied.
Show attributes
Why the call was denied.
codestringrequiredWhy the tool call did not produce a result: denied by policy or the user, egress_denied for a network destination the tool cannot reach, invalid_input for arguments the tool rejected, or execution_failed for a fault while it ran.
Validation rules
- Allowed values
["denied","egress_denied","invalid_input","execution_failed"]
messagestringrequiredA human-readable explanation of the failure.
hintstringoptionalA suggestion for what to try instead, when there is one.
recoverystringoptionalWho can fix the failure: wait when the same request may succeed later without anyone acting and nothing was signed or sent, owner when it fails the same way until the owner acts (the remedy says how), or none when this attempt cannot succeed and neither waiting nor the owner changes that, though a later run may. A failure that names no class is none.
Validation rules
- Allowed values
["wait","owner","none"]
remedystringoptionalWhat the owner does about an owner failure: add_funds of the asset the action spends or sells, or edit_automation to change its terms.
Validation rules
- Allowed values
["add_funds","edit_automation"]
retryAfterSecondsintegeroptionalFor a wait failure, how long the failing service asked to wait before the same request is repeated, in whole seconds.
Validation rules
- Minimum
1- Maximum
86400
referencestringoptionalCorrelation for diagnosis: the request id, or the workflow id of background work. Never a cause.
Validation rules
- Maximum length
128
Variant 3 · status: pending_approval
statusstringrequiredThe call is parked, waiting on a human decision.
Validation rules
- Exact value
"pending_approval"
approvalIdstring · uuidrequiredThe approval'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)$"
summarystringrequiredA short human-readable summary of what approving this would do.
Variant 4 · status: failed
statusstringrequiredThe call ran but did not complete successfully.
Validation rules
- Exact value
"failed"
errorobjectrequiredWhy the call failed.
Show attributes
Why the call failed.
codestringrequiredWhy the tool call did not produce a result: denied by policy or the user, egress_denied for a network destination the tool cannot reach, invalid_input for arguments the tool rejected, or execution_failed for a fault while it ran.
Validation rules
- Allowed values
["denied","egress_denied","invalid_input","execution_failed"]
messagestringrequiredA human-readable explanation of the failure.
hintstringoptionalA suggestion for what to try instead, when there is one.
recoverystringoptionalWho can fix the failure: wait when the same request may succeed later without anyone acting and nothing was signed or sent, owner when it fails the same way until the owner acts (the remedy says how), or none when this attempt cannot succeed and neither waiting nor the owner changes that, though a later run may. A failure that names no class is none.
Validation rules
- Allowed values
["wait","owner","none"]
remedystringoptionalWhat the owner does about an owner failure: add_funds of the asset the action spends or sells, or edit_automation to change its terms.
Validation rules
- Allowed values
["add_funds","edit_automation"]
retryAfterSecondsintegeroptionalFor a wait failure, how long the failing service asked to wait before the same request is repeated, in whole seconds.
Validation rules
- Minimum
1- Maximum
86400
referencestringoptionalCorrelation for diagnosis: the request id, or the workflow id of background work. Never a cause.
Validation rules
- Maximum length
128
Variant 5 · status: pending_input
statusstringrequiredThe call is paused for a human questionnaire response.
Validation rules
- Exact value
"pending_input"
questionIdstring · uuidrequiredThe questionnaire the user needs to answer.
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)$"
expiresAtstring · date-timerequiredWhen the questionnaire expires if it remains unanswered.
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 7 · type: agent.text_delta
A chunk of the assistant's reply while it is still generating. Delivered live only — never written to the durable journal or replayed on reconnect — and superseded by the complete text in the agent.entry that follows.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as an agent.text_delta event.
Validation rules
- Exact value
"agent.text_delta"
payloadobjectrequiredThe agent.text_delta event's own fields.
Show attributes
The agent.text_delta event's own fields.
textstringrequiredThe chunk of assistant reply text this delta adds.
Variant 8 · type: tool.call
The assistant asked to call a tool. Emitted once the call is committed to the conversation, before it runs; approval.opened follows if a human must decide first, otherwise the call proceeds straight to tool.result.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a tool.call event.
Validation rules
- Exact value
"tool.call"
payloadobjectrequiredThe tool.call event's own fields.
Show attributes
The tool.call event's own fields.
callIdstringoptionalThis call's id, so later events (approval.opened, tool.result) can be matched to it.
toolstringrequiredThe tool's public name.
inputanyrequiredThe call's arguments, scrubbed for public display.
batchobjectoptionalThe calls the agent asked for together in one step. They arrive together in index order, and the agent reads every result before its next step, so you can draw them as one group. A call asked for alone has size 1. Absent on calls made before this field existed.
Show attributes
The calls the agent asked for together in one step. They arrive together in index order, and the agent reads every result before its next step, so you can draw them as one group. A call asked for alone has size 1. Absent on calls made before this field existed.
indexintegerrequiredThis call's place among them, from 0.
Validation rules
- Minimum
0- Maximum
63
sizeintegerrequiredHow many calls the agent asked for together, this one included.
Validation rules
- Minimum
1- Maximum
64
originstringoptionalWritten by the retired standalone CLI door; kept so its journals still parse.
Validation rules
- Exact value
"cli"
Variant 9 · type: tool.result
One tool call resolved: outcome says what happened (completed, denied, parked for approval, or failed). Immediately followed by an agent.entry (role tool) carrying that outcome's own display text.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a tool.result event.
Validation rules
- Exact value
"tool.result"
payloadobjectrequiredThe tool.result event's own fields.
Show attributes
The tool.result event's own fields.
callIdstringoptionalThis call's id, matching the tool.call it resolves.
callSeqintegeroptionalWith origin, the retired CLI door's way of pairing a result to its call; historical only.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
toolstringrequiredThe tool's public name.
outcomeoneOfrequiredThe call's outcome: completed, denied, parked for approval or input, or failed.
Show attributes
The call's outcome: completed, denied, parked for approval or input, or failed.
oneOf · 5 variants
Variant 1 · status: completed
statusstringrequiredThe tool ran and returned a result.
Validation rules
- Exact value
"completed"
resultanyrequiredThe tool's own result value.
financialFailuresobjectoptionalBounded financial failure display evidence. The tool result and spending authority are unchanged.
Show attributes
Bounded financial failure display evidence. The tool result and spending authority are unchanged.
nodeFailuresarrayoptionalShow attributes
Validation rules
- Minimum items
1- Maximum items
16
Array items · object
indexintegerrequiredValidation rules
- Minimum
0- Maximum
15
reasonstringrequiredValidation 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"]
categorystringrequiredValidation rules
- Allowed values
["price_limit","insufficient_funds","unavailable","integrity","dependency","expired","authority","conflict","stopped","request_blocked","unknown"]
diagnosticobjectoptionalShow attributes
rulestringrequiredValidation rules
- Allowed values
["quote_floor","quote_ceiling"]
classificationstringrequiredValidation rules
- Exact value
"terms"
expectedAtomicstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
observedAtomicstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
inputTokenIdstringrequiredThe exact ledger asset identifier, including its token standard namespace.
Validation rules
- Maximum length
256- Pattern
"^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$"
outputTokenIdstringrequiredThe exact ledger asset identifier, including its token standard namespace.
Validation rules
- Maximum length
256- Pattern
"^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$"
preflightFailureobjectoptionalShow attributes
reasonstringrequiredValidation 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"]
indexintegeroptionalValidation rules
- Minimum
0- Maximum
15
diagnosticobjectoptionalShow attributes
rulestringrequiredValidation rules
- Allowed values
["quote_floor","quote_ceiling"]
classificationstringrequiredValidation rules
- Exact value
"terms"
expectedAtomicstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
observedAtomicstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
inputTokenIdstringrequiredThe exact ledger asset identifier, including its token standard namespace.
Validation rules
- Maximum length
256- Pattern
"^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$"
outputTokenIdstringrequiredThe exact ledger asset identifier, including its token standard namespace.
Validation rules
- Maximum length
256- Pattern
"^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$"
recoverablearrayoptionalShow attributes
Validation rules
- Maximum items
16
Array items · object
indexintegerrequiredValidation rules
- Minimum
0- Maximum
15
kindstringrequiredValidation rules
- Allowed values
["unclaimed","refunded","not_executed"]
recoveryanyOfoptionalRoot operations omit this. A recovery child carries a proved original-action map, or null when no safe map is available; null disables recovery controls.
Show attributes
Root operations omit this. A recovery child carries a proved original-action map, or null when no safe map is available; null disables recovery controls.
anyOf · 2 variants
Variant 1 · object
operationIdstring · uuidrequiredValidation 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)$"
originalIndicesarrayrequiredShow attributes
Validation rules
- Minimum items
1- Maximum items
16
Array items · integer
Validation rules
- Minimum
0- Maximum
15
maxValueLossBpsstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
Variant 2 · null
providerRefstringoptionalThe upstream provider's own reference, when it returned one.
Variant 2 · status: denied
statusstringrequiredThe call was refused before it ran.
Validation rules
- Exact value
"denied"
errorobjectrequiredWhy the call was denied.
Show attributes
Why the call was denied.
codestringrequiredWhy the tool call did not produce a result: denied by policy or the user, egress_denied for a network destination the tool cannot reach, invalid_input for arguments the tool rejected, or execution_failed for a fault while it ran.
Validation rules
- Allowed values
["denied","egress_denied","invalid_input","execution_failed"]
messagestringrequiredA human-readable explanation of the failure.
hintstringoptionalA suggestion for what to try instead, when there is one.
recoverystringoptionalWho can fix the failure: wait when the same request may succeed later without anyone acting and nothing was signed or sent, owner when it fails the same way until the owner acts (the remedy says how), or none when this attempt cannot succeed and neither waiting nor the owner changes that, though a later run may. A failure that names no class is none.
Validation rules
- Allowed values
["wait","owner","none"]
remedystringoptionalWhat the owner does about an owner failure: add_funds of the asset the action spends or sells, or edit_automation to change its terms.
Validation rules
- Allowed values
["add_funds","edit_automation"]
retryAfterSecondsintegeroptionalFor a wait failure, how long the failing service asked to wait before the same request is repeated, in whole seconds.
Validation rules
- Minimum
1- Maximum
86400
referencestringoptionalCorrelation for diagnosis: the request id, or the workflow id of background work. Never a cause.
Validation rules
- Maximum length
128
Variant 3 · status: pending_approval
statusstringrequiredThe call is parked, waiting on a human decision.
Validation rules
- Exact value
"pending_approval"
approvalIdstring · uuidrequiredThe approval'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)$"
summarystringrequiredA short human-readable summary of what approving this would do.
Variant 4 · status: failed
statusstringrequiredThe call ran but did not complete successfully.
Validation rules
- Exact value
"failed"
errorobjectrequiredWhy the call failed.
Show attributes
Why the call failed.
codestringrequiredWhy the tool call did not produce a result: denied by policy or the user, egress_denied for a network destination the tool cannot reach, invalid_input for arguments the tool rejected, or execution_failed for a fault while it ran.
Validation rules
- Allowed values
["denied","egress_denied","invalid_input","execution_failed"]
messagestringrequiredA human-readable explanation of the failure.
hintstringoptionalA suggestion for what to try instead, when there is one.
recoverystringoptionalWho can fix the failure: wait when the same request may succeed later without anyone acting and nothing was signed or sent, owner when it fails the same way until the owner acts (the remedy says how), or none when this attempt cannot succeed and neither waiting nor the owner changes that, though a later run may. A failure that names no class is none.
Validation rules
- Allowed values
["wait","owner","none"]
remedystringoptionalWhat the owner does about an owner failure: add_funds of the asset the action spends or sells, or edit_automation to change its terms.
Validation rules
- Allowed values
["add_funds","edit_automation"]
retryAfterSecondsintegeroptionalFor a wait failure, how long the failing service asked to wait before the same request is repeated, in whole seconds.
Validation rules
- Minimum
1- Maximum
86400
referencestringoptionalCorrelation for diagnosis: the request id, or the workflow id of background work. Never a cause.
Validation rules
- Maximum length
128
Variant 5 · status: pending_input
statusstringrequiredThe call is paused for a human questionnaire response.
Validation rules
- Exact value
"pending_input"
questionIdstring · uuidrequiredThe questionnaire the user needs to answer.
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)$"
expiresAtstring · date-timerequiredWhen the questionnaire expires if it remains unanswered.
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))$"
originstringoptionalWritten by the retired standalone CLI door; kept so its journals still parse.
Validation rules
- Exact value
"cli"
Variant 10 · type: approval.opened
A tool call is parked, waiting on a human decision. Carries the terms the approval card renders: the call's input, a summary, and the authorization contract in effect, if any. approval.decided or approval.expired closes it.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as an approval.opened event.
Validation rules
- Exact value
"approval.opened"
payloadobjectrequiredThe approval.opened event's own fields.
Show attributes
The approval.opened event's own fields.
approvalIdstring · uuidrequiredThe approval'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)$"
callIdstringoptionalThe tool call this approval parks; absent for direct operations without a model call.
toolstringrequiredThe tool name awaiting approval.
inputanyrequiredThe call's arguments, as shown on the approval card.
summarystringrequiredA short human-readable summary of what approving this would do.
contractoneOfoptionalEffective terms rendered before approval; absent for tools without authorization contracts.
Show attributes
Effective terms rendered before approval; absent for tools without authorization contracts.
oneOf · 20 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: limit_order
Owner-signed authority for one resting limit order: the exact approved placement, created and funded once by the policy worker before the approval expires.
typestringrequiredWhich contract template this is.
Validation rules
- Exact value
"limit_order"
orderobjectrequiredThe exact approved placement request.
Show attributes
The exact approved placement request.
inputobjectrequiredThe input (base) asset this order sells.
Show attributes
The input (base) asset this order sells.
pinnedobjectrequiredThe exact asset the order sells: token id and decimals.
Show attributes
The exact asset the order sells: token id and decimals.
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
outputobjectrequiredThe output (quote) asset this order buys.
Show attributes
The output (quote) asset this order buys.
pinnedobjectrequiredThe exact asset the order buys: token id and decimals.
Show attributes
The exact asset the order buys: token id and decimals.
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
quantitystringrequiredThe exact input amount to sell, in the input asset's smallest unit. 1 NEAR with verified decimals 24 is "1000000000000000000000000". Scale decimal digits with the verified decimals and reject excess fractional digits; no floating-point arithmetic or bash.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
limitPricestringrequiredThe minimum price the fill must reach, as output-asset units per ONE input unit, written as a plain human decimal: "5" means at least 5 output tokens per 1 input token. Never scale it by decimals.
Validation rules
- Maximum length
80- Pattern
"^(0|[1-9]\\d{0,38})(\\.\\d{1,38})?$"
expiresInHoursintegerrequiredHow long the order may rest before it expires, in whole hours. Use the user's duration within this wallet's maximum, or the wallet's default from the latest request's host context when none is given. The schema permits up to 720 hours (30 days); a wallet may have a lower maximum. Never shorten a requested duration to fit.
Validation rules
- Minimum
1- Maximum
720
validUntilstring · date-timerequiredThe latest instant the order may be created and funded under this consent.
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: perps_transfer
One approved perps transfer in exactly the named direction.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"perps_transfer"
directionstringrequiredFund the own perps account from the agent wallet, or withdraw back to the same agent wallet.
Validation rules
- Allowed values
["fund","withdraw"]
transferobjectrequiredThe exact approved amount and all-in loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.
Show attributes
The exact approved amount and all-in loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.
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})$"
validUntilstring · date-timerequiredThe deadline after which this one-shot 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 · type: perps_order
One approved Hyperliquid order, signed once exactly as approved.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"perps_order"
orderobjectrequiredThe exact approved order.
Show attributes
The exact approved order.
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
validUntilstring · date-timerequiredThe deadline after which this one-shot 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 5 · type: perps_cancel
One approved cancellation of one resting Hyperliquid order.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"perps_cancel"
cancelobjectrequiredThe exact order approved for cancelling.
Show attributes
The exact order approved for cancelling.
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
oidintegerrequiredThe resting order's id exactly as perps_orders lists it.
Validation rules
- Greater than
0- Maximum
9007199254740991
validUntilstring · date-timerequiredThe deadline after which this one-shot 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 6 · 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 7 · type: perps_margin
One approved change to one isolated position's margin, signed once exactly as approved.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"perps_margin"
marginobjectrequiredThe exact approved margin change.
Show attributes
The exact approved margin change.
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
changestringrequiredadd moves USDC from the account into the position's isolated margin, lowering its liquidation risk; remove takes it back out, raising that risk. A strict isolated market never lets margin be removed while the position is open.
Validation rules
- Allowed values
["add","remove"]
amountstringrequiredExact USDC to move, at most six decimal places, such as 25 or 12.5.
Validation rules
- Pattern
"^(0|[1-9][0-9]{0,8})(\\.[0-9]{0,5}[1-9])?$"
validUntilstring · date-timerequiredThe deadline after which this one-shot 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 8 · type: prediction_fund
One exact USDC or USDT debit delivered as native Base USDC to Polymarket's bridge for the agent's own account; the final pUSD amount is not bounded.
typestringrequiredOne approved Polymarket funding transfer.
Validation rules
- Exact value
"prediction_fund"
transferobjectrequiredThe exact approved USDC or USDT debit and the first leg's loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.
Show attributes
The exact approved USDC or USDT debit and the first leg's loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.
amountRawstringrequiredExact debit in six-decimal atomic units: 5 USDC or USDT is "5000000", spent 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. The host resolves the agent’s own Polymarket Deposit Wallet and its bridge address; never supply an address.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
maxFirstLegLossBpsintegerrequiredExplicit maximum loss, in basis points, of the first leg only: the wallet's USDC, USDT or coin delivered as native Base USDC to Polymarket's bridge, fees and any cross-chain hop included. It does not bound the bridge's conversion to pUSD on Polygon, whose fees and output are variable and estimated. Required; no default.
Validation rules
- Minimum
0- Maximum
300
payWithobjectoptionalApproved in chat as one call or as a funded order's funding: the coin the first leg pays with instead of a USDC or USDT holding, and the most of it it may spend.
Show attributes
Approved in chat as one call or as a funded order's funding: the coin the first leg pays with instead of a USDC or USDT holding, and the most of it it may spend.
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})$"
validUntilstring · date-timerequiredThe deadline after which this one-shot 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 9 · 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 10 · 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))$"
Variant 11 · type: solana_fund
An approved move of USDC or USDT, or a coin, into the agent's own Solana account.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"solana_fund"
fundobjectrequiredThe exact approved amount and loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.
Show attributes
The exact approved amount and loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.
amountRawstringrequiredExact USDC or USDT to move from the agent wallet into the agent's Solana account as SOL, in six-decimal atomic units: 5 USDC is "5000000". Spent 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.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
maxValueLossBpsintegerrequiredExplicit maximum value loss in basis points, including provider fees: at most 300. Required; no default.
Validation rules
- Minimum
0- Maximum
300
payWithobjectoptionalApproved in chat as one call: the coin this funding pays with instead of a USDC or USDT holding, and the most of it it may spend. Never SOL.
Show attributes
Approved in chat as one call: the coin this funding pays with instead of a USDC or USDT holding, and the most of it it may spend. Never SOL.
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 12 · type: solana_withdraw
An approved move of SOL from the agent's own Solana account back to its agent wallet.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"solana_withdraw"
withdrawobjectrequiredThe exact approved amount, what returns and the loss bound.
Show attributes
The exact approved amount, what returns and the loss bound.
amountoneOfrequiredHow much SOL to withdraw from the agent's Solana account.
Show attributes
How much SOL to withdraw from the agent's Solana account.
oneOf · 2 variants
Variant 1 · kind: exact
Withdraw an exact amount of SOL.
kindstringrequiredWithdraw an exact amount of SOL.
Validation rules
- Exact value
"exact"
lamportsstringrequiredExact SOL to withdraw, in lamports (nine decimals): 0.5 SOL is "500000000".
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: all_spendable
Withdraw all the spendable SOL.
kindstringrequiredWithdraw all the SOL above the reserve the account keeps for rent and network fees.
Validation rules
- Exact value
"all_spendable"
receivestringrequiredusdc returns it to the agent wallet as USDC on NEAR; sol returns it to the agent wallet as SOL.
Validation rules
- Allowed values
["usdc","sol"]
maxValueLossBpsintegerrequiredExplicit maximum value loss in basis points, including provider fees: at most 300. Required; no default.
Validation rules
- Minimum
0- Maximum
300
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 13 · type: prediction_order
typestringrequiredValidation rules
- Exact value
"prediction_order"
orderobjectrequiredShow attributes
marketIdstringrequiredValidation rules
- Pattern
"^[1-9][0-9]{0,19}$"
assetIdstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,77})$"
marketQuestionstringrequiredValidation rules
- Minimum length
1- Maximum length
1000
outcomestringrequiredValidation rules
- Minimum length
1- Maximum length
256
sidestringrequiredValidation rules
- Allowed values
["BUY","SELL"]
limitPriceUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
quantityoneOfrequiredShow attributes
oneOf · 2 variants
Variant 1 · kind: shares
kindstringrequiredValidation rules
- Exact value
"shares"
sizeSharesDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
Variant 2 · kind: budget
kindstringrequiredValidation rules
- Exact value
"budget"
amountUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
orderTypestringrequiredValidation rules
- Allowed values
["GTC","GTD","FOK","FAK"]
expiresAtintegeroptionalValidation rules
- Minimum
0- Maximum
253402300799
maxFeeUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
maxSpendUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
validUntilstring · date-timerequiredValidation 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 14 · type: prediction_withdraw
typestringrequiredValidation rules
- Exact value
"prediction_withdraw"
withdrawalobjectrequiredWithdraw pUSD through Polymarket’s conversion service as native USDC on Polygon to a unique verified 1Click address crediting only the agent’s own confidential Intents wallet. Funding remains a separate USDC route.
Show attributes
Withdraw pUSD through Polymarket’s conversion service as native USDC on Polygon to a unique verified 1Click address crediting only the agent’s own confidential Intents wallet. Funding remains a separate USDC route.
amountRawstringrequiredExact pUSD debit in six-decimal atomic units: 5 pUSD is "5000000". Only the agent’s own Deposit Wallet is spent.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
maxLossBpsintegerrequiredExplicit maximum estimated route loss in basis points, fees included; required, never defaulted. The bridge quote is an estimate, not a guaranteed final credit.
Validation rules
- Minimum
0- Maximum
300
validUntilstring · date-timerequiredValidation 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 15 · type: composite
One owner signature over several exact one-shot grants and the order they run in.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"composite"
piecesarrayrequiredShow attributes
Validation rules
- Minimum items
1- Maximum items
6
Array items · object
toolstringrequiredThe tool whose one-shot call this piece is.
Validation rules
- Allowed values
["intents_execute","perps_fund","perps_order_place","prediction_fund","prediction_order_place","perps_withdraw","prediction_withdraw"]
contractanyOfrequiredShow attributes
anyOf · 7 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_transfer
One approved perps transfer in exactly the named direction.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"perps_transfer"
directionstringrequiredFund the own perps account from the agent wallet, or withdraw back to the same agent wallet.
Validation rules
- Allowed values
["fund","withdraw"]
transferobjectrequiredThe exact approved amount and all-in loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.
Show attributes
The exact approved amount and all-in loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.
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})$"
validUntilstring · date-timerequiredThe deadline after which this one-shot 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: perps_order
One approved Hyperliquid order, signed once exactly as approved.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"perps_order"
orderobjectrequiredThe exact approved order.
Show attributes
The exact approved order.
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
validUntilstring · date-timerequiredThe deadline after which this one-shot 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 · type: prediction_fund
One exact USDC or USDT debit delivered as native Base USDC to Polymarket's bridge for the agent's own account; the final pUSD amount is not bounded.
typestringrequiredOne approved Polymarket funding transfer.
Validation rules
- Exact value
"prediction_fund"
transferobjectrequiredThe exact approved USDC or USDT debit and the first leg's loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.
Show attributes
The exact approved USDC or USDT debit and the first leg's loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.
amountRawstringrequiredExact debit in six-decimal atomic units: 5 USDC or USDT is "5000000", spent 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. The host resolves the agent’s own Polymarket Deposit Wallet and its bridge address; never supply an address.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
maxFirstLegLossBpsintegerrequiredExplicit maximum loss, in basis points, of the first leg only: the wallet's USDC, USDT or coin delivered as native Base USDC to Polymarket's bridge, fees and any cross-chain hop included. It does not bound the bridge's conversion to pUSD on Polygon, whose fees and output are variable and estimated. Required; no default.
Validation rules
- Minimum
0- Maximum
300
payWithobjectoptionalApproved in chat as one call or as a funded order's funding: the coin the first leg pays with instead of a USDC or USDT holding, and the most of it it may spend.
Show attributes
Approved in chat as one call or as a funded order's funding: the coin the first leg pays with instead of a USDC or USDT holding, and the most of it it may spend.
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})$"
validUntilstring · date-timerequiredThe deadline after which this one-shot 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 5 · type: prediction_order
typestringrequiredValidation rules
- Exact value
"prediction_order"
orderobjectrequiredShow attributes
marketIdstringrequiredValidation rules
- Pattern
"^[1-9][0-9]{0,19}$"
assetIdstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,77})$"
marketQuestionstringrequiredValidation rules
- Minimum length
1- Maximum length
1000
outcomestringrequiredValidation rules
- Minimum length
1- Maximum length
256
sidestringrequiredValidation rules
- Allowed values
["BUY","SELL"]
limitPriceUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
quantityoneOfrequiredShow attributes
oneOf · 2 variants
Variant 1 · kind: shares
kindstringrequiredValidation rules
- Exact value
"shares"
sizeSharesDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
Variant 2 · kind: budget
kindstringrequiredValidation rules
- Exact value
"budget"
amountUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
orderTypestringrequiredValidation rules
- Allowed values
["GTC","GTD","FOK","FAK"]
expiresAtintegeroptionalValidation rules
- Minimum
0- Maximum
253402300799
maxFeeUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
maxSpendUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
validUntilstring · date-timerequiredValidation 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 6 · type: perps_freed_withdrawal
One withdrawal home of what a cash-out's exit freed on Hyperliquid, at most the signed maximum. Only ever a piece of a cash-out.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"perps_freed_withdrawal"
withdrawalobjectrequiredThe signed maximum and all-in loss bound of the withdrawal home.
Show attributes
The signed maximum and all-in loss bound of the withdrawal home.
upToRawstringrequiredThe most this withdrawal may move, in six-decimal atomic USDC: what the exit before it frees, sized by the host before the approval opens. Never more than the exit freed.
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
validUntilstring · date-timerequiredThe deadline after which this one-shot 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 7 · type: prediction_freed_withdrawal
One withdrawal home of what a cash-out's sale freed on Polymarket, at most the signed maximum. Only ever a piece of a cash-out.
typestringrequiredValidation rules
- Exact value
"prediction_freed_withdrawal"
withdrawalobjectrequiredWithdraw to the agent's own confidential Intents wallet what the sale before it freed in its own Polymarket Deposit Wallet, never more than upToRaw.
Show attributes
Withdraw to the agent's own confidential Intents wallet what the sale before it freed in its own Polymarket Deposit Wallet, never more than upToRaw.
upToRawstringrequiredThe most this withdrawal may move, in six-decimal atomic pUSD: what the sale before it frees, sized by the host before the approval opens. Never more than the sale freed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
maxLossBpsintegerrequiredExplicit maximum estimated route loss in basis points, fees included; required, never defaulted. The bridge quote is an estimate, not a guaranteed final credit.
Validation rules
- Minimum
0- Maximum
300
validUntilstring · date-timerequiredValidation 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))$"
startBystring · date-timerequiredValidation 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))$"
dependenciesarrayrequiredShow attributes
Array items · array
Validation rules
- Maximum items
6
Array items · integer
Validation rules
- Minimum
0- Maximum
9007199254740991
walletDebitanyOfrequiredThe sum of every piece's debit from the agent wallet, per token, in raw units. Empty when the pieces are venue orders paid from money already on their venues, as when finishing a basket, or a cash-out, which closes a position and brings home what that freed.
Show attributes
The sum of every piece's debit from the agent wallet, per token, in raw units. Empty when the pieces are venue orders paid from money already on their venues, as when finishing a basket, or a cash-out, which closes a position and brings home what that freed.
anyOf · 2 variants
Variant 1 · array
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})$"
Variant 2 · array
Validation rules
- prefixItems
[]- Maximum items
0
Array items · never
No value is allowed.
validUntilstring · date-timerequiredWhen every piece that has not started loses its authority.
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 16 · 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 17 · type: solana_sell_many
An approved multi-coin Solana sale, executed only exactly as approved.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"solana_sell_many"
sellManyobjectrequiredThe exact approved coins, amounts and loss bounds, in order, and where the proceeds go.
Show attributes
The exact approved coins, amounts and loss bounds, in order, and where the proceeds go.
sellsarrayrequiredThe coins to sell, in the order they are sold: 2 to 6, each a different mint, none of them SOL itself.
Show attributes
The coins to sell, in the order they are sold: 2 to 6, each a different mint, none of them SOL itself.
Validation rules
- Minimum items
2- Maximum items
6
Array items · object
One coin of a multi-coin sale, sold through 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
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
receivestringrequiredusdc returns the summed proceeds of every sale that went through to the agent wallet as USDC on NEAR, in one transfer once the last sale ran; sol keeps them as SOL in the agent's Solana account.
Validation rules
- Allowed values
["usdc","sol"]
maxExecutionsnumberrequiredA multi-coin sale is approved once and runs once: always 1.
Validation rules
- Exact value
1
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 18 · type: grid
Owner-signed authority for one grid: the resting cell orders its terms derive, until it ends.
typestringrequiredWhich contract template this is.
Validation rules
- Exact value
"grid"
gridobjectrequiredA grid's exact terms: pair, levels, quantity and starting sides.
Show attributes
A grid's exact terms: pair, levels, quantity and starting sides.
baseobjectrequiredThe asset the grid buys low and sells high.
Show attributes
The asset the grid buys low and sells high.
pinnedobjectrequiredThe exact base asset: token id and decimals.
Show attributes
The exact base asset: token id and decimals.
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
quoteobjectrequiredThe asset prices are in and buys are paid with.
Show attributes
The asset prices are in and buys are paid with.
pinnedobjectrequiredThe exact quote asset: token id and decimals.
Show attributes
The exact quote asset: token id and decimals.
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
levelsarrayrequiredThe 2 to 20 grid prices, strictly ascending: quote units per ONE base unit, plain human decimals.
Show attributes
The 2 to 20 grid prices, strictly ascending: quote units per ONE base unit, plain human decimals.
Validation rules
- Minimum items
2- Maximum items
20
Array items · string
Validation rules
- Maximum length
80- Pattern
"^(0|[1-9]\\d{0,38})(\\.\\d{1,38})?$"
quantityPerCellstringrequiredThe exact base amount every cell buys and sells, in the base asset's smallest unit. Fixed: profits never compound.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
cellsarrayrequiredOne entry per cell, lowest first (levels.length - 1 of them): cells wholly below the start price and the one straddling it buy, cells wholly above it stay idle.
Show attributes
One entry per cell, lowest first (levels.length - 1 of them): cells wholly below the start price and the one straddling it buy, cells wholly above it stay idle.
Validation rules
- Minimum items
1- Maximum items
19
Array items · object
startstringrequiredThe side the cell's first order is on: buy at its low level, or idle (the cell never places).
Validation rules
- Allowed values
["buy","idle"]
validUntilstring · date-timerequiredWhen the grid ends: no order is placed, and none rests, after it. At most 720 hours after 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 19 · type: perps_freed_withdrawal
One withdrawal home of what a cash-out's exit freed on Hyperliquid, at most the signed maximum. Only ever a piece of a cash-out.
typestringrequiredWhich authorization contract this is.
Validation rules
- Exact value
"perps_freed_withdrawal"
withdrawalobjectrequiredThe signed maximum and all-in loss bound of the withdrawal home.
Show attributes
The signed maximum and all-in loss bound of the withdrawal home.
upToRawstringrequiredThe most this withdrawal may move, in six-decimal atomic USDC: what the exit before it frees, sized by the host before the approval opens. Never more than the exit freed.
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
validUntilstring · date-timerequiredThe deadline after which this one-shot 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 20 · type: prediction_freed_withdrawal
One withdrawal home of what a cash-out's sale freed on Polymarket, at most the signed maximum. Only ever a piece of a cash-out.
typestringrequiredValidation rules
- Exact value
"prediction_freed_withdrawal"
withdrawalobjectrequiredWithdraw to the agent's own confidential Intents wallet what the sale before it freed in its own Polymarket Deposit Wallet, never more than upToRaw.
Show attributes
Withdraw to the agent's own confidential Intents wallet what the sale before it freed in its own Polymarket Deposit Wallet, never more than upToRaw.
upToRawstringrequiredThe most this withdrawal may move, in six-decimal atomic pUSD: what the sale before it frees, sized by the host before the approval opens. Never more than the sale freed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
maxLossBpsintegerrequiredExplicit maximum estimated route loss in basis points, fees included; required, never defaulted. The bridge quote is an estimate, not a guaranteed final credit.
Validation rules
- Minimum
0- Maximum
300
validUntilstring · date-timerequiredValidation 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))$"
executionRestrictionstringoptionalSet when this approval disallows automatic signing; fixed when the approval opened, never inferred from the current UI mode.
Validation rules
- Exact value
"signing_disabled"
expiresAtstring · date-timeoptionalWhen the parked decision lapses; optional so journal entries written before it still parse.
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 11 · type: approval.decided
The user, or a partner integration, approved or denied a parked approval. approve says which way; a denial may carry reason. Consuming the decision to execute the tool follows as approval.consumed, but only when the decision was an approval — a denial never reaches consumption.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as an approval.decided event.
Validation rules
- Exact value
"approval.decided"
payloadobjectrequiredThe approval.decided event's own fields.
Show attributes
The approval.decided event's own fields.
approvalIdstring · uuidrequiredThe approval'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)$"
approvebooleanrequiredTrue when the user approved; false when denied.
reasonstringoptionalThe user's reason, mainly given with a denial.
attestationobjectoptionalThe partner-side confirmation cited for the decision; never verified by fin.
Show attributes
The partner-side confirmation cited for the decision; never verified by fin.
referencestringrequiredThe partner's own reference for its confirmation.
Validation rules
- Minimum length
1- Maximum length
256
decidedByobjectoptionalWhich integration released it; absent on journals written before v1, null for the deployment's own app.
Show attributes
Which integration released it; absent on journals written before v1, null for the deployment's own app.
partnerKeyIdanyOfrequiredThe partner key that released this decision; null for the deployment's own app.
Show attributes
The partner key that released this decision; null for the deployment's own app.
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
Variant 12 · type: question.opened
A questionnaire is waiting for the user. Its full content is durable and replayable.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a question.opened event.
Validation rules
- Exact value
"question.opened"
payloadobjectrequiredThe question.opened event's full resource.
Show attributes
The question.opened event's full resource.
idstring · uuidrequiredThe questionnaire's unique 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)$"
conversationIdstring · uuidrequiredThe conversation containing this questionnaire.
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)$"
runIdstring · uuidrequiredThe run waiting for this questionnaire.
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)$"
callIdstringrequiredThe tool call that opened this questionnaire.
Validation rules
- Minimum length
1- Maximum length
256
questionsarrayrequiredThe questions and choices shown to the user.
Show attributes
The questions and choices shown to the user.
Validation rules
- Minimum items
1- Maximum items
5
Array items · object
One question and its available choices.
idstringrequiredThe stable id used to match this question with its answer.
Validation rules
- Minimum length
1- Maximum length
64
labelstringoptionalOptional short title for this question.
Validation rules
- Minimum length
1- Maximum length
128
promptstringrequiredThe question text shown to the user.
Validation rules
- Minimum length
1- Maximum length
512
optionsarrayrequiredThe choices shown for this question.
Show attributes
The choices shown for this question.
Validation rules
- Minimum items
2- Maximum items
6
Array items · object
One choice presented for a question.
valuestringrequiredThe stable value returned when this option is selected.
Validation rules
- Minimum length
1- Maximum length
128
labelstringrequiredThe text shown to the user for this option.
Validation rules
- Minimum length
1- Maximum length
512
descriptionstringoptionalOptional explanation shown with this option.
Validation rules
- Maximum length
512
recommendedbooleanoptionalWhether this is the option the agent recommends: at most one per question, with why in its description.
picturestringoptionalA small drawing an app may show over this choice: schedule for buying on a regular schedule, dip for buying only after a fall, once for one buy now. Absent when none fits; an app that draws none shows the choice without it.
Validation rules
- Allowed values
["schedule","dip","once"]
multiplebooleanoptionalWhether the user may select more than one choice.
amountobjectoptionalAsks for one amount on a slider. The options are its presets, each value a decimal string within min and max; an amount between them is answered as customText.
Show attributes
Asks for one amount on a slider. The options are its presets, each value a decimal string within min and max; an amount between them is answered as customText.
minstringrequiredThe smallest amount the slider offers, as a decimal string.
Validation rules
- Maximum length
40- Pattern
"^(0|[1-9]\\d{0,20})(\\.\\d{1,18})?$"
maxstringrequiredThe largest amount the slider offers, as a decimal string.
Validation rules
- Maximum length
40- Pattern
"^(0|[1-9]\\d{0,20})(\\.\\d{1,18})?$"
stepstringrequiredHow far one slider step moves, as a decimal string.
Validation rules
- Maximum length
40- Pattern
"^(0|[1-9]\\d{0,20})(\\.\\d{1,18})?$"
unitstringrequiredWhat the amount counts: "usd" for dollars, or a token symbol such as "USDC".
Validation rules
- Minimum length
1- Maximum length
16
statusstringrequiredThe current questionnaire status.
Validation rules
- Allowed values
["pending","answered","skipped","expired","cancelled"]
answeranyOfrequiredThe accepted answers or skip result, or null when none was accepted.
Show attributes
The accepted answers or skip result, or null when none was accepted.
anyOf · 2 variants
Variant 1 · oneOf
The result of answering or skipping a questionnaire.
oneOf · 2 variants
Variant 1 · status: answered
statusstringrequiredThe questionnaire was answered.
Validation rules
- Exact value
"answered"
answersarrayrequiredThe selected options or custom text for each question the user answered. A question they skipped has no answer.
Show attributes
The selected options or custom text for each question the user answered. A question they skipped has no answer.
Validation rules
- Minimum items
1- Maximum items
5
Array items · object
The user's answer to one question.
idstringrequiredThe id of the question this answer corresponds to.
Validation rules
- Minimum length
1- Maximum length
64
valuesarrayrequiredSelected option values; empty when customText is supplied.
Show attributes
Selected option values; empty when customText is supplied.
Validation rules
- Maximum items
6
Array items · string
Validation rules
- Minimum length
1- Maximum length
128
customTextstringoptionalOptional user-supplied text in place of selected options.
Validation rules
- Maximum length
2048
Variant 2 · status: skipped
statusstringrequiredThe questionnaire was skipped.
Validation rules
- Exact value
"skipped"
Variant 2 · null
createdAtstring · date-timerequiredWhen the questionnaire 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))$"
expiresAtstring · date-timerequiredWhen the questionnaire expires if unanswered.
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))$"
resolvedAtanyOfrequiredWhen the questionnaire was answered, skipped, expired, or cancelled; null while pending.
Show attributes
When the questionnaire was answered, skipped, expired, or cancelled; null while pending.
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 13 · type: question.answered
The user answered or skipped a questionnaire; its accepted result is durable.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a question.answered event.
Validation rules
- Exact value
"question.answered"
payloadobjectrequiredThe question.answered event's own fields.
Show attributes
The question.answered event's own fields.
questionIdstring · uuidrequiredThe questionnaire that was resolved.
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)$"
answeroneOfrequiredThe user's answers or decision to skip.
Show attributes
The user's answers or decision to skip.
oneOf · 2 variants
Variant 1 · status: answered
statusstringrequiredThe questionnaire was answered.
Validation rules
- Exact value
"answered"
answersarrayrequiredThe selected options or custom text for each question the user answered. A question they skipped has no answer.
Show attributes
The selected options or custom text for each question the user answered. A question they skipped has no answer.
Validation rules
- Minimum items
1- Maximum items
5
Array items · object
The user's answer to one question.
idstringrequiredThe id of the question this answer corresponds to.
Validation rules
- Minimum length
1- Maximum length
64
valuesarrayrequiredSelected option values; empty when customText is supplied.
Show attributes
Selected option values; empty when customText is supplied.
Validation rules
- Maximum items
6
Array items · string
Validation rules
- Minimum length
1- Maximum length
128
customTextstringoptionalOptional user-supplied text in place of selected options.
Validation rules
- Maximum length
2048
Variant 2 · status: skipped
statusstringrequiredThe questionnaire was skipped.
Validation rules
- Exact value
"skipped"
resolvedAtstring · date-timerequiredWhen the questionnaire was answered or skipped.
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 14 · type: question.closed
A pending questionnaire expired or was cancelled.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a question.closed event.
Validation rules
- Exact value
"question.closed"
payloadobjectrequiredThe question.closed event's own fields.
Show attributes
The question.closed event's own fields.
questionIdstring · uuidrequiredThe questionnaire that was closed.
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)$"
statusstringrequiredWhy the questionnaire closed without an answer.
Validation rules
- Allowed values
["expired","cancelled"]
resolvedAtstring · date-timerequiredWhen the questionnaire closed.
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 15 · type: approval.consumed
The approval was spent to authorize its tool call, immediately before that call runs. This is when the call is authorized, not when it finishes: the call can still fail after this event lands, and nothing here rolls it back. Marks the approval used; it cannot authorize a second execution.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as an approval.consumed event.
Validation rules
- Exact value
"approval.consumed"
payloadobjectrequiredThe approval.consumed event's own fields.
Show attributes
The approval.consumed event's own fields.
approvalIdstring · uuidrequiredThe approval'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 16 · type: approval.expired
A parked approval lapsed before anyone decided: its deadline passed, or the run it belongs to stopped while it was still pending.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as an approval.expired event.
Validation rules
- Exact value
"approval.expired"
payloadobjectrequiredThe approval.expired event's own fields.
Show attributes
The approval.expired event's own fields.
approvalIdstring · uuidrequiredThe approval'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)$"
reasonstringrequiredWhy the approval expired: the deadline passed, or its run stopped first.
Variant 17 · type: automation.fired
An automation triggered this conversation's run. Emitted once, immediately before the run.started it precedes, naming the automation and its name at fire time.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as an automation.fired event.
Validation rules
- Exact value
"automation.fired"
payloadobjectrequiredThe automation.fired event's own fields.
Show attributes
The automation.fired event's own fields.
automationIdstringrequiredThe automation that fired this run.
namestringrequiredThe automation's name at the time it fired.
Variant 18 · type: intents.settlement
A later, independently verified financial fact about one leg of an authorized swap — settled, refunded, or never executed — never inferred from the model's own tool result. Appended whenever the provider confirms the outcome, independent of the run that requested it; legId and operationId join it back to its financial request, progress and authorizing approval. Archived receipts retain their original occurrenceId.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as an intents.settlement event.
Validation rules
- Exact value
"intents.settlement"
payloadoneOfrequiredThe intents.settlement event's own fields.
Show attributes
The intents.settlement event's own fields.
oneOf · 3 variants
Variant 1 · object
approvalIdstring · uuidrequiredThe approval'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)$"
legIdstring · uuidrequiredWhich leg of the plan this receipt settles.
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)$"
indexintegerrequiredThis leg's position within the plan, counting from zero.
Validation rules
- Minimum
0- Maximum
15
operationIdstring · uuidoptionalThe durable financial request this evidence belongs to.
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)$"
occurrenceIdstringoptionalThe archived event's original identity, retained verbatim; current receipts use operationId.
Validation rules
- Minimum length
1- Maximum length
160
statestringrequiredThe leg settled: its output asset moved as planned.
Validation rules
- Exact value
"settled"
outputobjectrequiredWhat the leg produced.
Show attributes
What the leg produced.
tokenIdstringrequiredThe asset's NEP-141 token id.
Validation rules
- Minimum length
1- Maximum length
256
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
amountRawstringoptionalThe amount, in the token's smallest unit, when it is known.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · object
approvalIdstring · uuidrequiredThe approval'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)$"
legIdstring · uuidrequiredWhich leg of the plan this receipt settles.
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)$"
indexintegerrequiredThis leg's position within the plan, counting from zero.
Validation rules
- Minimum
0- Maximum
15
operationIdstring · uuidoptionalThe durable financial request this evidence belongs to.
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)$"
occurrenceIdstringoptionalThe archived event's original identity, retained verbatim; current receipts use operationId.
Validation rules
- Minimum length
1- Maximum length
160
statestringrequiredThe leg did not settle and its input asset was returned.
Validation rules
- Exact value
"refunded"
refundobjectrequiredWhat was returned.
Show attributes
What was returned.
tokenIdstringrequiredThe asset's NEP-141 token id.
Validation rules
- Minimum length
1- Maximum length
256
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
amountRawstringoptionalThe amount, in the token's smallest unit, when it is known.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 3 · object
approvalIdstring · uuidrequiredThe approval'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)$"
legIdstring · uuidrequiredWhich leg of the plan this receipt settles.
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)$"
indexintegerrequiredThis leg's position within the plan, counting from zero.
Validation rules
- Minimum
0- Maximum
15
operationIdstring · uuidoptionalThe durable financial request this evidence belongs to.
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)$"
occurrenceIdstringoptionalThe archived event's original identity, retained verbatim; current receipts use operationId.
Validation rules
- Minimum length
1- Maximum length
160
statestringrequiredThe leg did not settle. Most reasons mean it never reached the provider; rejected means it did and was refused there — see reason.
Validation rules
- Exact value
"not_executed"
reasonstringoptionalWhy nothing executed: signing_disabled when automatic signing was off, signing_failed when signing itself failed, rejected when the provider refused the submission outright (it did reach the provider), expired when the leg's own signing/deposit window elapsed before a terminal fact arrived, or failed otherwise. Optional so receipts written before the reason was carried still parse.
Validation rules
- Allowed values
["signing_disabled","signing_failed","rejected","expired","failed"]
unsignedBystringoptionalPresent with signing_failed on an Agent API wallet's leg when the NEAR Intents Agent API, the wallet's signer, released no signature for it: it refused the request, or its own history proves it released none. Nothing moved.
Validation rules
- Exact value
"agent_api"
Variant 19 · type: intents.progress
Best-effort, display-only progress for an authorized swap, between approval and its settlement receipt: freezing the plan (planning), the frozen legs (planned), then each leg's own stage (stage). Never gates execution and may arrive out of order or not at all; an intents.settlement receipt always takes precedence, and a terminal outcome is never reported here.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as an intents.progress event.
Validation rules
- Exact value
"intents.progress"
payloadoneOfrequiredThe intents.progress event's own fields.
Show attributes
The intents.progress event's own fields.
oneOf · 3 variants
Variant 1 · kind: planning
operationIdstring · uuidoptionalThe durable financial request this evidence belongs to.
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)$"
occurrenceIdstringoptionalThe archived event's original identity, retained verbatim; current progress uses operationId.
Validation rules
- Minimum length
1- Maximum length
160
approvalIdstring · uuidrequiredThe grant's approval id: the chat approval for a one-shot, the creation approval for an automation.
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)$"
kindstringrequiredAuthorized; reading balances and prices to freeze the plan.
Validation rules
- Exact value
"planning"
Variant 2 · kind: planned
operationIdstring · uuidoptionalThe durable financial request this evidence belongs to.
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)$"
occurrenceIdstringoptionalThe archived event's original identity, retained verbatim; current progress uses operationId.
Validation rules
- Minimum length
1- Maximum length
160
approvalIdstring · uuidrequiredThe grant's approval id: the chat approval for a one-shot, the creation approval for an automation.
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)$"
kindstringrequiredThe frozen plan: every swap, with the amount on the side the plan fixed.
Validation rules
- Exact value
"planned"
legsarrayrequiredEvery swap in the frozen plan, indexed from zero.
Show attributes
Every swap in the frozen plan, indexed from zero.
Validation rules
- Minimum items
1- Maximum items
16
Array items · object
indexintegerrequiredThis leg's position within the plan, counting from zero.
Validation rules
- Minimum
0- Maximum
15
inputobjectrequiredThe input asset and, when the plan fixed this side, the exact amount it spends.
Show attributes
The input asset and, when the plan fixed this side, the exact amount it spends.
tokenIdstringrequiredThe asset's NEP-141 token id.
Validation rules
- Minimum length
1- Maximum length
256
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
amountRawstringoptionalThe amount, in the token's smallest unit, when it is known.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
outputobjectrequiredThe output asset and, when the plan fixed this side, the exact amount it receives.
Show attributes
The output asset and, when the plan fixed this side, the exact amount it receives.
tokenIdstringrequiredThe asset's NEP-141 token id.
Validation rules
- Minimum length
1- Maximum length
256
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
amountRawstringoptionalThe amount, in the token's smallest unit, when it is known.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
minimumOutputRawstringoptionalThe floor an exact-input swap's output must clear; present only when the input side is fixed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
maximumInputRawstringoptionalThe ceiling an exact-output swap's input may spend; present only when the output side is fixed.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 3 · kind: stage
operationIdstring · uuidoptionalThe durable financial request this evidence belongs to.
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)$"
occurrenceIdstringoptionalThe archived event's original identity, retained verbatim; current progress uses operationId.
Validation rules
- Minimum length
1- Maximum length
160
approvalIdstring · uuidrequiredThe grant's approval id: the chat approval for a one-shot, the creation approval for an automation.
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)$"
kindstringrequiredOne swap moved; legId joins it to its receipt once the swap is claimed.
Validation rules
- Exact value
"stage"
indexintegerrequiredWhich leg, by position, this update is about.
Validation rules
- Minimum
0- Maximum
15
stagestringrequiredWhat the executor is doing right now, between approval and a receipt: checking while it checks the complete frozen request before dispatch; retrying while a bounded preparation attempt waits to retry; quoting while it fetches and validates the provider quote, then claims and signs; signed once the signature is persisted, about to submit; confirming once submitted (or recovered), waiting for the provider's terminal fact; unresolved when the run's settle budget ended before a terminal fact and the sweep continues.
Validation rules
- Allowed values
["checking","retrying","quoting","signed","confirming","unresolved"]
legIdstring · uuidoptionalJoins this stage to its settlement receipt once the swap is claimed; absent before then.
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 20 · type: perps.reconciled
A later, independently verified answer to an approved perps order, cancellation or withdrawal whose own tool.result was left unconfirmed — never inferred from the model's own tool result. Appended once, by recovery, in the same commit that records the request's final outcome, independent of the run that made the call; callId joins it to that call's tool.result, approvalId to its approval, and operationId to its financial request. result has the shape the tool itself returns; show it in place of the call's earlier unconfirmed result.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a perps.reconciled event.
Validation rules
- Exact value
"perps.reconciled"
payloadoneOfrequiredThe perps.reconciled event's own fields.
Show attributes
The perps.reconciled event's own fields.
oneOf · 2 variants
Variant 1 · object
approvalIdstring · uuidrequiredThe approval that authorized the call.
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)$"
operationIdstring · uuidrequiredThe durable financial request this answer belongs to.
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)$"
callIdstringrequiredThe tool call whose own result this answer supersedes, as tool.result names it.
Validation rules
- Minimum length
1- Maximum length
256
toolstringrequiredThe order placement, cancellation or margin change Hyperliquid has now answered.
Validation rules
- Allowed values
["perps_order_place","perps_order_cancel","perps_margin_update"]
resultobjectrequiredHyperliquid's final answer, in the shape the tool itself returns: placed, rejected, cancelled or applied.
Show attributes
Hyperliquid's final answer, in the shape the tool itself returns: placed, rejected, cancelled or applied.
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 · object
approvalIdstring · uuidrequiredThe approval that authorized the call.
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)$"
operationIdstring · uuidrequiredThe durable financial request this answer belongs to.
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)$"
callIdstringrequiredThe tool call whose own result this answer supersedes, as tool.result names it.
Validation rules
- Minimum length
1- Maximum length
256
toolstringrequiredThe withdrawal whose settlement the provider has now confirmed.
Validation rules
- Exact value
"perps_withdraw"
resultanyOfrequiredThe confirmed ending, in the shape the tool itself returns: settled or refunded.
Show attributes
The confirmed ending, in the shape the tool itself returns: settled or refunded.
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 21 · type: prediction.funding
Recovery's latest view of an approved prediction_fund call, appended whenever it changes, independent of the run that made the call: the first leg's verified 1Click outcome (native Base USDC delivered to Polymarket's bridge, refunded, or not executed) and every transaction the bridge reports at the pinned deposit address, each COMPLETED one checked against its canonical Polygon receipt. Delivery to the bridge is not pUSD funding, a bridge FAILED is not a refund, and attribution of any bridge transaction to this funding stays unknown. callId joins it to that call's tool.result; show the latest in place of it.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a prediction.funding event.
Validation rules
- Exact value
"prediction.funding"
payloadobjectrequiredThe prediction.funding event's own fields.
Show attributes
The prediction.funding event's own fields.
approvalIdstring · uuidrequiredThe approval that authorized the call.
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)$"
operationIdstring · uuidrequiredThe durable financial request this answer belongs to.
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)$"
callIdstringrequiredThe tool call whose own result this answer supersedes, as tool.result names it.
Validation rules
- Minimum length
1- Maximum length
256
toolstringrequiredThe funding tool whose call this updates.
Validation rules
- Exact value
"prediction_fund"
resultobjectrequiredThe funding's current stages, in the shape the tool itself returns.
Show attributes
The funding's current stages, in the shape the tool itself returns.
statusstringrequiredThe exact USDC debit was attempted.
Validation rules
- Exact value
"submitted"
operationIdstring · uuidrequiredValidation 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)$"
firstLegoneOfrequiredThe first leg's verified 1Click outcome, or pending while it has none.
Show attributes
The first leg's verified 1Click outcome, or pending while it has none.
oneOf · 4 variants
Variant 1 · object
statestringrequiredValidation rules
- Exact value
"pending"
Variant 2 · object
statestringrequiredValidation rules
- Exact value
"delivered_to_bridge"
deliveredRawstringoptionalNative Base USDC 1Click reported delivered to the bridge address; absent when its settlement stated no figure.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 3 · object
statestringrequiredValidation rules
- Exact value
"refunded"
refundedRawstringoptionalThe USDC 1Click reported refunded to the agent wallet, in the asset the first leg spent; absent when its refund stated no figure.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 4 · object
statestringrequiredValidation rules
- Exact value
"not_executed"
bridgeobjectrequiredShow attributes
depositWalletstringrequiredThe agent's own Polymarket Deposit Wallet.
Validation rules
- Pattern
"^0x[0-9a-f]{40}$"
bridgeAddressstringrequiredThe bridge deposit address the first leg paid, pinned before signing.
Validation rules
- Pattern
"^0x[0-9a-f]{40}$"
minDepositRawstringrequiredThe bridge's minimum for native Base USDC when the address was pinned.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
observationoneOfrequiredShow attributes
oneOf · 3 variants
Variant 1 · object
statestringrequiredNothing was delivered to the bridge yet, so its status was not read.
Validation rules
- Exact value
"not_observed"
Variant 2 · object
statestringrequiredThe bridge's status could not be read.
Validation rules
- Exact value
"unavailable"
attemptedAtMsintegerrequiredValidation rules
- Minimum
0- Maximum
9007199254740991
Variant 3 · object
statestringrequiredValidation rules
- Exact value
"observed"
observedAtMsintegerrequiredValidation rules
- Minimum
0- Maximum
9007199254740991
completebooleanrequiredWhether every page was read; false when the walk stopped at its bound.
transactionsarrayrequiredEvery transaction the bridge reports at the address, newest first.
Show attributes
Every transaction the bridge reports at the address, newest first.
Validation rules
- Maximum items
500
Array items · object
statusstringrequiredThe bridge's status, verbatim: documented DEPOSIT_DETECTED, PROCESSING, ORIGIN_TX_CONFIRMED, SUBMITTED, COMPLETED, FAILED. FAILED is not a refund.
Validation rules
- Pattern
"^[A-Z][A-Z_]{0,63}$"
fromChainIdstringrequiredValidation rules
- Minimum length
1- Maximum length
32
fromTokenAddressstringrequiredValidation rules
- Minimum length
1- Maximum length
128
fromAmountRawstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
toChainIdstringrequiredValidation rules
- Minimum length
1- Maximum length
32
toTokenAddressstringrequiredValidation rules
- Minimum length
1- Maximum length
128
createdTimeMsintegeroptionalValidation rules
- Minimum
0- Maximum
9007199254740991
txHashstringoptionalThe bridge's own hash for the row, reported once COMPLETED. It names no Polygon transaction: the onramp row's is an ERC-4337 user operation's, and the Base row's is no chain's transaction. Never evidence of arrival.
Validation rules
- Minimum length
1- Maximum length
128
routeMatchesbooleanrequiredWhether the row has the pinned route's shape. Shape alone never links a bridge row to a particular funding or withdrawal.
creditoneOfoptionalRecorded only by releases before 2026-11-15, which read the row's hash as a Polygon transaction; never written now. A funding's arrival is its attribution, a withdrawal's the linked deposit receipt.
Show attributes
Recorded only by releases before 2026-11-15, which read the row's hash as a Polygon transaction; never written now. A funding's arrival is its attribution, a withdrawal's the linked deposit receipt.
oneOf · 4 variants
Variant 1 · object
statestringrequiredValidation rules
- Exact value
"verified"
blockNumberstringrequiredThe finalized canonical block, as a decimal.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
blockHashstringrequiredValidation rules
- Pattern
"^0x[0-9a-f]{64}$"
logIndexintegerrequiredValidation rules
- Minimum
0- Maximum
9007199254740991
creditRawstringrequiredThe pUSD this receipt's one incoming log credited to the Deposit Wallet, with no pUSD leaving it in the same transaction; six-decimal atomic units.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · object
statestringrequiredValidation rules
- Exact value
"not_credited"
reasonstringrequiredreverted the transaction failed; no_credit_log no pUSD transfer to the Deposit Wallet; multiple_credit_logs more than one, so no single credit can be named; outgoing_in_transaction pUSD also left the Deposit Wallet in the same transaction, so no net credit is named.
Validation rules
- Allowed values
["reverted","no_credit_log","multiple_credit_logs","outgoing_in_transaction"]
Variant 3 · object
statestringrequiredNo receipt yet, or its block is not finalized and canonical yet.
Validation rules
- Exact value
"unconfirmed"
Variant 4 · object
statestringrequiredPolygon could not be read; nothing is inferred.
Validation rules
- Exact value
"unavailable"
attributiononeOfrequiredShow attributes
oneOf · 2 variants
Variant 1 · object
statestringrequiredThis funding's pUSD arrived in the Deposit Wallet.
Validation rules
- Exact value
"credited"
creditRawstringrequiredThe pUSD the one matching receipt credited to the Deposit Wallet; six-decimal atomic units.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
transactionHashstringrequiredThe Polygon transaction that credited it.
Validation rules
- Pattern
"^0x[0-9a-f]{64}$"
Variant 2 · object
statestringrequiredValidation rules
- Exact value
"unknown"
reasonstringrequirednot_at_bridge step 1 has not delivered to the bridge; delivery_unmeasured 1Click reported no delivered figure or the leg has no signing time, so no conversion can be matched; bridge_not_read Polygon could not be read just now, or this answer was rebuilt from the record without reading it; awaiting_bridge Polygon shows no conversion of the delivered amount out of the bridge address yet; credit_not_verified the one matching conversion's receipt shows no single pUSD credit to the Deposit Wallet; ambiguous more than one conversion of the delivered amount, or another of the owner's open fundings at the address, could be this one; provider_reports_no_source_link recorded by a release that never attributed.
Validation rules
- Allowed values
["not_at_bridge","delivery_unmeasured","bridge_not_read","awaiting_bridge","credit_not_verified","ambiguous","provider_reports_no_source_link"]
candidatesintegerrequiredFinalized transfers of exactly the delivered amount out of the bridge address on Polygon after the first leg was signed, not credited to another funding.
Validation rules
- Minimum
0- Maximum
9007199254740991
balanceoneOfoptionalThe Deposit Wallet's live pUSD balance, read for the call's own answer and each prediction.funding change. Absent only from an answer rebuilt from the record without a live read, or recorded before balances were reported.
Show attributes
The Deposit Wallet's live pUSD balance, read for the call's own answer and each prediction.funding change. Absent only from an answer rebuilt from the record without a live read, or recorded before balances were reported.
oneOf · 2 variants
Variant 1 · object
statestringrequiredValidation rules
- Exact value
"observed"
pusdRawstringrequiredpUSD the wallet holds; six-decimal atomic units.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
readAtMsintegerrequiredValidation rules
- Minimum
0- Maximum
9007199254740991
Variant 2 · object
statestringrequiredPolygon could not be read; nothing is inferred.
Validation rules
- Exact value
"unavailable"
attemptedAtMsintegerrequiredValidation rules
- Minimum
0- Maximum
9007199254740991
Variant 22 · type: prediction.withdrawal
Recovery's latest view of an attempted owner-approved pUSD withdrawal, independent of the run: its outgoing Polygon transfer receipt, what the bridge reports, and arrival at the unique linked 1Click deposit address. Only that deposit's own receipt establishes a credit or refund into the agent's confidential Intents wallet. A bridge status alone is not a receipt. Replace the original tool result by callId; recovery never signs or resends.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a prediction.withdrawal event.
Validation rules
- Exact value
"prediction.withdrawal"
payloadobjectrequiredThe attempted withdrawal's outgoing receipt, bridge observation and unique linked deposit arrival.
Show attributes
The attempted withdrawal's outgoing receipt, bridge observation and unique linked deposit arrival.
approvalIdstring · uuidrequiredThe approval that authorized the call.
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)$"
operationIdstring · uuidrequiredThe durable financial request this answer belongs to.
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)$"
callIdstringrequiredThe tool call whose own result this answer supersedes, as tool.result names it.
Validation rules
- Minimum length
1- Maximum length
256
toolstringrequiredValidation rules
- Exact value
"prediction_withdraw"
resultobjectrequiredOne attempted pUSD withdrawal with outgoing receipt, bridge observation and linked 1Click arrival kept separate. Only the linked deposit receipt establishes credited or refunded funds.
Show attributes
One attempted pUSD withdrawal with outgoing receipt, bridge observation and linked 1Click arrival kept separate. Only the linked deposit receipt establishes credited or refunded funds.
statusstringrequiredValidation rules
- Exact value
"submitted"
operationIdstring · uuidrequiredValidation 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)$"
transferobjectrequiredShow attributes
statestringrequiredValidation rules
- Allowed values
["pending","confirmed","reverted","uncertain"]
transactionHashstringoptionalValidation rules
- Pattern
"^0x[0-9a-f]{64}$"
depositobjectrequiredShow attributes
depositIdstring · uuidrequiredValidation 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)$"
statestringrequiredValidation rules
- Allowed values
["preparing","awaiting_deposit","incomplete","processing","credited","refunded","unknown","expired","failed"]
receiptobjectoptionalShow attributes
observedAtstring · date-timerequiredWhen the outcome was observed.
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))$"
statestringrequiredWhether the transfer was credited or refunded.
Validation rules
- Allowed values
["credited","refunded"]
depositedRawstringrequiredWhat arrived at the address.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
creditedRawstringrequiredWhat the agent wallet was credited; zero when all of it was refunded.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
refundedRawstringrequiredWhat went back to the agent wallet uncredited, such as a transfer below the minimum.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
sourceTransactionHashesarrayrequiredThe transfers that paid the address, on the network they were sent on.
Show attributes
The transfers that paid the address, on the network they were sent on.
Validation rules
- Minimum items
1- Maximum items
32
Array items · string
Network transaction or ledger intent identifier; opaque and case-sensitive, not necessarily an EVM hash.
Validation rules
- Pattern
"^[\\x21-\\x7e]{1,256}$"
refundTransactionHashesarrayrequiredThe refund's ledger identifiers, when they were reported.
Show attributes
The refund's ledger identifiers, when they were reported.
Validation rules
- Maximum items
32
Array items · string
Network transaction or ledger intent identifier; opaque and case-sensitive, not necessarily an EVM hash.
Validation rules
- Pattern
"^[\\x21-\\x7e]{1,256}$"
bridgeobjectrequiredShow attributes
observationoneOfrequiredShow attributes
oneOf · 3 variants
Variant 1 · object
statestringrequiredNothing was delivered to the bridge yet, so its status was not read.
Validation rules
- Exact value
"not_observed"
Variant 2 · object
statestringrequiredThe bridge's status could not be read.
Validation rules
- Exact value
"unavailable"
attemptedAtMsintegerrequiredValidation rules
- Minimum
0- Maximum
9007199254740991
Variant 3 · object
statestringrequiredValidation rules
- Exact value
"observed"
observedAtMsintegerrequiredValidation rules
- Minimum
0- Maximum
9007199254740991
completebooleanrequiredWhether every page was read; false when the walk stopped at its bound.
transactionsarrayrequiredEvery transaction the bridge reports at the address, newest first.
Show attributes
Every transaction the bridge reports at the address, newest first.
Validation rules
- Maximum items
500
Array items · object
statusstringrequiredThe bridge's status, verbatim: documented DEPOSIT_DETECTED, PROCESSING, ORIGIN_TX_CONFIRMED, SUBMITTED, COMPLETED, FAILED. FAILED is not a refund.
Validation rules
- Pattern
"^[A-Z][A-Z_]{0,63}$"
fromChainIdstringrequiredValidation rules
- Minimum length
1- Maximum length
32
fromTokenAddressstringrequiredValidation rules
- Minimum length
1- Maximum length
128
fromAmountRawstringrequiredValidation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
toChainIdstringrequiredValidation rules
- Minimum length
1- Maximum length
32
toTokenAddressstringrequiredValidation rules
- Minimum length
1- Maximum length
128
createdTimeMsintegeroptionalValidation rules
- Minimum
0- Maximum
9007199254740991
txHashstringoptionalThe bridge's own hash for the row, reported once COMPLETED. It names no Polygon transaction: the onramp row's is an ERC-4337 user operation's, and the Base row's is no chain's transaction. Never evidence of arrival.
Validation rules
- Minimum length
1- Maximum length
128
routeMatchesbooleanrequiredWhether the row has the pinned route's shape. Shape alone never links a bridge row to a particular funding or withdrawal.
creditoneOfoptionalRecorded only by releases before 2026-11-15, which read the row's hash as a Polygon transaction; never written now. A funding's arrival is its attribution, a withdrawal's the linked deposit receipt.
Show attributes
Recorded only by releases before 2026-11-15, which read the row's hash as a Polygon transaction; never written now. A funding's arrival is its attribution, a withdrawal's the linked deposit receipt.
oneOf · 4 variants
Variant 1 · object
statestringrequiredValidation rules
- Exact value
"verified"
blockNumberstringrequiredThe finalized canonical block, as a decimal.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
blockHashstringrequiredValidation rules
- Pattern
"^0x[0-9a-f]{64}$"
logIndexintegerrequiredValidation rules
- Minimum
0- Maximum
9007199254740991
creditRawstringrequiredThe pUSD this receipt's one incoming log credited to the Deposit Wallet, with no pUSD leaving it in the same transaction; six-decimal atomic units.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · object
statestringrequiredValidation rules
- Exact value
"not_credited"
reasonstringrequiredreverted the transaction failed; no_credit_log no pUSD transfer to the Deposit Wallet; multiple_credit_logs more than one, so no single credit can be named; outgoing_in_transaction pUSD also left the Deposit Wallet in the same transaction, so no net credit is named.
Validation rules
- Allowed values
["reverted","no_credit_log","multiple_credit_logs","outgoing_in_transaction"]
Variant 3 · object
statestringrequiredNo receipt yet, or its block is not finalized and canonical yet.
Validation rules
- Exact value
"unconfirmed"
Variant 4 · object
statestringrequiredPolygon could not be read; nothing is inferred.
Validation rules
- Exact value
"unavailable"
Variant 23 · type: composite.progress
Best-effort display snapshot of an approved basket's pieces (composite_execute), appended after a piece changes state: each piece todo, live, done, bad or skip. Revision orders snapshots for the same call; ignore an older one. The call's own tool.result is the authoritative outcome of every piece, and each piece's own venue events keep their meaning; progress grants no execution permission.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a composite.progress event.
Validation rules
- Exact value
"composite.progress"
payloadobjectrequiredDisplay-only basket piece states.
Show attributes
Display-only basket piece states.
approvalIdstring · uuidrequiredThe approval'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)$"
callIdstringrequiredThe composite_execute call.
Validation rules
- Minimum length
1- Maximum length
256
revisionintegerrequiredSnapshot order: ignore an older snapshot for the same call.
Validation rules
- Minimum
1- Maximum
1024
piecesarrayrequiredShow attributes
Validation rules
- Minimum items
1- Maximum items
6
Array items · object
indexintegerrequiredValidation rules
- Minimum
0- Maximum
5
toolstringrequiredValidation rules
- Allowed values
["intents_execute","perps_fund","perps_order_place","prediction_fund","prediction_order_place","perps_withdraw","prediction_withdraw"]
operationIdanyOfrequiredShow attributes
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
statestringrequiredtodo waiting, live running, done executed, bad failed, skip never started because a piece it depends on did not succeed or the basket ended.
Validation rules
- Allowed values
["todo","live","done","bad","skip"]
reasonstringoptionalValidation rules
- Minimum length
1- Maximum length
300
Variant 24 · type: solana.progress
Best-effort display snapshot derived from committed Solana funding, swap or sweep facts. Revision orders snapshots; repeated unchanged observations are omitted. A confirmed funding phase is only delivered SOL, and a confirmed swap phase does not establish sweep settlement. Final tool outcomes and solana.reconciled remain authoritative; progress grants no execution permission.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a solana.progress event.
Validation rules
- Exact value
"solana.progress"
payloadobjectrequiredDisplay-only committed Solana stage, never a final operation result.
Show attributes
Display-only committed Solana stage, never a final operation result.
operationIdstring · uuidrequiredValidation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
approvalIdstring · uuidrequiredThe approval'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)$"
callIdstringrequiredThe original tool call, including a standing occurrence without its own approval card.
Validation rules
- Minimum length
1- Maximum length
256
revisionintegerrequiredPersisted lifecycle stage number. Ignore an older snapshot for the same operation.
Validation rules
- Minimum
1- Maximum
1024
phasestringrequiredValidation rules
- Allowed values
["funding","swap","sweep"]
statestringrequiredValidation rules
- Allowed values
["preparing","prepared","submitting","pending","delivering","confirmed","uncertain","refunded","failed","not_executed"]
transactionIndexintegeroptionalThe stored native transaction attempt, never a funding plan leg index.
Validation rules
- Minimum
0- Maximum
5
saleintegeroptionalOn a multi-coin sale's swap, which coin it sells: its zero-based place in the sale's sells. A multi-coin sale's progress names this in place of transactionIndex, and nothing on its one transfer back; absent on every other operation.
Validation rules
- Minimum
0- Maximum
5
paidobjectoptionalWhat a sale sold, once its swap landed: the amount its result reports as paid. Absent before then, and for other operations.
Show attributes
What a sale sold, once its swap landed: the amount its result reports as paid. Absent before then, and for other operations.
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})$"
Variant 25 · type: solana.reconciled
A later, independently verified answer to an approved Solana buy, sell or withdrawal whose own tool.result was left unconfirmed — never inferred from the model's own tool result. Appended once, by recovery, in the same commit that records the request's final outcome, independent of the run that made the call; callId joins it to that call's tool.result, approvalId to its approval, and operationId to its financial request. result has the shape the tool itself returns, with its solana detail; show it in place of the call's earlier unconfirmed result.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a solana.reconciled event.
Validation rules
- Exact value
"solana.reconciled"
payloadobjectrequiredThe solana.reconciled event's own fields.
Show attributes
The solana.reconciled event's own fields.
approvalIdstring · uuidrequiredThe approval that authorized the call.
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)$"
operationIdstring · uuidrequiredThe durable financial request this answer belongs to.
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)$"
callIdstringrequiredThe tool call whose own result this answer supersedes, as tool.result names it.
Validation rules
- Minimum length
1- Maximum length
256
toolstringrequiredThe Solana buy, sell, multi-coin sale or withdrawal whose outcome is now known.
Validation rules
- Allowed values
["solana_buy","solana_sell","solana_sell_many","solana_withdraw"]
resultanyOfrequiredThe confirmed ending, in the shape the tool itself returns, with its solana detail.
Show attributes
The confirmed ending, in the shape the tool itself returns, with its solana detail.
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 26 · type: prediction.order
The latest observation of a Polymarket order. Replace the original placement call's result, joined by callId, with result. A match is not settlement; cancellation stops only the unmatched part and does not reverse earlier fills. Observations can arrive after the run ends.
seqintegerrequiredThe event's position in the conversation's journal; strictly increasing.
Validation rules
- Minimum
-9007199254740991- Maximum
9007199254740991
conversationIdstring · uuidrequiredThe 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)$"
createdAtstring · date-timerequiredWhen this event was appended to the journal.
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))$"
requestIdstring or nullrequiredThe request that produced this event, when one did; null for scheduler and recovery writes.
typestringrequiredIdentifies this as a prediction.order event.
Validation rules
- Exact value
"prediction.order"
payloadobjectrequiredThe original Polymarket order's latest observed state, not a new placement.
Show attributes
The original Polymarket order's latest observed state, not a new placement.
approvalIdstring · uuidrequiredThe approval that authorized the call.
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)$"
operationIdstring · uuidrequiredThe durable financial request this answer belongs to.
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)$"
callIdstringrequiredThe tool call whose own result this answer supersedes, as tool.result names it.
Validation rules
- Minimum length
1- Maximum length
256
toolstringrequiredValidation rules
- Exact value
"prediction_order_place"
resultoneOfrequiredShow attributes
oneOf · 2 variants
Variant 1 · status: submitted
statusstringrequiredValidation rules
- Exact value
"submitted"
operationIdstring · uuidrequiredValidation 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)$"
orderobjectrequiredShow attributes
marketIdstringrequiredValidation rules
- Pattern
"^[1-9][0-9]{0,19}$"
assetIdstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,77})$"
marketQuestionstringrequiredValidation rules
- Minimum length
1- Maximum length
1000
outcomestringrequiredValidation rules
- Minimum length
1- Maximum length
256
sidestringrequiredValidation rules
- Allowed values
["BUY","SELL"]
limitPriceUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
quantityoneOfrequiredShow attributes
oneOf · 2 variants
Variant 1 · kind: shares
kindstringrequiredValidation rules
- Exact value
"shares"
sizeSharesDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
Variant 2 · kind: budget
kindstringrequiredValidation rules
- Exact value
"budget"
amountUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
orderTypestringrequiredValidation rules
- Allowed values
["GTC","GTD","FOK","FAK"]
expiresAtintegeroptionalValidation rules
- Minimum
0- Maximum
253402300799
maxFeeUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
maxSpendUsdDecimalstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
observationobjectrequiredShow attributes
orderIdstringrequiredValidation rules
- Pattern
"^0x[0-9a-f]{64}$"
statusstringrequiredValidation rules
- Allowed values
["live","partially_filled","matched","filled","cancelled","expired","rejected","uncertain"]
originalSizeRawstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,77})$"
matchedSizeRawstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,77})$"
remainingSizeRawstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,77})$"
tradesarrayrequiredShow attributes
Validation rules
- Maximum items
1000
Array items · object
tradeIdstringrequiredValidation rules
- Minimum length
1- Maximum length
128
statusstringrequiredValidation rules
- Allowed values
["MATCHED","MINED","CONFIRMED","RETRYING","FAILED"]
sizeRawstringrequiredValidation rules
- Pattern
"^(0|[1-9][0-9]{0,77})$"
transactionHashstringoptionalValidation rules
- Pattern
"^0x[0-9a-f]{64}$"
observedAtMsintegerrequiredValidation rules
- Minimum
0- Maximum
9007199254740991
settledCollateralRawstringoptionalValidation rules
- Pattern
"^(0|[1-9][0-9]{0,77})$"
settledFeeRawstringoptionalValidation rules
- Pattern
"^(0|[1-9][0-9]{0,77})$"
cancelRequestedbooleanoptionalpolymarketErrorobjectoptionalWhat Polymarket answered when the order was sent, when it answered with an error: kept with the order for good. Absent when Polymarket gave no reason.
Show attributes
What Polymarket answered when the order was sent, when it answered with an error: kept with the order for good. Absent when Polymarket gave no reason.
httpStatusintegeroptionalThe HTTP status Polymarket answered with, when it answered with an error status.
Validation rules
- Minimum
100- Maximum
599
messagestringrequiredPolymarket's own words, exactly as it answered, cut to their first 300 characters.
Validation rules
- Minimum length
1- Maximum length
300
Variant 2 · status: blocked
statusstringrequiredValidation rules
- Exact value
"blocked"
reasonstringrequiredValidation rules
- Minimum length
1- Maximum length
256
nextCursorstring or nullrequiredThe cursor for the next page, or null at the end as of this read; a live conversation may append more.
400 The request could not be read as this operation expects.
The request could not be read as this operation expects.
invalid_input— the body or query failed validation;issuesnames each fieldinvalid_cursor— thecursoris not one this list minted
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
401 A credential is missing, invalid or expired.
A credential is missing, invalid or expired.
partner_key_required— noX-Api-Keyheader was sentpartner_key_invalid— theX-Api-Keyis unknown or revokedcredential_expired— the user token has expired; obtain a fresh one
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
403 The credentials are valid but may not do this.
The credentials are valid but may not do this.
subject_mismatch— the{userId}in the path is not the token's useraccount_disabled— an operator disabled the accountorigin_rejected— a browserOriginother than the configured web originpermission_required— the verified credential is not permitted to make this call
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
404 The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.
The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
429 A limit refused the request; wait for `Retry-After` when it is sent.
A limit refused the request; wait for Retry-After when it is sent.
rate_limited— the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity— this partner's request quota across all keys and replicas is spent; honour Retry-After
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
500 A fault on our side; quote `requestId` when reporting it.
A fault on our side; quote requestId when reporting it.
internal— a fault on our side; quoterequestIdwhen reporting it
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
503 The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); `retryable` says whether to try again.
The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); retryable says whether to try again.
internal— a fault on our side; quoterequestIdwhen reporting it
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(429) — no capacity is free to run this right now; honourRetry-Afterexecution_unavailable(503) — the service that runs the agent could not take the work;retryablesays whether to try againstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — the automation changed while this request was handled; read it again and retryautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_paused(409) — the automation is paused; resume it firstautomation_has_no_webhook(409) — the automation does not run on incoming events, so it has no webhookautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(400) —profile.toolsnames a tool this deployment does not havedeployment_paused(503) — an operator paused this kind of work for the deployment; try again laterrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amountswap_changed(409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quoteorder_changed(409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it againprediction_order_changed(409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it againsolana_trade_changed(409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it againtrade_not_recoverable(409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be usedorder_not_cancelable(409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it standsgrid_not_active(409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it standsgrid_not_paused(409) — the grid is not paused, so there is nothing to resume. Read the grid for where it standssuggestion_changed(409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions againrequest_key_conflict(409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new requestquestion_not_pending(409) — the questionnaire has already been answered, closed, or is not awaiting this submissionflag_changed(409) — the flag's targeting changed since you read it; read it again and retrygroup_changed(409) — the group changed or was deleted since you read it; read it again and retrygroup_in_use(409) — a flag's rules still name this group; take it out of those rules firstgroup_name_taken(409) — another group already has this nameagent_wallet_required(409) — create the agent wallet before opening a perps, prediction-market or Solana accountwallet_account_unsupported(409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session insteadconversation_deleted(410) — the conversation was deleted; its history stays readableautomation_deleted(410) — the automation was deletedgrid_ended(410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chatcredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountperps_disabled(403) — perps is not enabled for this userprediction_disabled(403) — prediction-market trading is not enabled for this usersolana_disabled(403) — Solana trading is not enabled for this userno_account(404) — the user has not opened the account this call reads; open it firstnot_available_in_region(403) — perps funding is unavailable in the user's region for this request; withdrawals remain availablesteering_disabled(403) — steering a working run is not turned on for this user; send the message with Start a run once the run endsbaskets_disabled(403) — idea baskets are not turned on for this user; hide the Ideas pages and their basketsbasket_buying(409) — the basket is still buying, so it cannot be deleted yet; try again once its result is inbasket_awaiting_approval(409) — an approval to buy this basket is still open; decline it in the chat, then delete the basketbasket_step_not_failed(409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket againbasket_step_linked(409) — another order is already linked to this step; a link is permanent, so read the basket againbasket_order_not_linkable(400) — the order cannot stand in for this step: it is not one of the step'sfailures[].linkableorders, or another basket step already holds itvoice_disabled(403) — voice input is not turned on for this user; let them type insteadvoice_unavailable(503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type insteadprovider_unavailable(503) — an external provider the call depends on did not answerquote_refused(400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another networkinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the verified credential is not permitted to make this callsignature_required(403) — creating the agent wallet needs the user's signature: send the user's signature ofcreation.messagefrom Get the agent wallet asauthorizationasset_not_withdrawable(403) — tokenized stocks cannot be withdrawn; sell them firstasset_not_swappable(403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offasset_not_tradable(403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with nocontext.country, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user'searnflag is offsolana_token_not_tradable(403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landinglimit_orders_disabled(403) — limit orders are not enabled for this usergrid_trading_disabled(403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gateddeposit_limit_exceeded(429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. ReaddepositLimit.availableCentsfrom Get balances for how much fits now, and deposit no more than thatpolicy_change_throttled(429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again onceRetry-Afterhas passedagent_slippage_exceeded(403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (max_slippage_bps): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss boundagent_api_orders_unavailable(403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signeddestination_not_allowed(403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signedrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterpartner_request_capacity(429) — this partner's request quota across all keys and replicas is spent; honour Retry-Afterpartner_run_capacity(429) — this partner's active run quota is full; honour Retry-After and reuse the same request identitystream_capacity(429) — the partner, user or replica has no free stream capacity; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list mintedinvalid_question_answer(400) — the questionnaire answer does not match its questions or allowed choicesquestion_closed(410) — the questionnaire expired or was cancelledunknown_target(400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule namesscope_invalid(400) — a subject in the scope is not a subject id, or appears twicesubject_unsupported(404) — a subject in the scope is not one market briefs cover; list them with List market subjectsbrief_not_found(404) — no market brief job with this id was created with your partner keybriefs_busy(429) — your market briefs are at their limit of briefs generating at once; retry afterRetry-Aftermarket_briefs_disabled(403) — market briefs are not turned on for your partner keystory_not_found(404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_paused","automation_has_no_webhook","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","swap_changed","order_changed","prediction_order_changed","solana_trade_changed","trade_not_recoverable","order_not_cancelable","grid_not_active","grid_not_paused","suggestion_changed","request_key_conflict","question_not_pending","flag_changed","group_changed","group_in_use","group_name_taken","agent_wallet_required","wallet_account_unsupported","conversation_deleted","automation_deleted","grid_ended","credential_expired","account_disabled","perps_disabled","prediction_disabled","solana_disabled","no_account","not_available_in_region","steering_disabled","baskets_disabled","basket_buying","basket_awaiting_approval","basket_step_not_failed","basket_step_linked","basket_order_not_linkable","voice_disabled","voice_unavailable","provider_unavailable","quote_refused","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","signature_required","asset_not_withdrawable","asset_not_swappable","asset_not_tradable","solana_token_not_tradable","limit_orders_disabled","grid_trading_disabled","deposit_limit_exceeded","policy_change_throttled","agent_slippage_exceeded","agent_api_orders_unavailable","destination_not_allowed","rate_limited","partner_request_capacity","partner_run_capacity","stream_capacity","invalid_cursor","invalid_question_answer","question_closed","unknown_target","scope_invalid","subject_unsupported","brief_not_found","briefs_busy","market_briefs_disabled","story_not_found"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
Complete OpenAPI definition
The exact operation and all referenced components, including recursive schemas.
{
"operation": {
"operationId": "events.list",
"summary": "List a conversation's events",
"tags": [
"events"
],
"description": "Returns a conversation's saved events, oldest first: messages, runs, approvals and trade updates. Use it to load history or catch up after being offline; pass `nextCursor` back as `cursor` to continue. For live updates use Stream a conversation's events.",
"parameters": [
{
"schema": {
"type": "string",
"maxLength": 256
},
"in": "query",
"name": "cursor",
"required": false,
"description": "An `after` cursor from the previous page; omit to read from the beginning."
},
{
"schema": {
"default": 500,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"in": "query",
"name": "limit",
"required": false,
"description": "How many events to answer, at most 1000"
},
{
"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": "conversationId",
"required": true,
"description": "The conversation's id."
}
],
"security": [
{
"apiKey": [],
"userToken": []
}
],
"responses": {
"200": {
"description": "A page of the conversation's saved events.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinEvent"
},
"description": "This page's events, oldest first."
},
"nextCursor": {
"description": "The cursor for the next page, or null at the end as of this read; a live conversation may append more.",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"nextCursor"
]
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidInput"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
},
"500": {
"$ref": "#/components/responses/Internal"
},
"503": {
"$ref": "#/components/responses/Unavailable"
}
}
},
"components": {
"schemas": {
"FinEvent": {
"oneOf": [
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "run.started",
"description": "Identifies this as a `run.started` event."
},
"payload": {
"type": "object",
"properties": {
"input": {
"type": "string",
"description": "The user's message, or the automation's triggering text, that this run processes."
},
"origin": {
"description": "Which automation triggered this run; absent for an ordinary user turn.",
"type": "object",
"properties": {
"automationId": {
"type": "string",
"description": "The automation that started this run."
},
"name": {
"type": "string",
"description": "The automation's name at the time it started this run."
}
},
"required": [
"automationId",
"name"
]
},
"runId": {
"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 run this event opened, so a client following the stream can name it (to stop it)."
}
},
"required": [
"input",
"runId"
],
"description": "The `run.started` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "Opens a new run: the engine admitted it and is about to process the input, whether an ordinary turn or an automation firing. Emitted once, at admission — a run resumed after an approval does not get a second one. `run.ended` closes what this event opened."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "run.ended",
"description": "Identifies this as a `run.ended` event."
},
"payload": {
"type": "object",
"properties": {
"runId": {
"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 admitted root run that reached its terminal state."
},
"status": {
"type": "string",
"enum": [
"completed",
"aborted",
"failed"
],
"description": "The terminal result of the root run; approval waits do not end it."
},
"usage": {
"description": "Token counts and cost for this run, once its accounting settles.",
"type": "object",
"properties": {
"inputTokens": {
"type": "number",
"description": "How many input tokens the run consumed."
},
"outputTokens": {
"type": "number",
"description": "How many output tokens the run produced."
},
"costCents": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)$",
"description": "The run's cost, in whole USD cents."
},
"costUncertain": {
"type": "boolean",
"description": "True when the exact provider cost could not be confirmed and `costCents` is a best-effort estimate."
}
},
"required": [
"inputTokens",
"outputTokens",
"costCents",
"costUncertain"
]
},
"error": {
"description": "The run's failure message, present when `status` is `failed`.",
"type": "string"
},
"failure": {
"description": "Structured cause of a failed run: its `code`, `stage` and optional provider detail. Present when `status` is `failed`; absent on runs that failed before this field existed.",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"model_timeout",
"model_invalid_output",
"execution_deadline",
"provider_rate_limit",
"provider_unavailable",
"provider_authentication",
"internal_error",
"context_too_large",
"daily_budget_exhausted",
"monthly_budget_exhausted",
"budget_frozen",
"partner_daily_budget_exhausted",
"partner_monthly_budget_exhausted",
"unknown"
],
"description": "Why the execution failed: `model_timeout` (the model was too slow to respond), `execution_deadline` (the run's active time limit elapsed before it finished), `provider_rate_limit` or `provider_unavailable` (classified from HTTP status or a connection/body-read failure observed by the host), `model_invalid_output` (terminal structured output still failed its required format after bounded repair), `context_too_large` (the request stayed over the model's context window after the host condensed earlier history and retried once), `daily_budget_exhausted`, `monthly_budget_exhausted` or `budget_frozen` (the user's AI budget for the UTC day or month, or an operator's freeze on it, left no room for the run's next model request), `partner_daily_budget_exhausted` or `partner_monthly_budget_exhausted` (the partner account's AI spend limit for the UTC day or month left no room for it), `internal_error` (a host-side fault), or `unknown` when nothing more specific was classified. A budget or spend-limit code means a limit stopped the run, not that the model failed; trying again fails the same way until the limit clears. A raised user budget or a lifted freeze applies at once; a raised partner limit applies from the next UTC day or month, because the open period keeps the cap it started with."
},
"stage": {
"type": "string",
"enum": [
"model_request",
"tool_execution",
"finalization"
],
"description": "Which phase of the run was executing when it failed: `model_request` while calling or awaiting the model provider, `tool_execution` while running or resuming a tool call, or `finalization` while settling the run's output and accounting after the model finished."
},
"providerMessage": {
"description": "The model provider's own error text, when one was available: credential values are redacted and it is cut to 256 characters, but it is not a content classifier, so other sensitive detail may remain. Treat it as diagnostic context only — never branch on it, and review before showing it to an end user.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"diagnosticReference": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "This failed run's own id, repeated here as one field to cite when asking support to check the host's internal logs for this execution; it carries no meaning beyond that."
}
},
"required": [
"code",
"stage",
"diagnosticReference"
]
}
},
"required": [
"runId",
"status"
],
"description": "The `run.ended` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "The root run reached a terminal state: completed, failed or aborted. Its runId is the same as run.started and every pause/resume. Waiting for approval emits run.paused instead. Accounting includes all continuation segments."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "run.paused",
"description": "Identifies this as a `run.paused` event."
},
"payload": {
"type": "object",
"properties": {
"runId": {
"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 admitted root run, retained across approval waits and continuations."
}
},
"required": [
"runId"
],
"description": "The run is waiting for approval; it has not finished."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "The run is waiting for human input or approval. Its identity and original request remain unchanged."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "run.resumed",
"description": "Identifies this as a `run.resumed` event."
},
"payload": {
"type": "object",
"properties": {
"runId": {
"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 same root run that paused."
}
},
"required": [
"runId"
],
"description": "The paused run has resumed after an approval decision."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "An approval decision resumed the same root run. No new instruction or run identity was created."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "run.steered",
"description": "Identifies this as a `run.steered` event."
},
"payload": {
"type": "object",
"properties": {
"runId": {
"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 run the message was sent to; it keeps working."
},
"steerId": {
"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 message's id, as the run's `steers` entry names it."
},
"text": {
"type": "string",
"description": "The user's message, as they sent it."
}
},
"required": [
"runId",
"steerId",
"text"
],
"description": "The `run.steered` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "The agent read a message the user sent while the run was working (Steer a run). Emitted at the agent's next step, before its next reply, so it lands in the conversation where the agent saw it; `steerId` matches the run's `steers` entry. Several messages sent within one step each get their own event, in the order sent. The same run continues; a message the run ended before reading never gets one."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "agent.entry",
"description": "Identifies this as an `agent.entry` event."
},
"payload": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"assistant",
"tool"
],
"description": "Who this message is from: `user`, `assistant`, or `tool` for a tool's own display text."
},
"text": {
"type": "string",
"description": "The message's display text."
},
"interrupted": {
"description": "Present on an assistant draft whose model response did not complete. Preserve it as interrupted even if the run later recovers and completes.",
"type": "boolean",
"const": true
},
"tool": {
"description": "Which tool this entry displays the result of; present only when `role` is `tool`.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The tool's public name."
},
"outcome": {
"oneOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "completed",
"description": "The tool ran and returned a result."
},
"result": {
"description": "The tool's own result value."
},
"financialFailures": {
"description": "Bounded financial failure display evidence. The tool result and spending authority are unchanged.",
"type": "object",
"properties": {
"nodeFailures": {
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15
},
"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"
]
},
"category": {
"type": "string",
"enum": [
"price_limit",
"insufficient_funds",
"unavailable",
"integrity",
"dependency",
"expired",
"authority",
"conflict",
"stopped",
"request_blocked",
"unknown"
]
},
"diagnostic": {
"type": "object",
"properties": {
"rule": {
"type": "string",
"enum": [
"quote_floor",
"quote_ceiling"
]
},
"classification": {
"type": "string",
"const": "terms"
},
"expectedAtomic": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"observedAtomic": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"inputTokenId": {
"type": "string",
"maxLength": 256,
"pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
"description": "The exact ledger asset identifier, including its token standard namespace."
},
"outputTokenId": {
"type": "string",
"maxLength": 256,
"pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
"description": "The exact ledger asset identifier, including its token standard namespace."
}
},
"required": [
"rule",
"classification",
"expectedAtomic",
"observedAtomic",
"inputTokenId",
"outputTokenId"
]
}
},
"required": [
"index",
"reason",
"category"
]
}
},
"preflightFailure": {
"type": "object",
"properties": {
"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"
]
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15
},
"diagnostic": {
"type": "object",
"properties": {
"rule": {
"type": "string",
"enum": [
"quote_floor",
"quote_ceiling"
]
},
"classification": {
"type": "string",
"const": "terms"
},
"expectedAtomic": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"observedAtomic": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"inputTokenId": {
"type": "string",
"maxLength": 256,
"pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
"description": "The exact ledger asset identifier, including its token standard namespace."
},
"outputTokenId": {
"type": "string",
"maxLength": 256,
"pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
"description": "The exact ledger asset identifier, including its token standard namespace."
}
},
"required": [
"rule",
"classification",
"expectedAtomic",
"observedAtomic",
"inputTokenId",
"outputTokenId"
]
}
},
"required": [
"reason"
]
},
"recoverable": {
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15
},
"kind": {
"type": "string",
"enum": [
"unclaimed",
"refunded",
"not_executed"
]
}
},
"required": [
"index",
"kind"
]
}
},
"recovery": {
"description": "Root operations omit this. A recovery child carries a proved original-action map, or null when no safe map is available; null disables recovery controls.",
"anyOf": [
{
"type": "object",
"properties": {
"operationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"originalIndices": {
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 15
}
},
"maxValueLossBps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$"
}
},
"required": [
"operationId",
"originalIndices",
"maxValueLossBps"
]
},
{
"type": "null"
}
]
}
}
},
"providerRef": {
"description": "The upstream provider's own reference, when it returned one.",
"type": "string"
}
},
"required": [
"status",
"result"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "denied",
"description": "The call was refused before it ran."
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"denied",
"egress_denied",
"invalid_input",
"execution_failed"
],
"description": "Why the tool call did not produce a result: `denied` by policy or the user, `egress_denied` for a network destination the tool cannot reach, `invalid_input` for arguments the tool rejected, or `execution_failed` for a fault while it ran."
},
"message": {
"type": "string",
"description": "A human-readable explanation of the failure."
},
"hint": {
"description": "A suggestion for what to try instead, when there is one.",
"type": "string"
},
"recovery": {
"type": "string",
"enum": [
"wait",
"owner",
"none"
],
"description": "Who can fix the failure: `wait` when the same request may succeed later without anyone acting and nothing was signed or sent, `owner` when it fails the same way until the owner acts (the remedy says how), or `none` when this attempt cannot succeed and neither waiting nor the owner changes that, though a later run may. A failure that names no class is `none`."
},
"remedy": {
"type": "string",
"enum": [
"add_funds",
"edit_automation"
],
"description": "What the owner does about an `owner` failure: `add_funds` of the asset the action spends or sells, or `edit_automation` to change its terms."
},
"retryAfterSeconds": {
"description": "For a `wait` failure, how long the failing service asked to wait before the same request is repeated, in whole seconds.",
"type": "integer",
"minimum": 1,
"maximum": 86400
},
"reference": {
"description": "Correlation for diagnosis: the request id, or the workflow id of background work. Never a cause.",
"type": "string",
"maxLength": 128
}
},
"required": [
"code",
"message"
],
"description": "Why the call was denied."
}
},
"required": [
"status",
"error"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "pending_approval",
"description": "The call is parked, waiting on a human decision."
},
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"summary": {
"type": "string",
"description": "A short human-readable summary of what approving this would do."
}
},
"required": [
"status",
"approvalId",
"summary"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "failed",
"description": "The call ran but did not complete successfully."
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"denied",
"egress_denied",
"invalid_input",
"execution_failed"
],
"description": "Why the tool call did not produce a result: `denied` by policy or the user, `egress_denied` for a network destination the tool cannot reach, `invalid_input` for arguments the tool rejected, or `execution_failed` for a fault while it ran."
},
"message": {
"type": "string",
"description": "A human-readable explanation of the failure."
},
"hint": {
"description": "A suggestion for what to try instead, when there is one.",
"type": "string"
},
"recovery": {
"type": "string",
"enum": [
"wait",
"owner",
"none"
],
"description": "Who can fix the failure: `wait` when the same request may succeed later without anyone acting and nothing was signed or sent, `owner` when it fails the same way until the owner acts (the remedy says how), or `none` when this attempt cannot succeed and neither waiting nor the owner changes that, though a later run may. A failure that names no class is `none`."
},
"remedy": {
"type": "string",
"enum": [
"add_funds",
"edit_automation"
],
"description": "What the owner does about an `owner` failure: `add_funds` of the asset the action spends or sells, or `edit_automation` to change its terms."
},
"retryAfterSeconds": {
"description": "For a `wait` failure, how long the failing service asked to wait before the same request is repeated, in whole seconds.",
"type": "integer",
"minimum": 1,
"maximum": 86400
},
"reference": {
"description": "Correlation for diagnosis: the request id, or the workflow id of background work. Never a cause.",
"type": "string",
"maxLength": 128
}
},
"required": [
"code",
"message"
],
"description": "Why the call failed."
}
},
"required": [
"status",
"error"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "pending_input",
"description": "The call is paused for a human questionnaire response."
},
"questionId": {
"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 questionnaire the user needs to answer."
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When the questionnaire expires if it remains unanswered."
}
},
"required": [
"status",
"questionId",
"expiresAt"
]
}
],
"description": "The call's outcome: completed, denied, parked for approval or input, or failed."
}
},
"required": [
"name",
"outcome"
]
}
},
"required": [
"role",
"text"
],
"description": "The `agent.entry` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "One durable message in the conversation: the user's message, the assistant's completed reply, or a tool's display text once it resolves. Streaming assistant text arrives first as `agent.text_delta` and lands here only when the turn completes."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "agent.text_delta",
"description": "Identifies this as an `agent.text_delta` event."
},
"payload": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The chunk of assistant reply text this delta adds."
}
},
"required": [
"text"
],
"description": "The `agent.text_delta` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "A chunk of the assistant's reply while it is still generating. Delivered live only — never written to the durable journal or replayed on reconnect — and superseded by the complete text in the `agent.entry` that follows."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "tool.call",
"description": "Identifies this as a `tool.call` event."
},
"payload": {
"type": "object",
"properties": {
"callId": {
"description": "This call's id, so later events (`approval.opened`, `tool.result`) can be matched to it.",
"type": "string"
},
"tool": {
"type": "string",
"description": "The tool's public name."
},
"input": {
"description": "The call's arguments, scrubbed for public display."
},
"batch": {
"description": "The calls the agent asked for together in one step. They arrive together in `index` order, and the agent reads every result before its next step, so you can draw them as one group. A call asked for alone has `size` 1. Absent on calls made before this field existed.",
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 63,
"description": "This call's place among them, from 0."
},
"size": {
"type": "integer",
"minimum": 1,
"maximum": 64,
"description": "How many calls the agent asked for together, this one included."
}
},
"required": [
"index",
"size"
]
},
"origin": {
"description": "Written by the retired standalone CLI door; kept so its journals still parse.",
"type": "string",
"const": "cli"
}
},
"required": [
"tool",
"input"
],
"description": "The `tool.call` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "The assistant asked to call a tool. Emitted once the call is committed to the conversation, before it runs; `approval.opened` follows if a human must decide first, otherwise the call proceeds straight to `tool.result`."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "tool.result",
"description": "Identifies this as a `tool.result` event."
},
"payload": {
"type": "object",
"properties": {
"callId": {
"description": "This call's id, matching the `tool.call` it resolves.",
"type": "string"
},
"callSeq": {
"description": "With `origin`, the retired CLI door's way of pairing a result to its call; historical only.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"tool": {
"type": "string",
"description": "The tool's public name."
},
"outcome": {
"oneOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "completed",
"description": "The tool ran and returned a result."
},
"result": {
"description": "The tool's own result value."
},
"financialFailures": {
"description": "Bounded financial failure display evidence. The tool result and spending authority are unchanged.",
"type": "object",
"properties": {
"nodeFailures": {
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15
},
"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"
]
},
"category": {
"type": "string",
"enum": [
"price_limit",
"insufficient_funds",
"unavailable",
"integrity",
"dependency",
"expired",
"authority",
"conflict",
"stopped",
"request_blocked",
"unknown"
]
},
"diagnostic": {
"type": "object",
"properties": {
"rule": {
"type": "string",
"enum": [
"quote_floor",
"quote_ceiling"
]
},
"classification": {
"type": "string",
"const": "terms"
},
"expectedAtomic": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"observedAtomic": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"inputTokenId": {
"type": "string",
"maxLength": 256,
"pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
"description": "The exact ledger asset identifier, including its token standard namespace."
},
"outputTokenId": {
"type": "string",
"maxLength": 256,
"pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
"description": "The exact ledger asset identifier, including its token standard namespace."
}
},
"required": [
"rule",
"classification",
"expectedAtomic",
"observedAtomic",
"inputTokenId",
"outputTokenId"
]
}
},
"required": [
"index",
"reason",
"category"
]
}
},
"preflightFailure": {
"type": "object",
"properties": {
"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"
]
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15
},
"diagnostic": {
"type": "object",
"properties": {
"rule": {
"type": "string",
"enum": [
"quote_floor",
"quote_ceiling"
]
},
"classification": {
"type": "string",
"const": "terms"
},
"expectedAtomic": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"observedAtomic": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"inputTokenId": {
"type": "string",
"maxLength": 256,
"pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
"description": "The exact ledger asset identifier, including its token standard namespace."
},
"outputTokenId": {
"type": "string",
"maxLength": 256,
"pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
"description": "The exact ledger asset identifier, including its token standard namespace."
}
},
"required": [
"rule",
"classification",
"expectedAtomic",
"observedAtomic",
"inputTokenId",
"outputTokenId"
]
}
},
"required": [
"reason"
]
},
"recoverable": {
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15
},
"kind": {
"type": "string",
"enum": [
"unclaimed",
"refunded",
"not_executed"
]
}
},
"required": [
"index",
"kind"
]
}
},
"recovery": {
"description": "Root operations omit this. A recovery child carries a proved original-action map, or null when no safe map is available; null disables recovery controls.",
"anyOf": [
{
"type": "object",
"properties": {
"operationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"originalIndices": {
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 15
}
},
"maxValueLossBps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$"
}
},
"required": [
"operationId",
"originalIndices",
"maxValueLossBps"
]
},
{
"type": "null"
}
]
}
}
},
"providerRef": {
"description": "The upstream provider's own reference, when it returned one.",
"type": "string"
}
},
"required": [
"status",
"result"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "denied",
"description": "The call was refused before it ran."
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"denied",
"egress_denied",
"invalid_input",
"execution_failed"
],
"description": "Why the tool call did not produce a result: `denied` by policy or the user, `egress_denied` for a network destination the tool cannot reach, `invalid_input` for arguments the tool rejected, or `execution_failed` for a fault while it ran."
},
"message": {
"type": "string",
"description": "A human-readable explanation of the failure."
},
"hint": {
"description": "A suggestion for what to try instead, when there is one.",
"type": "string"
},
"recovery": {
"type": "string",
"enum": [
"wait",
"owner",
"none"
],
"description": "Who can fix the failure: `wait` when the same request may succeed later without anyone acting and nothing was signed or sent, `owner` when it fails the same way until the owner acts (the remedy says how), or `none` when this attempt cannot succeed and neither waiting nor the owner changes that, though a later run may. A failure that names no class is `none`."
},
"remedy": {
"type": "string",
"enum": [
"add_funds",
"edit_automation"
],
"description": "What the owner does about an `owner` failure: `add_funds` of the asset the action spends or sells, or `edit_automation` to change its terms."
},
"retryAfterSeconds": {
"description": "For a `wait` failure, how long the failing service asked to wait before the same request is repeated, in whole seconds.",
"type": "integer",
"minimum": 1,
"maximum": 86400
},
"reference": {
"description": "Correlation for diagnosis: the request id, or the workflow id of background work. Never a cause.",
"type": "string",
"maxLength": 128
}
},
"required": [
"code",
"message"
],
"description": "Why the call was denied."
}
},
"required": [
"status",
"error"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "pending_approval",
"description": "The call is parked, waiting on a human decision."
},
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"summary": {
"type": "string",
"description": "A short human-readable summary of what approving this would do."
}
},
"required": [
"status",
"approvalId",
"summary"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "failed",
"description": "The call ran but did not complete successfully."
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"denied",
"egress_denied",
"invalid_input",
"execution_failed"
],
"description": "Why the tool call did not produce a result: `denied` by policy or the user, `egress_denied` for a network destination the tool cannot reach, `invalid_input` for arguments the tool rejected, or `execution_failed` for a fault while it ran."
},
"message": {
"type": "string",
"description": "A human-readable explanation of the failure."
},
"hint": {
"description": "A suggestion for what to try instead, when there is one.",
"type": "string"
},
"recovery": {
"type": "string",
"enum": [
"wait",
"owner",
"none"
],
"description": "Who can fix the failure: `wait` when the same request may succeed later without anyone acting and nothing was signed or sent, `owner` when it fails the same way until the owner acts (the remedy says how), or `none` when this attempt cannot succeed and neither waiting nor the owner changes that, though a later run may. A failure that names no class is `none`."
},
"remedy": {
"type": "string",
"enum": [
"add_funds",
"edit_automation"
],
"description": "What the owner does about an `owner` failure: `add_funds` of the asset the action spends or sells, or `edit_automation` to change its terms."
},
"retryAfterSeconds": {
"description": "For a `wait` failure, how long the failing service asked to wait before the same request is repeated, in whole seconds.",
"type": "integer",
"minimum": 1,
"maximum": 86400
},
"reference": {
"description": "Correlation for diagnosis: the request id, or the workflow id of background work. Never a cause.",
"type": "string",
"maxLength": 128
}
},
"required": [
"code",
"message"
],
"description": "Why the call failed."
}
},
"required": [
"status",
"error"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "pending_input",
"description": "The call is paused for a human questionnaire response."
},
"questionId": {
"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 questionnaire the user needs to answer."
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When the questionnaire expires if it remains unanswered."
}
},
"required": [
"status",
"questionId",
"expiresAt"
]
}
],
"description": "The call's outcome: completed, denied, parked for approval or input, or failed."
},
"origin": {
"description": "Written by the retired standalone CLI door; kept so its journals still parse.",
"type": "string",
"const": "cli"
}
},
"required": [
"tool",
"outcome"
],
"description": "The `tool.result` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "One tool call resolved: `outcome` says what happened (completed, denied, parked for approval, or failed). Immediately followed by an `agent.entry` (role `tool`) carrying that outcome's own display text."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "approval.opened",
"description": "Identifies this as an `approval.opened` event."
},
"payload": {
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"callId": {
"description": "The tool call this approval parks; absent for direct operations without a model call.",
"type": "string"
},
"tool": {
"type": "string",
"description": "The tool name awaiting approval."
},
"input": {
"description": "The call's arguments, as shown on the approval card."
},
"summary": {
"type": "string",
"description": "A short human-readable summary of what approving this would do."
},
"contract": {
"description": "Effective terms rendered before approval; absent for tools without authorization contracts.",
"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/LimitOrderContract"
},
{
"$ref": "#/components/schemas/PerpsTransferContract"
},
{
"$ref": "#/components/schemas/PerpsOrderContract"
},
{
"$ref": "#/components/schemas/PerpsCancelContract"
},
{
"$ref": "#/components/schemas/PerpsAutomationContract"
},
{
"$ref": "#/components/schemas/PerpsMarginContract"
},
{
"$ref": "#/components/schemas/PredictionFundContract"
},
{
"$ref": "#/components/schemas/SolanaBuyContract"
},
{
"$ref": "#/components/schemas/SolanaSellContract"
},
{
"$ref": "#/components/schemas/SolanaFundContract"
},
{
"$ref": "#/components/schemas/SolanaWithdrawContract"
},
{
"$ref": "#/components/schemas/PredictionOrderContract"
},
{
"$ref": "#/components/schemas/PredictionWithdrawContract"
},
{
"$ref": "#/components/schemas/CompositeContract"
},
{
"$ref": "#/components/schemas/PredictionAutomationContract"
},
{
"$ref": "#/components/schemas/SolanaSellManyContract"
},
{
"$ref": "#/components/schemas/GridContract"
},
{
"$ref": "#/components/schemas/PerpsFreedWithdrawalContract"
},
{
"$ref": "#/components/schemas/PredictionFreedWithdrawalContract"
}
]
},
"executionRestriction": {
"description": "Set when this approval disallows automatic signing; fixed when the approval opened, never inferred from the current UI mode.",
"type": "string",
"const": "signing_disabled"
},
"expiresAt": {
"description": "When the parked decision lapses; optional so journal entries written before it still parse.",
"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))$"
}
},
"required": [
"approvalId",
"tool",
"input",
"summary"
],
"description": "The `approval.opened` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "A tool call is parked, waiting on a human decision. Carries the terms the approval card renders: the call's input, a summary, and the authorization contract in effect, if any. `approval.decided` or `approval.expired` closes it."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "approval.decided",
"description": "Identifies this as an `approval.decided` event."
},
"payload": {
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"approve": {
"type": "boolean",
"description": "True when the user approved; false when denied."
},
"reason": {
"description": "The user's reason, mainly given with a denial.",
"type": "string"
},
"attestation": {
"description": "The partner-side confirmation cited for the decision; never verified by fin.",
"type": "object",
"properties": {
"reference": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The partner's own reference for its confirmation."
}
},
"required": [
"reference"
]
},
"decidedBy": {
"description": "Which integration released it; absent on journals written before v1, null for the deployment's own app.",
"type": "object",
"properties": {
"partnerKeyId": {
"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 partner key that released this decision; null for the deployment's own app."
}
},
"required": [
"partnerKeyId"
]
}
},
"required": [
"approvalId",
"approve"
],
"description": "The `approval.decided` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "The user, or a partner integration, approved or denied a parked approval. `approve` says which way; a denial may carry `reason`. Consuming the decision to execute the tool follows as `approval.consumed`, but only when the decision was an approval — a denial never reaches consumption."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "question.opened",
"description": "Identifies this as a `question.opened` event."
},
"payload": {
"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 questionnaire's unique id."
},
"conversationId": {
"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 containing this questionnaire."
},
"runId": {
"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 run waiting for this questionnaire."
},
"callId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The tool call that opened this questionnaire."
},
"questions": {
"minItems": 1,
"maxItems": 5,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The stable id used to match this question with its answer."
},
"label": {
"description": "Optional short title for this question.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"prompt": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "The question text shown to the user."
},
"options": {
"minItems": 2,
"maxItems": 6,
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "The stable value returned when this option is selected."
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "The text shown to the user for this option."
},
"description": {
"description": "Optional explanation shown with this option.",
"type": "string",
"maxLength": 512
},
"recommended": {
"description": "Whether this is the option the agent recommends: at most one per question, with why in its description.",
"type": "boolean"
},
"picture": {
"description": "A small drawing an app may show over this choice: `schedule` for buying on a regular schedule, `dip` for buying only after a fall, `once` for one buy now. Absent when none fits; an app that draws none shows the choice without it.",
"type": "string",
"enum": [
"schedule",
"dip",
"once"
]
}
},
"required": [
"value",
"label"
],
"description": "One choice presented for a question."
},
"description": "The choices shown for this question."
},
"multiple": {
"description": "Whether the user may select more than one choice.",
"type": "boolean"
},
"amount": {
"type": "object",
"properties": {
"min": {
"type": "string",
"maxLength": 40,
"pattern": "^(0|[1-9]\\d{0,20})(\\.\\d{1,18})?$",
"description": "The smallest amount the slider offers, as a decimal string."
},
"max": {
"type": "string",
"maxLength": 40,
"pattern": "^(0|[1-9]\\d{0,20})(\\.\\d{1,18})?$",
"description": "The largest amount the slider offers, as a decimal string."
},
"step": {
"type": "string",
"maxLength": 40,
"pattern": "^(0|[1-9]\\d{0,20})(\\.\\d{1,18})?$",
"description": "How far one slider step moves, as a decimal string."
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "What the amount counts: \"usd\" for dollars, or a token symbol such as \"USDC\"."
}
},
"required": [
"min",
"max",
"step",
"unit"
],
"description": "Asks for one amount on a slider. The options are its presets, each value a decimal string within min and max; an amount between them is answered as customText."
}
},
"required": [
"id",
"prompt",
"options"
],
"description": "One question and its available choices."
},
"description": "The questions and choices shown to the user."
},
"status": {
"type": "string",
"enum": [
"pending",
"answered",
"skipped",
"expired",
"cancelled"
],
"description": "The current questionnaire status."
},
"answer": {
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "answered",
"description": "The questionnaire was answered."
},
"answers": {
"minItems": 1,
"maxItems": 5,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The id of the question this answer corresponds to."
},
"values": {
"maxItems": 6,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Selected option values; empty when customText is supplied."
},
"customText": {
"description": "Optional user-supplied text in place of selected options.",
"type": "string",
"maxLength": 2048
}
},
"required": [
"id",
"values"
],
"description": "The user's answer to one question."
},
"description": "The selected options or custom text for each question the user answered. A question they skipped has no answer."
}
},
"required": [
"status",
"answers"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "skipped",
"description": "The questionnaire was skipped."
}
},
"required": [
"status"
]
}
],
"description": "The result of answering or skipping a questionnaire."
},
{
"type": "null"
}
],
"description": "The accepted answers or skip result, or null when none was accepted."
},
"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 the questionnaire was created."
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When the questionnaire expires if unanswered."
},
"resolvedAt": {
"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 questionnaire was answered, skipped, expired, or cancelled; null while pending."
}
},
"required": [
"id",
"conversationId",
"runId",
"callId",
"questions",
"status",
"answer",
"createdAt",
"expiresAt",
"resolvedAt"
],
"description": "The `question.opened` event's full resource."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "A questionnaire is waiting for the user. Its full content is durable and replayable."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "question.answered",
"description": "Identifies this as a `question.answered` event."
},
"payload": {
"type": "object",
"properties": {
"questionId": {
"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 questionnaire that was resolved."
},
"answer": {
"oneOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "answered",
"description": "The questionnaire was answered."
},
"answers": {
"minItems": 1,
"maxItems": 5,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "The id of the question this answer corresponds to."
},
"values": {
"maxItems": 6,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Selected option values; empty when customText is supplied."
},
"customText": {
"description": "Optional user-supplied text in place of selected options.",
"type": "string",
"maxLength": 2048
}
},
"required": [
"id",
"values"
],
"description": "The user's answer to one question."
},
"description": "The selected options or custom text for each question the user answered. A question they skipped has no answer."
}
},
"required": [
"status",
"answers"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "skipped",
"description": "The questionnaire was skipped."
}
},
"required": [
"status"
]
}
],
"description": "The user's answers or decision to skip."
},
"resolvedAt": {
"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 questionnaire was answered or skipped."
}
},
"required": [
"questionId",
"answer",
"resolvedAt"
],
"description": "The `question.answered` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "The user answered or skipped a questionnaire; its accepted result is durable."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "question.closed",
"description": "Identifies this as a `question.closed` event."
},
"payload": {
"type": "object",
"properties": {
"questionId": {
"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 questionnaire that was closed."
},
"status": {
"type": "string",
"enum": [
"expired",
"cancelled"
],
"description": "Why the questionnaire closed without an answer."
},
"resolvedAt": {
"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 questionnaire closed."
}
},
"required": [
"questionId",
"status",
"resolvedAt"
],
"description": "The `question.closed` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "A pending questionnaire expired or was cancelled."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "approval.consumed",
"description": "Identifies this as an `approval.consumed` event."
},
"payload": {
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
}
},
"required": [
"approvalId"
],
"description": "The `approval.consumed` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "The approval was spent to authorize its tool call, immediately before that call runs. This is when the call is authorized, not when it finishes: the call can still fail after this event lands, and nothing here rolls it back. Marks the approval used; it cannot authorize a second execution."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "approval.expired",
"description": "Identifies this as an `approval.expired` event."
},
"payload": {
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"reason": {
"type": "string",
"description": "Why the approval expired: the deadline passed, or its run stopped first."
}
},
"required": [
"approvalId",
"reason"
],
"description": "The `approval.expired` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "A parked approval lapsed before anyone decided: its deadline passed, or the run it belongs to stopped while it was still pending."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "automation.fired",
"description": "Identifies this as an `automation.fired` event."
},
"payload": {
"type": "object",
"properties": {
"automationId": {
"type": "string",
"description": "The automation that fired this run."
},
"name": {
"type": "string",
"description": "The automation's name at the time it fired."
}
},
"required": [
"automationId",
"name"
],
"description": "The `automation.fired` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "An automation triggered this conversation's run. Emitted once, immediately before the `run.started` it precedes, naming the automation and its name at fire time."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "intents.settlement",
"description": "Identifies this as an `intents.settlement` event."
},
"payload": {
"oneOf": [
{
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"legId": {
"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": "Which leg of the plan this receipt settles."
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "This leg's position within the plan, counting from zero."
},
"operationId": {
"description": "The durable financial request this evidence belongs to.",
"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)$"
},
"occurrenceId": {
"description": "The archived event's original identity, retained verbatim; current receipts use `operationId`.",
"type": "string",
"minLength": 1,
"maxLength": 160
},
"state": {
"type": "string",
"const": "settled",
"description": "The leg settled: its output asset moved as planned."
},
"output": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The asset's NEP-141 token id."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
},
"amountRaw": {
"description": "The amount, in the token's smallest unit, when it is known.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
}
},
"required": [
"tokenId",
"decimals"
],
"description": "What the leg produced."
}
},
"required": [
"approvalId",
"legId",
"index",
"state",
"output"
]
},
{
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"legId": {
"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": "Which leg of the plan this receipt settles."
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "This leg's position within the plan, counting from zero."
},
"operationId": {
"description": "The durable financial request this evidence belongs to.",
"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)$"
},
"occurrenceId": {
"description": "The archived event's original identity, retained verbatim; current receipts use `operationId`.",
"type": "string",
"minLength": 1,
"maxLength": 160
},
"state": {
"type": "string",
"const": "refunded",
"description": "The leg did not settle and its input asset was returned."
},
"refund": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The asset's NEP-141 token id."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
},
"amountRaw": {
"description": "The amount, in the token's smallest unit, when it is known.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
}
},
"required": [
"tokenId",
"decimals"
],
"description": "What was returned."
}
},
"required": [
"approvalId",
"legId",
"index",
"state",
"refund"
]
},
{
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"legId": {
"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": "Which leg of the plan this receipt settles."
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "This leg's position within the plan, counting from zero."
},
"operationId": {
"description": "The durable financial request this evidence belongs to.",
"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)$"
},
"occurrenceId": {
"description": "The archived event's original identity, retained verbatim; current receipts use `operationId`.",
"type": "string",
"minLength": 1,
"maxLength": 160
},
"state": {
"type": "string",
"const": "not_executed",
"description": "The leg did not settle. Most reasons mean it never reached the provider; `rejected` means it did and was refused there — see `reason`."
},
"reason": {
"description": "Why nothing executed: `signing_disabled` when automatic signing was off, `signing_failed` when signing itself failed, `rejected` when the provider refused the submission outright (it did reach the provider), `expired` when the leg's own signing/deposit window elapsed before a terminal fact arrived, or `failed` otherwise. Optional so receipts written before the reason was carried still parse.",
"type": "string",
"enum": [
"signing_disabled",
"signing_failed",
"rejected",
"expired",
"failed"
]
},
"unsignedBy": {
"description": "Present with `signing_failed` on an Agent API wallet's leg when the NEAR Intents Agent API, the wallet's signer, released no signature for it: it refused the request, or its own history proves it released none. Nothing moved.",
"type": "string",
"const": "agent_api"
}
},
"required": [
"approvalId",
"legId",
"index",
"state"
]
}
],
"description": "The `intents.settlement` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "A later, independently verified financial fact about one leg of an authorized swap — settled, refunded, or never executed — never inferred from the model's own tool result. Appended whenever the provider confirms the outcome, independent of the run that requested it; `legId` and `operationId` join it back to its financial request, progress and authorizing approval. Archived receipts retain their original `occurrenceId`."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "intents.progress",
"description": "Identifies this as an `intents.progress` event."
},
"payload": {
"oneOf": [
{
"type": "object",
"properties": {
"operationId": {
"description": "The durable financial request this evidence belongs to.",
"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)$"
},
"occurrenceId": {
"description": "The archived event's original identity, retained verbatim; current progress uses `operationId`.",
"type": "string",
"minLength": 1,
"maxLength": 160
},
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The grant's approval id: the chat approval for a one-shot, the creation approval for an automation."
},
"kind": {
"type": "string",
"const": "planning",
"description": "Authorized; reading balances and prices to freeze the plan."
}
},
"required": [
"approvalId",
"kind"
]
},
{
"type": "object",
"properties": {
"operationId": {
"description": "The durable financial request this evidence belongs to.",
"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)$"
},
"occurrenceId": {
"description": "The archived event's original identity, retained verbatim; current progress uses `operationId`.",
"type": "string",
"minLength": 1,
"maxLength": 160
},
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The grant's approval id: the chat approval for a one-shot, the creation approval for an automation."
},
"kind": {
"type": "string",
"const": "planned",
"description": "The frozen plan: every swap, with the amount on the side the plan fixed."
},
"legs": {
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "This leg's position within the plan, counting from zero."
},
"input": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The asset's NEP-141 token id."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
},
"amountRaw": {
"description": "The amount, in the token's smallest unit, when it is known.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The input asset and, when the plan fixed this side, the exact amount it spends."
},
"output": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The asset's NEP-141 token id."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
},
"amountRaw": {
"description": "The amount, in the token's smallest unit, when it is known.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The output asset and, when the plan fixed this side, the exact amount it receives."
},
"minimumOutputRaw": {
"description": "The floor an exact-input swap's output must clear; present only when the input side is fixed.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"maximumInputRaw": {
"description": "The ceiling an exact-output swap's input may spend; present only when the output side is fixed.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
}
},
"required": [
"index",
"input",
"output"
]
},
"description": "Every swap in the frozen plan, indexed from zero."
}
},
"required": [
"approvalId",
"kind",
"legs"
]
},
{
"type": "object",
"properties": {
"operationId": {
"description": "The durable financial request this evidence belongs to.",
"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)$"
},
"occurrenceId": {
"description": "The archived event's original identity, retained verbatim; current progress uses `operationId`.",
"type": "string",
"minLength": 1,
"maxLength": 160
},
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The grant's approval id: the chat approval for a one-shot, the creation approval for an automation."
},
"kind": {
"type": "string",
"const": "stage",
"description": "One swap moved; `legId` joins it to its receipt once the swap is claimed."
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "Which leg, by position, this update is about."
},
"stage": {
"type": "string",
"enum": [
"checking",
"retrying",
"quoting",
"signed",
"confirming",
"unresolved"
],
"description": "What the executor is doing right now, between approval and a receipt: `checking` while it checks the complete frozen request before dispatch; `retrying` while a bounded preparation attempt waits to retry; `quoting` while it fetches and validates the provider quote, then claims and signs; `signed` once the signature is persisted, about to submit; `confirming` once submitted (or recovered), waiting for the provider's terminal fact; `unresolved` when the run's settle budget ended before a terminal fact and the sweep continues."
},
"legId": {
"description": "Joins this stage to its settlement receipt once the swap is claimed; absent before then.",
"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)$"
}
},
"required": [
"approvalId",
"kind",
"index",
"stage"
]
}
],
"description": "The `intents.progress` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "Best-effort, display-only progress for an authorized swap, between approval and its settlement receipt: freezing the plan (`planning`), the frozen legs (`planned`), then each leg's own stage (`stage`). Never gates execution and may arrive out of order or not at all; an `intents.settlement` receipt always takes precedence, and a terminal outcome is never reported here."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "perps.reconciled",
"description": "Identifies this as a `perps.reconciled` event."
},
"payload": {
"oneOf": [
{
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval that authorized the call."
},
"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 durable financial request this answer belongs to."
},
"callId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The tool call whose own result this answer supersedes, as `tool.result` names it."
},
"tool": {
"type": "string",
"enum": [
"perps_order_place",
"perps_order_cancel",
"perps_margin_update"
],
"description": "The order placement, cancellation or margin change Hyperliquid has now answered."
},
"result": {
"description": "Hyperliquid's final answer, in the shape the tool itself returns: `placed`, `rejected`, `cancelled` or `applied`.",
"$ref": "#/components/schemas/PerpsOrderOutcome"
}
},
"required": [
"approvalId",
"operationId",
"callId",
"tool",
"result"
]
},
{
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval that authorized the call."
},
"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 durable financial request this answer belongs to."
},
"callId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The tool call whose own result this answer supersedes, as `tool.result` names it."
},
"tool": {
"type": "string",
"const": "perps_withdraw",
"description": "The withdrawal whose settlement the provider has now confirmed."
},
"result": {
"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"
]
}
],
"description": "The confirmed ending, in the shape the tool itself returns: `settled` or `refunded`."
}
},
"required": [
"approvalId",
"operationId",
"callId",
"tool",
"result"
]
}
],
"description": "The `perps.reconciled` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "A later, independently verified answer to an approved perps order, cancellation or withdrawal whose own `tool.result` was left unconfirmed — never inferred from the model's own tool result. Appended once, by recovery, in the same commit that records the request's final outcome, independent of the run that made the call; `callId` joins it to that call's `tool.result`, `approvalId` to its approval, and `operationId` to its financial request. `result` has the shape the tool itself returns; show it in place of the call's earlier unconfirmed result."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "prediction.funding",
"description": "Identifies this as a `prediction.funding` event."
},
"payload": {
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval that authorized the call."
},
"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 durable financial request this answer belongs to."
},
"callId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The tool call whose own result this answer supersedes, as `tool.result` names it."
},
"tool": {
"type": "string",
"const": "prediction_fund",
"description": "The funding tool whose call this updates."
},
"result": {
"description": "The funding's current stages, in the shape the tool itself returns.",
"$ref": "#/components/schemas/PredictionFundSubmitted"
}
},
"required": [
"approvalId",
"operationId",
"callId",
"tool",
"result"
],
"description": "The `prediction.funding` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "Recovery's latest view of an approved `prediction_fund` call, appended whenever it changes, independent of the run that made the call: the first leg's verified 1Click outcome (native Base USDC delivered to Polymarket's bridge, refunded, or not executed) and every transaction the bridge reports at the pinned deposit address, each `COMPLETED` one checked against its canonical Polygon receipt. Delivery to the bridge is not pUSD funding, a bridge `FAILED` is not a refund, and attribution of any bridge transaction to this funding stays unknown. `callId` joins it to that call's `tool.result`; show the latest in place of it."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "prediction.withdrawal",
"description": "Identifies this as a `prediction.withdrawal` event."
},
"payload": {
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval that authorized the call."
},
"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 durable financial request this answer belongs to."
},
"callId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The tool call whose own result this answer supersedes, as `tool.result` names it."
},
"tool": {
"type": "string",
"const": "prediction_withdraw"
},
"result": {
"$ref": "#/components/schemas/PredictionWithdrawSubmitted"
}
},
"required": [
"approvalId",
"operationId",
"callId",
"tool",
"result"
],
"description": "The attempted withdrawal's outgoing receipt, bridge observation and unique linked deposit arrival."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "Recovery's latest view of an attempted owner-approved pUSD withdrawal, independent of the run: its outgoing Polygon transfer receipt, what the bridge reports, and arrival at the unique linked 1Click deposit address. Only that deposit's own receipt establishes a credit or refund into the agent's confidential Intents wallet. A bridge status alone is not a receipt. Replace the original tool result by callId; recovery never signs or resends."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "composite.progress",
"description": "Identifies this as a `composite.progress` event."
},
"payload": {
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"callId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The `composite_execute` call."
},
"revision": {
"type": "integer",
"minimum": 1,
"maximum": 1024,
"description": "Snapshot order: ignore an older snapshot for the same call."
},
"pieces": {
"minItems": 1,
"maxItems": 6,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"tool": {
"type": "string",
"enum": [
"intents_execute",
"perps_fund",
"perps_order_place",
"prediction_fund",
"prediction_order_place",
"perps_withdraw",
"prediction_withdraw"
]
},
"operationId": {
"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"
}
]
},
"state": {
"type": "string",
"enum": [
"todo",
"live",
"done",
"bad",
"skip"
],
"description": "`todo` waiting, `live` running, `done` executed, `bad` failed, `skip` never started because a piece it depends on did not succeed or the basket ended."
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 300
}
},
"required": [
"index",
"tool",
"operationId",
"state"
]
}
}
},
"required": [
"approvalId",
"callId",
"revision",
"pieces"
],
"description": "Display-only basket piece states."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "Best-effort display snapshot of an approved basket's pieces (`composite_execute`), appended after a piece changes state: each piece `todo`, `live`, `done`, `bad` or `skip`. Revision orders snapshots for the same call; ignore an older one. The call's own `tool.result` is the authoritative outcome of every piece, and each piece's own venue events keep their meaning; progress grants no execution permission."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "solana.progress",
"description": "Identifies this as a `solana.progress` event."
},
"payload": {
"type": "object",
"properties": {
"operationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"callId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The original tool call, including a standing occurrence without its own approval card."
},
"revision": {
"type": "integer",
"minimum": 1,
"maximum": 1024,
"description": "Persisted lifecycle stage number. Ignore an older snapshot for the same operation."
},
"phase": {
"type": "string",
"enum": [
"funding",
"swap",
"sweep"
]
},
"state": {
"type": "string",
"enum": [
"preparing",
"prepared",
"submitting",
"pending",
"delivering",
"confirmed",
"uncertain",
"refunded",
"failed",
"not_executed"
]
},
"transactionIndex": {
"description": "The stored native transaction attempt, never a funding plan leg index.",
"type": "integer",
"minimum": 0,
"maximum": 5
},
"sale": {
"description": "On a multi-coin sale's swap, which coin it sells: its zero-based place in the sale's `sells`. A multi-coin sale's progress names this in place of `transactionIndex`, and nothing on its one transfer back; absent on every other operation.",
"type": "integer",
"minimum": 0,
"maximum": 5
},
"paid": {
"description": "What a sale sold, once its swap landed: the amount its result reports as `paid`. Absent before then, and for other operations.",
"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"
]
}
},
"required": [
"operationId",
"approvalId",
"callId",
"revision",
"phase",
"state"
],
"description": "Display-only committed Solana stage, never a final operation result."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "Best-effort display snapshot derived from committed Solana funding, swap or sweep facts. Revision orders snapshots; repeated unchanged observations are omitted. A confirmed funding phase is only delivered SOL, and a confirmed swap phase does not establish sweep settlement. Final tool outcomes and solana.reconciled remain authoritative; progress grants no execution permission."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "solana.reconciled",
"description": "Identifies this as a `solana.reconciled` event."
},
"payload": {
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval that authorized the call."
},
"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 durable financial request this answer belongs to."
},
"callId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The tool call whose own result this answer supersedes, as `tool.result` names it."
},
"tool": {
"type": "string",
"enum": [
"solana_buy",
"solana_sell",
"solana_sell_many",
"solana_withdraw"
],
"description": "The Solana buy, sell, multi-coin sale or withdrawal whose outcome is now known."
},
"result": {
"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"
]
}
],
"description": "The confirmed ending, in the shape the tool itself returns, with its `solana` detail."
}
},
"required": [
"approvalId",
"operationId",
"callId",
"tool",
"result"
],
"description": "The `solana.reconciled` event's own fields."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "A later, independently verified answer to an approved Solana buy, sell or withdrawal whose own `tool.result` was left unconfirmed — never inferred from the model's own tool result. Appended once, by recovery, in the same commit that records the request's final outcome, independent of the run that made the call; `callId` joins it to that call's `tool.result`, `approvalId` to its approval, and `operationId` to its financial request. `result` has the shape the tool itself returns, with its `solana` detail; show it in place of the call's earlier unconfirmed result."
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The event's position in the conversation's journal; strictly increasing."
},
"conversationId": {
"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."
},
"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 event was appended to the journal."
},
"requestId": {
"description": "The request that produced this event, when one did; null for scheduler and recovery writes.",
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"const": "prediction.order",
"description": "Identifies this as a `prediction.order` event."
},
"payload": {
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval that authorized the call."
},
"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 durable financial request this answer belongs to."
},
"callId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The tool call whose own result this answer supersedes, as `tool.result` names it."
},
"tool": {
"type": "string",
"const": "prediction_order_place"
},
"result": {
"oneOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "submitted"
},
"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)$"
},
"order": {
"$ref": "#/components/schemas/PredictionOrderInput"
},
"observation": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^0x[0-9a-f]{64}$"
},
"status": {
"type": "string",
"enum": [
"live",
"partially_filled",
"matched",
"filled",
"cancelled",
"expired",
"rejected",
"uncertain"
]
},
"originalSizeRaw": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,77})$"
},
"matchedSizeRaw": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,77})$"
},
"remainingSizeRaw": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,77})$"
},
"trades": {
"maxItems": 1000,
"type": "array",
"items": {
"type": "object",
"properties": {
"tradeId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"status": {
"type": "string",
"enum": [
"MATCHED",
"MINED",
"CONFIRMED",
"RETRYING",
"FAILED"
]
},
"sizeRaw": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,77})$"
},
"transactionHash": {
"type": "string",
"pattern": "^0x[0-9a-f]{64}$"
}
},
"required": [
"tradeId",
"status",
"sizeRaw"
]
}
},
"observedAtMs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"settledCollateralRaw": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,77})$"
},
"settledFeeRaw": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,77})$"
},
"cancelRequested": {
"type": "boolean"
},
"polymarketError": {
"description": "What Polymarket answered when the order was sent, when it answered with an error: kept with the order for good. Absent when Polymarket gave no reason.",
"type": "object",
"properties": {
"httpStatus": {
"description": "The HTTP status Polymarket answered with, when it answered with an error status.",
"type": "integer",
"minimum": 100,
"maximum": 599
},
"message": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"description": "Polymarket's own words, exactly as it answered, cut to their first 300 characters."
}
},
"required": [
"message"
]
}
},
"required": [
"orderId",
"status",
"originalSizeRaw",
"matchedSizeRaw",
"remainingSizeRaw",
"trades",
"observedAtMs"
]
}
},
"required": [
"status",
"operationId",
"order",
"observation"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "blocked"
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"status",
"reason"
]
}
]
}
},
"required": [
"approvalId",
"operationId",
"callId",
"tool",
"result"
],
"description": "The original Polymarket order's latest observed state, not a new placement."
}
},
"required": [
"seq",
"conversationId",
"createdAt",
"requestId",
"type",
"payload"
],
"description": "The latest observation of a Polymarket order. Replace the original placement call's result, joined by `callId`, with `result`. A match is not settlement; cancellation stops only the unmatched part and does not reverse earlier fills. Observations can arrive after the run ends."
}
],
"description": "One journal entry: the event type and its payload, in the order it happened."
},
"LimitOrderContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "limit_order",
"description": "Which contract template this is."
},
"order": {
"type": "object",
"properties": {
"input": {
"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 asset the order sells: token id and decimals."
}
},
"required": [
"pinned"
],
"description": "The input (base) asset this order sells."
},
"output": {
"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 asset the order buys: token id and decimals."
}
},
"required": [
"pinned"
],
"description": "The output (quote) asset this order buys."
},
"quantity": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact input amount to sell, in the input asset's smallest unit. 1 NEAR with verified decimals 24 is \"1000000000000000000000000\". Scale decimal digits with the verified decimals and reject excess fractional digits; no floating-point arithmetic or bash."
},
"limitPrice": {
"type": "string",
"maxLength": 80,
"pattern": "^(0|[1-9]\\d{0,38})(\\.\\d{1,38})?$",
"description": "The minimum price the fill must reach, as output-asset units per ONE input unit, written as a plain human decimal: \"5\" means at least 5 output tokens per 1 input token. Never scale it by decimals."
},
"expiresInHours": {
"type": "integer",
"minimum": 1,
"maximum": 720,
"description": "How long the order may rest before it expires, in whole hours. Use the user's duration within this wallet's maximum, or the wallet's default from the latest request's host context when none is given. The schema permits up to 720 hours (30 days); a wallet may have a lower maximum. Never shorten a requested duration to fit."
}
},
"required": [
"input",
"output",
"quantity",
"limitPrice",
"expiresInHours"
],
"description": "The exact approved placement request."
},
"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 latest instant the order may be created and funded under this consent."
}
},
"required": [
"type",
"order",
"validUntil"
],
"description": "Owner-signed authority for one resting limit order: the exact approved placement, created and funded once by the policy worker before the approval expires."
},
"PerpsTransferContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "perps_transfer",
"description": "Which authorization contract this is."
},
"direction": {
"type": "string",
"enum": [
"fund",
"withdraw"
],
"description": "Fund the own perps account from the agent wallet, or withdraw back to the same agent wallet."
},
"transfer": {
"description": "The exact approved amount and all-in loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.",
"$ref": "#/components/schemas/PerpsTransferInput"
},
"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 one-shot approval authorizes nothing."
}
},
"required": [
"type",
"direction",
"transfer",
"validUntil"
],
"description": "One approved perps transfer in exactly the named direction."
},
"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."
},
"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."
},
"PerpsOrderContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "perps_order",
"description": "Which authorization contract this is."
},
"order": {
"description": "The exact approved order.",
"$ref": "#/components/schemas/PerpsOrderInput"
},
"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 one-shot approval authorizes nothing."
}
},
"required": [
"type",
"order",
"validUntil"
],
"description": "One approved Hyperliquid order, signed once exactly as approved."
},
"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."
},
"PerpsCancelContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "perps_cancel",
"description": "Which authorization contract this is."
},
"cancel": {
"description": "The exact order approved for cancelling.",
"$ref": "#/components/schemas/PerpsCancelInput"
},
"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 one-shot approval authorizes nothing."
}
},
"required": [
"type",
"cancel",
"validUntil"
],
"description": "One approved cancellation of one resting Hyperliquid order."
},
"PerpsCancelInput": {
"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."
},
"oid": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The resting order's id exactly as perps_orders lists it."
}
},
"required": [
"coin",
"asset",
"oid"
],
"description": "Cancel one resting order on the agent's own account."
},
"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."
},
"PerpsMarginContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "perps_margin",
"description": "Which authorization contract this is."
},
"margin": {
"description": "The exact approved margin change.",
"$ref": "#/components/schemas/PerpsMarginInput"
},
"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 one-shot approval authorizes nothing."
}
},
"required": [
"type",
"margin",
"validUntil"
],
"description": "One approved change to one isolated position's margin, signed once exactly as approved."
},
"PerpsMarginInput": {
"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."
},
"change": {
"type": "string",
"enum": [
"add",
"remove"
],
"description": "`add` moves USDC from the account into the position's isolated margin, lowering its liquidation risk; `remove` takes it back out, raising that risk. A strict isolated market never lets margin be removed while the position is open."
},
"amount": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,8})(\\.[0-9]{0,5}[1-9])?$",
"description": "Exact USDC to move, at most six decimal places, such as `25` or `12.5`."
}
},
"required": [
"coin",
"asset",
"change",
"amount"
],
"description": "Add or remove margin on one isolated position on the agent's own account."
},
"PredictionFundContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "prediction_fund",
"description": "One approved Polymarket funding transfer."
},
"transfer": {
"description": "The exact approved USDC or USDT debit and the first leg's loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.",
"$ref": "#/components/schemas/PredictionFundInput"
},
"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 one-shot approval authorizes nothing."
}
},
"required": [
"type",
"transfer",
"validUntil"
],
"description": "One exact USDC or USDT debit delivered as native Base USDC to Polymarket's bridge for the agent's own account; the final pUSD amount is not bounded."
},
"PredictionFundInput": {
"type": "object",
"properties": {
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "Exact debit in six-decimal atomic units: 5 USDC or USDT is \"5000000\", spent 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. The host resolves the agent’s own Polymarket Deposit Wallet and its bridge address; never supply an address."
},
"maxFirstLegLossBps": {
"type": "integer",
"minimum": 0,
"maximum": 300,
"description": "Explicit maximum loss, in basis points, of the first leg only: the wallet's USDC, USDT or coin delivered as native Base USDC to Polymarket's bridge, fees and any cross-chain hop included. It does not bound the bridge's conversion to pUSD on Polygon, whose fees and output are variable and estimated. Required; no default."
},
"payWith": {
"description": "Approved in chat as one call or as a funded order's funding: the coin the first leg pays with instead of a USDC or USDT holding, and the most of it it may spend.",
"$ref": "#/components/schemas/VenueFundingPayment"
}
},
"required": [
"amountRaw",
"maxFirstLegLossBps"
],
"description": "Fund the agent's own Polymarket Deposit Wallet: one exact USDC or USDT debit, or that many dollars of a coin, delivered as native Base USDC to Polymarket's bridge, which credits an estimated, not guaranteed, pUSD amount on Polygon later."
},
"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."
},
"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."
},
"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."
},
"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."
},
"SolanaFundContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "solana_fund",
"description": "Which authorization contract this is."
},
"fund": {
"description": "The exact approved amount and loss bound, and, for a funding paid with a coin, that coin and the most of it it may spend.",
"$ref": "#/components/schemas/SolanaFundInput"
},
"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",
"fund",
"maxExecutions",
"validUntil"
],
"description": "An approved move of USDC or USDT, or a coin, into the agent's own Solana account."
},
"SolanaFundInput": {
"type": "object",
"properties": {
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "Exact USDC or USDT to move from the agent wallet into the agent's Solana account as SOL, in six-decimal atomic units: 5 USDC is \"5000000\". Spent 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."
},
"maxValueLossBps": {
"type": "integer",
"minimum": 0,
"maximum": 300,
"description": "Explicit maximum value loss in basis points, including provider fees: at most 300. Required; no default."
},
"payWith": {
"description": "Approved in chat as one call: the coin this funding pays with instead of a USDC or USDT holding, and the most of it it may spend. Never SOL.",
"$ref": "#/components/schemas/VenueFundingPayment"
}
},
"required": [
"amountRaw",
"maxValueLossBps"
],
"description": "Move an exact amount of USDC or USDT, or that many dollars of a coin, from the agent wallet into its own Solana account as SOL."
},
"SolanaWithdrawContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "solana_withdraw",
"description": "Which authorization contract this is."
},
"withdraw": {
"description": "The exact approved amount, what returns and the loss bound.",
"$ref": "#/components/schemas/SolanaWithdrawInput"
},
"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",
"withdraw",
"maxExecutions",
"validUntil"
],
"description": "An approved move of SOL from the agent's own Solana account back to its agent wallet."
},
"SolanaWithdrawInput": {
"type": "object",
"properties": {
"amount": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact",
"description": "Withdraw an exact amount of SOL."
},
"lamports": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "Exact SOL to withdraw, in lamports (nine decimals): 0.5 SOL is \"500000000\"."
}
},
"required": [
"kind",
"lamports"
],
"description": "Withdraw an exact amount of SOL."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "all_spendable",
"description": "Withdraw all the SOL above the reserve the account keeps for rent and network fees."
}
},
"required": [
"kind"
],
"description": "Withdraw all the spendable SOL."
}
],
"description": "How much SOL to withdraw from the agent's Solana account."
},
"receive": {
"type": "string",
"enum": [
"usdc",
"sol"
],
"description": "`usdc` returns it to the agent wallet as USDC on NEAR; `sol` returns it to the agent wallet as SOL."
},
"maxValueLossBps": {
"type": "integer",
"minimum": 0,
"maximum": 300,
"description": "Explicit maximum value loss in basis points, including provider fees: at most 300. Required; no default."
}
},
"required": [
"amount",
"receive",
"maxValueLossBps"
],
"description": "Move SOL from the agent's own Solana account back to its agent wallet."
},
"PredictionOrderContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "prediction_order"
},
"order": {
"$ref": "#/components/schemas/PredictionOrderInput"
},
"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))$"
}
},
"required": [
"type",
"order",
"validUntil"
]
},
"PredictionOrderInput": {
"type": "object",
"properties": {
"marketId": {
"type": "string",
"pattern": "^[1-9][0-9]{0,19}$"
},
"assetId": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,77})$"
},
"marketQuestion": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"outcome": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"side": {
"type": "string",
"enum": [
"BUY",
"SELL"
]
},
"limitPriceUsdDecimal": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
},
"quantity": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "shares"
},
"sizeSharesDecimal": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
}
},
"required": [
"kind",
"sizeSharesDecimal"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "budget"
},
"amountUsdDecimal": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
}
},
"required": [
"kind",
"amountUsdDecimal"
]
}
]
},
"orderType": {
"type": "string",
"enum": [
"GTC",
"GTD",
"FOK",
"FAK"
]
},
"expiresAt": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799
},
"maxFeeUsdDecimal": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
},
"maxSpendUsdDecimal": {
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
}
},
"required": [
"marketId",
"assetId",
"marketQuestion",
"outcome",
"side",
"limitPriceUsdDecimal",
"quantity",
"orderType",
"maxFeeUsdDecimal",
"maxSpendUsdDecimal"
]
},
"PredictionWithdrawContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "prediction_withdraw"
},
"withdrawal": {
"$ref": "#/components/schemas/PredictionWithdrawInput"
},
"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))$"
}
},
"required": [
"type",
"withdrawal",
"validUntil"
]
},
"PredictionWithdrawInput": {
"type": "object",
"properties": {
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "Exact pUSD debit in six-decimal atomic units: 5 pUSD is \"5000000\". Only the agent’s own Deposit Wallet is spent."
},
"maxLossBps": {
"type": "integer",
"minimum": 0,
"maximum": 300,
"description": "Explicit maximum estimated route loss in basis points, fees included; required, never defaulted. The bridge quote is an estimate, not a guaranteed final credit."
}
},
"required": [
"amountRaw",
"maxLossBps"
],
"description": "Withdraw pUSD through Polymarket’s conversion service as native USDC on Polygon to a unique verified 1Click address crediting only the agent’s own confidential Intents wallet. Funding remains a separate USDC route."
},
"CompositeContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "composite",
"description": "Which authorization contract this is."
},
"pieces": {
"minItems": 1,
"maxItems": 6,
"type": "array",
"items": {
"type": "object",
"properties": {
"tool": {
"type": "string",
"enum": [
"intents_execute",
"perps_fund",
"perps_order_place",
"prediction_fund",
"prediction_order_place",
"perps_withdraw",
"prediction_withdraw"
],
"description": "The tool whose one-shot call this piece is."
},
"contract": {
"anyOf": [
{
"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/PerpsTransferContract"
},
{
"$ref": "#/components/schemas/PerpsOrderContract"
},
{
"$ref": "#/components/schemas/PredictionFundContract"
},
{
"$ref": "#/components/schemas/PredictionOrderContract"
},
{
"$ref": "#/components/schemas/PerpsFreedWithdrawalContract"
},
{
"$ref": "#/components/schemas/PredictionFreedWithdrawalContract"
}
]
},
"startBy": {
"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))$"
}
},
"required": [
"tool",
"contract",
"startBy"
]
}
},
"dependencies": {
"type": "array",
"items": {
"maxItems": 6,
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
}
},
"walletDebit": {
"anyOf": [
{
"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."
}
},
{
"type": "array",
"prefixItems": [],
"items": false,
"maxItems": 0
}
],
"description": "The sum of every piece's debit from the agent wallet, per token, in raw units. Empty when the pieces are venue orders paid from money already on their venues, as when finishing a basket, or a cash-out, which closes a position and brings home what that freed."
},
"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 every piece that has not started loses its authority."
}
},
"required": [
"type",
"pieces",
"dependencies",
"walletDebit",
"validUntil"
],
"description": "One owner signature over several exact one-shot grants and the order they run in."
},
"PerpsFreedWithdrawalContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "perps_freed_withdrawal",
"description": "Which authorization contract this is."
},
"withdrawal": {
"description": "The signed maximum and all-in loss bound of the withdrawal home.",
"$ref": "#/components/schemas/PerpsFreedWithdrawalInput"
},
"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 one-shot approval authorizes nothing."
}
},
"required": [
"type",
"withdrawal",
"validUntil"
],
"description": "One withdrawal home of what a cash-out's exit freed on Hyperliquid, at most the signed maximum. Only ever a piece of a cash-out."
},
"PerpsFreedWithdrawalInput": {
"type": "object",
"properties": {
"upToRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The most this withdrawal may move, in six-decimal atomic USDC: what the exit before it frees, sized by the host before the approval opens. Never more than the exit freed."
},
"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."
}
},
"required": [
"upToRaw",
"maxValueLossBps"
],
"description": "Withdraw to the agent's own confidential Intents wallet what the exit before it freed on its own Hyperliquid account, never more than upToRaw."
},
"PredictionFreedWithdrawalContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "prediction_freed_withdrawal"
},
"withdrawal": {
"$ref": "#/components/schemas/PredictionFreedWithdrawalInput"
},
"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))$"
}
},
"required": [
"type",
"withdrawal",
"validUntil"
],
"description": "One withdrawal home of what a cash-out's sale freed on Polymarket, at most the signed maximum. Only ever a piece of a cash-out."
},
"PredictionFreedWithdrawalInput": {
"type": "object",
"properties": {
"upToRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The most this withdrawal may move, in six-decimal atomic pUSD: what the sale before it frees, sized by the host before the approval opens. Never more than the sale freed."
},
"maxLossBps": {
"type": "integer",
"minimum": 0,
"maximum": 300,
"description": "Explicit maximum estimated route loss in basis points, fees included; required, never defaulted. The bridge quote is an estimate, not a guaranteed final credit."
}
},
"required": [
"upToRaw",
"maxLossBps"
],
"description": "Withdraw to the agent's own confidential Intents wallet what the sale before it freed in its own Polymarket Deposit Wallet, never more than upToRaw."
},
"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."
},
"SolanaSellManyContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "solana_sell_many",
"description": "Which authorization contract this is."
},
"sellMany": {
"description": "The exact approved coins, amounts and loss bounds, in order, and where the proceeds go.",
"$ref": "#/components/schemas/SolanaSellManyInput"
},
"maxExecutions": {
"type": "number",
"const": 1,
"description": "A multi-coin sale is approved once and runs once: always 1."
},
"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",
"sellMany",
"maxExecutions",
"validUntil"
],
"description": "An approved multi-coin Solana sale, executed only exactly as approved."
},
"SolanaSellManyInput": {
"type": "object",
"properties": {
"sells": {
"minItems": 2,
"maxItems": 6,
"type": "array",
"items": {
"$ref": "#/components/schemas/SolanaSale"
},
"description": "The coins to sell, in the order they are sold: 2 to 6, each a different mint, none of them SOL itself."
},
"receive": {
"type": "string",
"enum": [
"usdc",
"sol"
],
"description": "`usdc` returns the summed proceeds of every sale that went through to the agent wallet as USDC on NEAR, in one transfer once the last sale ran; `sol` keeps them as SOL in the agent's Solana account."
}
},
"required": [
"sells",
"receive"
],
"description": "Several sells of Solana tokens held in the agent's own Solana account, approved together and run as one: each sale on its own, one after another, then one transfer of what they returned."
},
"SolanaSale": {
"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."
},
"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",
"maxValueLossBps"
],
"description": "One coin of a multi-coin sale, sold through the agent's own Solana account."
},
"GridContract": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "grid",
"description": "Which contract template this is."
},
"grid": {
"type": "object",
"properties": {
"base": {
"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 base asset: token id and decimals."
}
},
"required": [
"pinned"
],
"description": "The asset the grid buys low and sells high."
},
"quote": {
"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 quote asset: token id and decimals."
}
},
"required": [
"pinned"
],
"description": "The asset prices are in and buys are paid with."
},
"levels": {
"minItems": 2,
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"maxLength": 80,
"pattern": "^(0|[1-9]\\d{0,38})(\\.\\d{1,38})?$"
},
"description": "The 2 to 20 grid prices, strictly ascending: quote units per ONE base unit, plain human decimals."
},
"quantityPerCell": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact base amount every cell buys and sells, in the base asset's smallest unit. Fixed: profits never compound."
},
"cells": {
"minItems": 1,
"maxItems": 19,
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "string",
"enum": [
"buy",
"idle"
],
"description": "The side the cell's first order is on: buy at its low level, or idle (the cell never places)."
}
},
"required": [
"start"
]
},
"description": "One entry per cell, lowest first (levels.length - 1 of them): cells wholly below the start price and the one straddling it buy, cells wholly above it stay idle."
}
},
"required": [
"base",
"quote",
"levels",
"quantityPerCell",
"cells"
],
"description": "A grid's exact terms: pair, levels, quantity and starting sides."
},
"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 the grid ends: no order is placed, and none rests, after it. At most 720 hours after the approval's own expiry."
}
},
"required": [
"type",
"grid",
"validUntil"
],
"description": "Owner-signed authority for one grid: the resting cell orders its terms derive, until it ends."
},
"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."
},
"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."
},
"PredictionFundSubmitted": {
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "submitted",
"description": "The exact USDC debit was attempted."
},
"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)$"
},
"firstLeg": {
"$ref": "#/components/schemas/PredictionFirstLeg"
},
"bridge": {
"type": "object",
"properties": {
"depositWallet": {
"type": "string",
"pattern": "^0x[0-9a-f]{40}$",
"description": "The agent's own Polymarket Deposit Wallet."
},
"bridgeAddress": {
"type": "string",
"pattern": "^0x[0-9a-f]{40}$",
"description": "The bridge deposit address the first leg paid, pinned before signing."
},
"minDepositRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The bridge's minimum for native Base USDC when the address was pinned."
},
"observation": {
"$ref": "#/components/schemas/PredictionBridgeObservation"
}
},
"required": [
"depositWallet",
"bridgeAddress",
"minDepositRaw",
"observation"
]
},
"attribution": {
"$ref": "#/components/schemas/PredictionFundAttribution"
},
"balance": {
"description": "The Deposit Wallet's live pUSD balance, read for the call's own answer and each `prediction.funding` change. Absent only from an answer rebuilt from the record without a live read, or recorded before balances were reported.",
"$ref": "#/components/schemas/PredictionDepositWalletBalance"
}
},
"required": [
"status",
"operationId",
"firstLeg",
"bridge",
"attribution"
]
},
"PredictionFirstLeg": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "pending"
}
},
"required": [
"state"
]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "delivered_to_bridge"
},
"deliveredRaw": {
"description": "Native Base USDC 1Click reported delivered to the bridge address; absent when its settlement stated no figure.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
}
},
"required": [
"state"
]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "refunded"
},
"refundedRaw": {
"description": "The USDC 1Click reported refunded to the agent wallet, in the asset the first leg spent; absent when its refund stated no figure.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
}
},
"required": [
"state"
]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "not_executed"
}
},
"required": [
"state"
]
}
],
"description": "The first leg's verified 1Click outcome, or `pending` while it has none."
},
"PredictionBridgeObservation": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "not_observed",
"description": "Nothing was delivered to the bridge yet, so its status was not read."
}
},
"required": [
"state"
]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unavailable",
"description": "The bridge's status could not be read."
},
"attemptedAtMs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"state",
"attemptedAtMs"
]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "observed"
},
"observedAtMs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"complete": {
"type": "boolean",
"description": "Whether every page was read; false when the walk stopped at its bound."
},
"transactions": {
"maxItems": 500,
"type": "array",
"items": {
"$ref": "#/components/schemas/PredictionBridgeTransaction"
},
"description": "Every transaction the bridge reports at the address, newest first."
}
},
"required": [
"state",
"observedAtMs",
"complete",
"transactions"
]
}
]
},
"PredictionBridgeTransaction": {
"type": "object",
"properties": {
"status": {
"type": "string",
"pattern": "^[A-Z][A-Z_]{0,63}$",
"description": "The bridge's status, verbatim: documented `DEPOSIT_DETECTED`, `PROCESSING`, `ORIGIN_TX_CONFIRMED`, `SUBMITTED`, `COMPLETED`, `FAILED`. `FAILED` is not a refund."
},
"fromChainId": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"fromTokenAddress": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"fromAmountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
},
"toChainId": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"toTokenAddress": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"createdTimeMs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"txHash": {
"description": "The bridge's own hash for the row, reported once `COMPLETED`. It names no Polygon transaction: the onramp row's is an ERC-4337 user operation's, and the Base row's is no chain's transaction. Never evidence of arrival.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"routeMatches": {
"type": "boolean",
"description": "Whether the row has the pinned route's shape. Shape alone never links a bridge row to a particular funding or withdrawal."
},
"credit": {
"description": "Recorded only by releases before 2026-11-15, which read the row's hash as a Polygon transaction; never written now. A funding's arrival is its `attribution`, a withdrawal's the linked deposit receipt.",
"$ref": "#/components/schemas/PredictionBridgeCredit"
}
},
"required": [
"status",
"fromChainId",
"fromTokenAddress",
"fromAmountRaw",
"toChainId",
"toTokenAddress",
"routeMatches"
]
},
"PredictionBridgeCredit": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "verified"
},
"blockNumber": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The finalized canonical block, as a decimal."
},
"blockHash": {
"type": "string",
"pattern": "^0x[0-9a-f]{64}$"
},
"logIndex": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"creditRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The pUSD this receipt's one incoming log credited to the Deposit Wallet, with no pUSD leaving it in the same transaction; six-decimal atomic units."
}
},
"required": [
"state",
"blockNumber",
"blockHash",
"logIndex",
"creditRaw"
]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "not_credited"
},
"reason": {
"type": "string",
"enum": [
"reverted",
"no_credit_log",
"multiple_credit_logs",
"outgoing_in_transaction"
],
"description": "`reverted` the transaction failed; `no_credit_log` no pUSD transfer to the Deposit Wallet; `multiple_credit_logs` more than one, so no single credit can be named; `outgoing_in_transaction` pUSD also left the Deposit Wallet in the same transaction, so no net credit is named."
}
},
"required": [
"state",
"reason"
]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unconfirmed",
"description": "No receipt yet, or its block is not finalized and canonical yet."
}
},
"required": [
"state"
]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unavailable",
"description": "Polygon could not be read; nothing is inferred."
}
},
"required": [
"state"
]
}
]
},
"PredictionFundAttribution": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "credited",
"description": "This funding's pUSD arrived in the Deposit Wallet."
},
"creditRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The pUSD the one matching receipt credited to the Deposit Wallet; six-decimal atomic units."
},
"transactionHash": {
"type": "string",
"pattern": "^0x[0-9a-f]{64}$",
"description": "The Polygon transaction that credited it."
}
},
"required": [
"state",
"creditRaw",
"transactionHash"
]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
},
"reason": {
"type": "string",
"enum": [
"not_at_bridge",
"delivery_unmeasured",
"bridge_not_read",
"awaiting_bridge",
"credit_not_verified",
"ambiguous",
"provider_reports_no_source_link"
],
"description": "`not_at_bridge` step 1 has not delivered to the bridge; `delivery_unmeasured` 1Click reported no delivered figure or the leg has no signing time, so no conversion can be matched; `bridge_not_read` Polygon could not be read just now, or this answer was rebuilt from the record without reading it; `awaiting_bridge` Polygon shows no conversion of the delivered amount out of the bridge address yet; `credit_not_verified` the one matching conversion's receipt shows no single pUSD credit to the Deposit Wallet; `ambiguous` more than one conversion of the delivered amount, or another of the owner's open fundings at the address, could be this one; `provider_reports_no_source_link` recorded by a release that never attributed."
},
"candidates": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Finalized transfers of exactly the delivered amount out of the bridge address on Polygon after the first leg was signed, not credited to another funding."
}
},
"required": [
"state",
"reason",
"candidates"
]
}
]
},
"PredictionDepositWalletBalance": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "observed"
},
"pusdRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "pUSD the wallet holds; six-decimal atomic units."
},
"readAtMs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"state",
"pusdRaw",
"readAtMs"
]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unavailable",
"description": "Polygon could not be read; nothing is inferred."
},
"attemptedAtMs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"state",
"attemptedAtMs"
]
}
],
"description": "The wallet's whole balance, never this funding's amount."
},
"PredictionWithdrawSubmitted": {
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "submitted"
},
"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)$"
},
"transfer": {
"$ref": "#/components/schemas/PredictionWithdrawTransfer"
},
"deposit": {
"$ref": "#/components/schemas/PredictionWithdrawDeposit"
},
"bridge": {
"type": "object",
"properties": {
"observation": {
"$ref": "#/components/schemas/PredictionBridgeObservation"
}
},
"required": [
"observation"
]
}
},
"required": [
"status",
"operationId",
"transfer",
"deposit",
"bridge"
],
"description": "One attempted pUSD withdrawal with outgoing receipt, bridge observation and linked 1Click arrival kept separate. Only the linked deposit receipt establishes credited or refunded funds."
},
"PredictionWithdrawTransfer": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"pending",
"confirmed",
"reverted",
"uncertain"
]
},
"transactionHash": {
"type": "string",
"pattern": "^0x[0-9a-f]{64}$"
}
},
"required": [
"state"
]
},
"PredictionWithdrawDeposit": {
"type": "object",
"properties": {
"depositId": {
"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)$"
},
"state": {
"type": "string",
"enum": [
"preparing",
"awaiting_deposit",
"incomplete",
"processing",
"credited",
"refunded",
"unknown",
"expired",
"failed"
]
},
"receipt": {
"type": "object",
"properties": {
"observedAt": {
"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 outcome was observed."
},
"state": {
"type": "string",
"enum": [
"credited",
"refunded"
],
"description": "Whether the transfer was credited or refunded."
},
"depositedRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "What arrived at the address."
},
"creditedRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "What the agent wallet was credited; zero when all of it was refunded."
},
"refundedRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "What went back to the agent wallet uncredited, such as a transfer below the minimum."
},
"sourceTransactionHashes": {
"minItems": 1,
"maxItems": 32,
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\x21-\\x7e]{1,256}$",
"description": "Network transaction or ledger intent identifier; opaque and case-sensitive, not necessarily an EVM hash."
},
"description": "The transfers that paid the address, on the network they were sent on."
},
"refundTransactionHashes": {
"maxItems": 32,
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\x21-\\x7e]{1,256}$",
"description": "Network transaction or ledger intent identifier; opaque and case-sensitive, not necessarily an EVM hash."
},
"description": "The refund's ledger identifiers, when they were reported."
}
},
"required": [
"observedAt",
"state",
"depositedRaw",
"creditedRaw",
"refundedRaw",
"sourceTransactionHashes",
"refundTransactionHashes"
]
}
},
"required": [
"depositId",
"state"
]
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The kind of problem as a URN, `urn:fin:error:<kind>`; stable, compare against it"
},
"title": {
"type": "string",
"description": "The kind's human title, for logs; never parse it"
},
"status": {
"type": "integer",
"minimum": 400,
"maximum": 599,
"description": "The HTTP status, repeated in the body"
},
"reason": {
"description": "The machine-readable why. One of:\n\n- `run_active` (409) — a run already holds this conversation\n- `budget_exhausted` (429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze it\n- `approval_not_pending` (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation\n- `execution_capacity` (429) — no capacity is free to run this right now; honour `Retry-After`\n- `execution_unavailable` (503) — the service that runs the agent could not take the work; `retryable` says whether to try again\n- `stop_pending` (409) — a stop is already in progress and its cleanup is not yet confirmed\n- `automation_changed` (409) — the automation changed while this request was handled; read it again and retry\n- `automation_held` (409) — an operator holds the automation; it fires again when released\n- `automation_invalid` (409) — the automation's definition cannot run as written\n- `automation_paused` (409) — the automation is paused; resume it first\n- `automation_has_no_webhook` (409) — the automation does not run on incoming events, so it has no webhook\n- `automation_limit` (409) — the user already has as many automations as the deployment allows\n- `profile_unknown_tool` (400) — `profile.tools` names a tool this deployment does not have\n- `deployment_paused` (503) — an operator paused this kind of work for the deployment; try again later\n- `run_not_active` (409) — the run named in the path is not the conversation's live run\n- `withdrawal_changed` (409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amount\n- `swap_changed` (409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quote\n- `order_changed` (409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it again\n- `prediction_order_changed` (409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it again\n- `solana_trade_changed` (409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it again\n- `trade_not_recoverable` (409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be used\n- `order_not_cancelable` (409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it stands\n- `grid_not_active` (409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it stands\n- `grid_not_paused` (409) — the grid is not paused, so there is nothing to resume. Read the grid for where it stands\n- `suggestion_changed` (409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions again\n- `request_key_conflict` (409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new request\n- `question_not_pending` (409) — the questionnaire has already been answered, closed, or is not awaiting this submission\n- `flag_changed` (409) — the flag's targeting changed since you read it; read it again and retry\n- `group_changed` (409) — the group changed or was deleted since you read it; read it again and retry\n- `group_in_use` (409) — a flag's rules still name this group; take it out of those rules first\n- `group_name_taken` (409) — another group already has this name\n- `agent_wallet_required` (409) — create the agent wallet before opening a perps, prediction-market or Solana account\n- `wallet_account_unsupported` (409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session instead\n- `conversation_deleted` (410) — the conversation was deleted; its history stays readable\n- `automation_deleted` (410) — the automation was deleted\n- `grid_ended` (410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chat\n- `credential_expired` (401) — the user token has expired; obtain a fresh one\n- `account_disabled` (403) — an operator disabled the account\n- `perps_disabled` (403) — perps is not enabled for this user\n- `prediction_disabled` (403) — prediction-market trading is not enabled for this user\n- `solana_disabled` (403) — Solana trading is not enabled for this user\n- `no_account` (404) — the user has not opened the account this call reads; open it first\n- `not_available_in_region` (403) — perps funding is unavailable in the user's region for this request; withdrawals remain available\n- `steering_disabled` (403) — steering a working run is not turned on for this user; send the message with Start a run once the run ends\n- `baskets_disabled` (403) — idea baskets are not turned on for this user; hide the Ideas pages and their baskets\n- `basket_buying` (409) — the basket is still buying, so it cannot be deleted yet; try again once its result is in\n- `basket_awaiting_approval` (409) — an approval to buy this basket is still open; decline it in the chat, then delete the basket\n- `basket_step_not_failed` (409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket again\n- `basket_step_linked` (409) — another order is already linked to this step; a link is permanent, so read the basket again\n- `basket_order_not_linkable` (400) — the order cannot stand in for this step: it is not one of the step's `failures[].linkable` orders, or another basket step already holds it\n- `voice_disabled` (403) — voice input is not turned on for this user; let them type instead\n- `voice_unavailable` (503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type instead\n- `provider_unavailable` (503) — an external provider the call depends on did not answer\n- `quote_refused` (400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another network\n- `invalid_input` (400) — the body or query failed validation; `issues` names each field\n- `internal` (500) — a fault on our side; quote `requestId` when reporting it\n- `partner_key_required` (401) — no `X-Api-Key` header was sent\n- `partner_key_invalid` (401) — the `X-Api-Key` is unknown or revoked\n- `subject_mismatch` (403) — the `{userId}` in the path is not the token's user\n- `origin_rejected` (403) — a browser `Origin` other than the configured web origin\n- `permission_required` (403) — the verified credential is not permitted to make this call\n- `signature_required` (403) — creating the agent wallet needs the user's signature: send the user's signature of `creation.message` from Get the agent wallet as `authorization`\n- `asset_not_withdrawable` (403) — tokenized stocks cannot be withdrawn; sell them first\n- `asset_not_swappable` (403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with no `context.country`, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user's `earn` flag is off\n- `asset_not_tradable` (403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with no `context.country`, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user's `earn` flag is off\n- `solana_token_not_tradable` (403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landing\n- `limit_orders_disabled` (403) — limit orders are not enabled for this user\n- `grid_trading_disabled` (403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gated\n- `deposit_limit_exceeded` (429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. Read `depositLimit.availableCents` from Get balances for how much fits now, and deposit no more than that\n- `policy_change_throttled` (429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again once `Retry-After` has passed\n- `agent_slippage_exceeded` (403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (`max_slippage_bps`): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss bound\n- `agent_api_orders_unavailable` (403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signed\n- `destination_not_allowed` (403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signed\n- `rate_limited` (429) — the per-key or per-user limit is spent; honour `Retry-After`\n- `partner_request_capacity` (429) — this partner's request quota across all keys and replicas is spent; honour Retry-After\n- `partner_run_capacity` (429) — this partner's active run quota is full; honour Retry-After and reuse the same request identity\n- `stream_capacity` (429) — the partner, user or replica has no free stream capacity; honour `Retry-After`\n- `invalid_cursor` (400) — the `cursor` is not one this list minted\n- `invalid_question_answer` (400) — the questionnaire answer does not match its questions or allowed choices\n- `question_closed` (410) — the questionnaire expired or was cancelled\n- `unknown_target` (400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule names\n- `scope_invalid` (400) — a subject in the scope is not a subject id, or appears twice\n- `subject_unsupported` (404) — a subject in the scope is not one market briefs cover; list them with List market subjects\n- `brief_not_found` (404) — no market brief job with this id was created with your partner key\n- `briefs_busy` (429) — your market briefs are at their limit of briefs generating at once; retry after `Retry-After`\n- `market_briefs_disabled` (403) — market briefs are not turned on for your partner key\n- `story_not_found` (404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read",
"type": "string",
"enum": [
"run_active",
"budget_exhausted",
"approval_not_pending",
"execution_capacity",
"execution_unavailable",
"stop_pending",
"automation_changed",
"automation_held",
"automation_invalid",
"automation_paused",
"automation_has_no_webhook",
"automation_limit",
"profile_unknown_tool",
"deployment_paused",
"run_not_active",
"withdrawal_changed",
"swap_changed",
"order_changed",
"prediction_order_changed",
"solana_trade_changed",
"trade_not_recoverable",
"order_not_cancelable",
"grid_not_active",
"grid_not_paused",
"suggestion_changed",
"request_key_conflict",
"question_not_pending",
"flag_changed",
"group_changed",
"group_in_use",
"group_name_taken",
"agent_wallet_required",
"wallet_account_unsupported",
"conversation_deleted",
"automation_deleted",
"grid_ended",
"credential_expired",
"account_disabled",
"perps_disabled",
"prediction_disabled",
"solana_disabled",
"no_account",
"not_available_in_region",
"steering_disabled",
"baskets_disabled",
"basket_buying",
"basket_awaiting_approval",
"basket_step_not_failed",
"basket_step_linked",
"basket_order_not_linkable",
"voice_disabled",
"voice_unavailable",
"provider_unavailable",
"quote_refused",
"invalid_input",
"internal",
"partner_key_required",
"partner_key_invalid",
"subject_mismatch",
"origin_rejected",
"permission_required",
"signature_required",
"asset_not_withdrawable",
"asset_not_swappable",
"asset_not_tradable",
"solana_token_not_tradable",
"limit_orders_disabled",
"grid_trading_disabled",
"deposit_limit_exceeded",
"policy_change_throttled",
"agent_slippage_exceeded",
"agent_api_orders_unavailable",
"destination_not_allowed",
"rate_limited",
"partner_request_capacity",
"partner_run_capacity",
"stream_capacity",
"invalid_cursor",
"invalid_question_answer",
"question_closed",
"unknown_target",
"scope_invalid",
"subject_unsupported",
"brief_not_found",
"briefs_busy",
"market_briefs_disabled",
"story_not_found"
]
},
"requestId": {
"type": "string",
"description": "The id Fin used for this request; quote it when reporting a problem"
},
"retryable": {
"type": "boolean",
"description": "Whether repeating the same request later can succeed without changing it"
},
"detail": {
"description": "Only on `invalid_input`: which part of the request failed validation",
"type": "string"
},
"issues": {
"description": "Only on `invalid_input`: one entry per failing field",
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The JSON pointer of the failing field; empty for the root object"
},
"message": {
"type": "string",
"description": "Why the field failed"
}
},
"required": [
"path",
"message"
]
}
}
},
"required": [
"type",
"title",
"status",
"requestId",
"retryable"
],
"description": "RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack."
}
},
"responses": {
"InvalidInput": {
"description": "The request could not be read as this operation expects.\n\n- `invalid_input` — the body or query failed validation; `issues` names each field\n- `invalid_cursor` — the `cursor` is not one this list minted",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Unauthorized": {
"description": "A credential is missing, invalid or expired.\n\n- `partner_key_required` — no `X-Api-Key` header was sent\n- `partner_key_invalid` — the `X-Api-Key` is unknown or revoked\n- `credential_expired` — the user token has expired; obtain a fresh one",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Forbidden": {
"description": "The credentials are valid but may not do this.\n\n- `subject_mismatch` — the `{userId}` in the path is not the token's user\n- `account_disabled` — an operator disabled the account\n- `origin_rejected` — a browser `Origin` other than the configured web origin\n- `permission_required` — the verified credential is not permitted to make this call",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"NotFound": {
"description": "The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"TooManyRequests": {
"description": "A limit refused the request; wait for `Retry-After` when it is sent.\n\n- `rate_limited` — the per-key or per-user limit is spent; honour `Retry-After`\n- `partner_request_capacity` — this partner's request quota across all keys and replicas is spent; honour Retry-After",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Internal": {
"description": "A fault on our side; quote `requestId` when reporting it.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Unavailable": {
"description": "The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); `retryable` says whether to try again.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "header",
"name": "X-Api-Key"
},
"userToken": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "fin_session_<opaque>",
"description": "A user's session token, from Create a session."
}
}
}
}