Send an automation event
Delivers an event from your system to an automation that runs on incoming events. Authenticate with its webhook secret in X-Automation-Key (not your API key). Answers 202 when the event is recorded and 200 when you already sent the same event id, so resending is safe. Events must be under 5 minutes old and at most 16 KiB.
Authentication
All credentials below are required.
- Header:
X-Automation-Key: YOUR_API_KEY
Path parameters
idstring · uuidrequiredThe automation's id.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
Header parameters
x-automation-keystringrequiredThe current automation source credential returned once by owner-authorized rotation. It permits ingestion only, never user reads, commands or financial consent.
Validation rules
- Pattern
"^[A-Za-z0-9_-]{43}$"
Request body required
One event, shaped as an automation's inbound webhook receives it: an id, a type, when it happened, and its data.
application/json · object
One event, shaped as an automation's inbound webhook receives it: an id, a type, when it happened, and its data.
Additional properties are not allowed.
idstringrequiredA caller-chosen id for this event, used to deduplicate exact replays within one activation. Reuse with changed data conflicts.
Validation rules
- Pattern
"^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$"
typestringrequiredThis event's own type, as the sender reports it.
Validation rules
- Pattern
"^[A-Za-z][A-Za-z0-9_.:-]{0,79}$"
occurredAtstring · date-timerequiredWhen this event happened, as the sender reports it.
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))$"
dataobjectrequiredArbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 entries.
Show attributes
Arbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 entries.
Validation rules
- propertyNames
{"type":"string"}
Additional property values
Any JSON value: a string, number, boolean, null, array or object, nested to any depth.
anyOf · 6 variants
Variant 1 · string
Variant 2 · number
Variant 3 · boolean
Variant 4 · null
Variant 5 · array
Array items · anyOf
Recursive reference: #/components/schemas/AutomationJsonValueInput. See the complete schema below.
Variant 6 · object
Validation rules
- propertyNames
{"type":"string"}
Additional property values
Recursive reference: #/components/schemas/AutomationJsonValueInput. See the complete schema below.
Request example
Illustrative request. Replace the host, credentials and resource IDs with your own. If a request file is shown, create it from the schema above. Review the requested action before sending it.
curl --request POST 'https://api.example.test/api/automations/YOUR_ID/webhook' \
--header 'X-Automation-Key: YOUR_API_KEY' \
--header 'x-automation-key: YOUR_VALUE' \
--header 'Content-Type: application/json' \
--data-binary '@request.json'
Responses
200 The identical event was already retained.
The identical event was already retained.
application/json · object
statusstringrequiredrecorded when the event is new; duplicate when the same event id with the same content was already received.
Validation rules
- Allowed values
["recorded","duplicate"]
inputIdstring · uuidrequiredThe id the event was recorded under, for your logs. Recording an event does not mean its condition matched or that anything ran.
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)$"
202 The source event was durably retained for evaluation.
The source event was durably retained for evaluation.
application/json · object
statusstringrequiredrecorded when the event is new; duplicate when the same event id with the same content was already received.
Validation rules
- Allowed values
["recorded","duplicate"]
inputIdstring · uuidrequiredThe id the event was recorded under, for your logs. Recording an event does not mean its condition matched or that anything ran.
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)$"
400 The authenticated event is invalid.
The authenticated event is invalid.
application/json · object
errorstringrequiredA source-ingress refusal. Source credential validation precedes event validation; changed event bytes under an existing identity conflict.
Validation rules
- Allowed values
["unauthorized","automation completed","invalid event","event id conflict","too many events"]
401 The source credential is absent, invalid or no longer current.
The source credential is absent, invalid or no longer current.
application/json · object
errorstringrequiredA source-ingress refusal. Source credential validation precedes event validation; changed event bytes under an existing identity conflict.
Validation rules
- Allowed values
["unauthorized","automation completed","invalid event","event id conflict","too many events"]
409 The event id already identifies different content.
The event id already identifies different content.
application/json · object
errorstringrequiredA source-ingress refusal. Source credential validation precedes event validation; changed event bytes under an existing identity conflict.
Validation rules
- Allowed values
["unauthorized","automation completed","invalid event","event id conflict","too many events"]
410 The automation's firing policy is complete.
The automation's firing policy is complete.
application/json · object
errorstringrequiredA source-ingress refusal. Source credential validation precedes event validation; changed event bytes under an existing identity conflict.
Validation rules
- Allowed values
["unauthorized","automation completed","invalid event","event id conflict","too many events"]
413 The request exceeds the maximum body size.
The request exceeds the maximum body size.
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 The source rate limit refused this event; honor Retry-After.
The source rate limit refused this event; honor Retry-After.
application/json · object
errorstringrequiredA source-ingress refusal. Source credential validation precedes event validation; changed event bytes under an existing identity conflict.
Validation rules
- Allowed values
["unauthorized","automation completed","invalid event","event id conflict","too many events"]
Complete OpenAPI definition
The exact operation and all referenced components, including recursive schemas.
{
"operation": {
"operationId": "automations.receiveEvent",
"summary": "Send an automation event",
"tags": [
"automations"
],
"description": "Delivers an event from your system to an automation that runs on incoming events. Authenticate with its webhook secret in `X-Automation-Key` (not your API key). Answers `202` when the event is recorded and `200` when you already sent the same event `id`, so resending is safe. Events must be under 5 minutes old and at most 16 KiB.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$",
"description": "A caller-chosen id for this event, used to deduplicate exact replays within one activation. Reuse with changed data conflicts."
},
"type": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.:-]{0,79}$",
"description": "This event's own `type`, as the sender reports it."
},
"occurredAt": {
"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 happened, as the sender reports it."
},
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/components/schemas/AutomationJsonValueInput"
},
"description": "Arbitrary JSON data: an event's data, a reader's configuration, or a source plan's configuration. Bounded to 16 KiB, 8 levels of nesting and 256 entries."
}
},
"required": [
"id",
"type",
"occurredAt",
"data"
],
"additionalProperties": false,
"description": "One event, shaped as an automation's inbound webhook receives it: an id, a type, when it happened, and its data."
}
}
},
"description": "One event, shaped as an automation's inbound webhook receives it: an id, a type, when it happened, and its data."
},
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"in": "path",
"name": "id",
"required": true,
"description": "The automation's id."
},
{
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{43}$"
},
"in": "header",
"name": "x-automation-key",
"required": true,
"description": "The current automation source credential returned once by owner-authorized rotation. It permits ingestion only, never user reads, commands or financial consent."
}
],
"security": [
{
"automationSourceKey": []
}
],
"responses": {
"200": {
"description": "The identical event was already retained.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"recorded",
"duplicate"
],
"description": "`recorded` when the event is new; `duplicate` when the same event `id` with the same content was already received."
},
"inputId": {
"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 id the event was recorded under, for your logs. Recording an event does not mean its condition matched or that anything ran."
}
},
"required": [
"status",
"inputId"
]
}
}
}
},
"202": {
"description": "The source event was durably retained for evaluation.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"recorded",
"duplicate"
],
"description": "`recorded` when the event is new; `duplicate` when the same event `id` with the same content was already received."
},
"inputId": {
"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 id the event was recorded under, for your logs. Recording an event does not mean its condition matched or that anything ran."
}
},
"required": [
"status",
"inputId"
]
}
}
}
},
"400": {
"description": "The authenticated event is invalid.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthorized",
"automation completed",
"invalid event",
"event id conflict",
"too many events"
],
"description": "A source-ingress refusal. Source credential validation precedes event validation; changed event bytes under an existing identity conflict."
}
},
"required": [
"error"
]
}
}
}
},
"401": {
"description": "The source credential is absent, invalid or no longer current.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthorized",
"automation completed",
"invalid event",
"event id conflict",
"too many events"
],
"description": "A source-ingress refusal. Source credential validation precedes event validation; changed event bytes under an existing identity conflict."
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "The event id already identifies different content.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthorized",
"automation completed",
"invalid event",
"event id conflict",
"too many events"
],
"description": "A source-ingress refusal. Source credential validation precedes event validation; changed event bytes under an existing identity conflict."
}
},
"required": [
"error"
]
}
}
}
},
"410": {
"description": "The automation's firing policy is complete.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthorized",
"automation completed",
"invalid event",
"event id conflict",
"too many events"
],
"description": "A source-ingress refusal. Source credential validation precedes event validation; changed event bytes under an existing identity conflict."
}
},
"required": [
"error"
]
}
}
}
},
"413": {
"description": "The request exceeds the maximum body size.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "The source rate limit refused this event; honor Retry-After.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthorized",
"automation completed",
"invalid event",
"event id conflict",
"too many events"
],
"description": "A source-ingress refusal. Source credential validation precedes event validation; changed event bytes under an existing identity conflict."
}
},
"required": [
"error"
]
}
}
}
}
}
},
"components": {
"schemas": {
"AutomationJsonValueInput": {
"description": "Any JSON value: a string, number, boolean, null, array or object, nested to any depth.",
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AutomationJsonValueInput"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/components/schemas/AutomationJsonValueInput"
}
}
]
},
"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."
}
},
"securitySchemes": {
"automationSourceKey": {
"type": "apiKey",
"in": "header",
"name": "X-Automation-Key",
"description": "An automation's webhook secret, from Rotate the webhook secret. It only sends events to that automation."
}
}
}
}