{"openapi":"3.0.3","info":{"title":"YieldSeeker API","version":"1.0.0","description":"The documented external subset of the YieldSeeker v1 API.\n\n## Authentication\n\n`Authorization` is required for user-scoped endpoints. Send the complete header value `Signature <signature-token>`, where the token is the base64-encoded authentication token produced by the wallet authentication flow.\n\nUser signatures are [Sign-In with Ethereum](https://eips.ethereum.org/EIPS/eip-4361) (SIWE, EIP-4361) messages. Generate a SIWE message for the caller's wallet (domain must be one of YieldSeeker's allowed auth domains, and `issued_at` must be no more than 30 days old), have the wallet sign it, then base64-encode a JSON object of the form `{\"message\": \"<siwe-message>\", \"signature\": \"<hex-signature>\"}` to produce the signature token. A message with an `expirationTime` in the past, or one issued more than 30 days ago, is rejected. For complete signing and header instructions, see the [developer authentication guide](https://docs.yieldseeker.xyz/developers/api/authentication/). For Vault Agent lifecycle, vault discovery, and user-controlled funding and withdrawal behavior, see the [Vault Agent API integration guide](https://docs.yieldseeker.xyz/developers/agents/vault/).\n\n`X-Api-Key` is optional. When provided, it identifies the integrator and is validated against the request origin. Omit it for normal first-party v1 requests.\n\n## Rate limits\n\nMost operations are rate limited per caller (by user for signed requests, by IP for public ones), across one or more rolling windows. Each operation's description states its current limit; a request over that limit receives a `429` response with a `Retry-After` header giving the number of seconds to wait before retrying. Limits can change; treat the `429` response and `Retry-After` header as authoritative, not the documented number alone. See the [rate limits guide](https://docs.yieldseeker.xyz/developers/api/rate-limits/) for the current tiers."},"tags":[{"name":"System","description":"Platform-wide endpoints that need no user context: service health, on-chain contract status, and the assets/chains YieldSeeker currently supports. Use these to check the API is up and to discover what you can build against before creating any users or agents."},{"name":"Users","description":"Manage the human (or integrator end-user) behind the wallet: create an account, look up details, and update a username. A user can own multiple agents, so these endpoints sit above the per-agent resources below."},{"name":"Agents","description":"The core of YieldSeeker: create an agent, deploy its dedicated smart wallet, and track everything it owns - live yield positions, portfolio snapshots, historic performance, and lifetime statistics. This is where you spin up a new autonomous yield-seeking wallet for a user and watch its performance over time, right through to deactivating it once its work is done."},{"name":"Agent Operations","description":"Everything that drives or steers an agent day-to-day. Chat with it directly, review its past allocation decisions, and shape future behavior with steering memories and effective rules. Also covers moving value: withdraw from a yield position, or get back unsigned deposit/withdrawal calldata (prepareDeposit / prepareWithdrawal) so a user can fund or defund the agent's wallet themselves, no backend signing required."}],"paths":{"/v1/health":{"get":{"operationId":"getHealth","summary":"Check API health","tags":["System"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}},"description":"Lightweight liveness check. Returns ok if the API process is reachable; does not verify database, blockchain, or downstream provider connectivity.\n\nRate limited to 30 requests/minute, 300 requests/hour."}},"/v1/onchain-status":{"get":{"operationId":"getOnchainStatus","summary":"Get on-chain status","tags":["System"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOnchainStatusResponse"}}}}},"description":"Returns the on-chain status of platform contracts: timelock configuration, pending operations, and role assignments.\n\nRate limited to 30 requests/minute, 300 requests/hour."}},"/v1/chains/{chainId}/supported-assets":{"get":{"operationId":"listSupportedAssets","summary":"List supported assets","tags":["System"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSupportedAssetsResponse"}}}}},"description":"Lists the base assets (e.g. USDC, WETH) supported for agents on a given chain, along with their observed APY range.\n\nRate limited to 30 requests/minute, 300 requests/hour.","parameters":[{"name":"chainId","in":"path","required":true,"schema":{"default":8453,"exclusiveMaximum":2147483648,"exclusiveMinimum":0,"title":"Chainid","type":"integer"}}]}},"/v1/chains/{chainId}/borrow-pairs":{"get":{"operationId":"listBorrowPairs","summary":"List borrow pairs","tags":["System"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBorrowPairsResponse"}}}}},"description":"Lists borrow pairs with a usable lending market, ordered by collateral and borrow asset symbol.\n\nRate limited to 30 requests/minute, 300 requests/hour.","parameters":[{"name":"chainId","in":"path","required":true,"schema":{"default":8453,"exclusiveMaximum":2147483648,"exclusiveMinimum":0,"title":"Chainid","type":"integer"}}]}},"/v1/chains/{chainId}/assets/{assetAddress}/apy-stats":{"get":{"operationId":"getAssetApyStats","summary":"Get APY statistics for an asset","tags":["System"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAssetApyStatsResponse"}}}}},"description":"Returns active agents' realized 7-day and 30-day APY for a supported base asset, weighted by agent value (average and 25th/50th/75th percentiles), optionally limited to one rule preset, plus `expectedApy7d` and `expectedApy30d` to show a new agent. Realized APY is already after platform fees.\n\nRate limited to 30 requests/minute, 300 requests/hour.","parameters":[{"name":"chainId","in":"path","required":true,"schema":{"exclusiveMaximum":2147483648,"exclusiveMinimum":0,"title":"Chainid","type":"integer"}},{"name":"assetAddress","in":"path","required":true,"schema":{"title":"Assetaddress","type":"string"}},{"name":"rulePreset","in":"query","required":false,"schema":{"anyOf":[{"pattern":"^[a-z]+$","type":"string"},{"type":"null"}],"default":null,"description":"Only count agents on this rule preset (e.g. explorative). Omit to count every preset.","title":"Rulepreset"}}]}},"/v1/platform-stats":{"get":{"operationId":"getPlatformStats","summary":"Get platform statistics","tags":["System"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPlatformStatsResponse"}}}}},"description":"Returns public aggregate statistics for the YieldSeeker platform, including users, agents, tracked value, earned yield, transaction volume, and active-agent APY percentiles.\n\nRate limited to 30 requests/minute, 300 requests/hour."}},"/v1/users":{"post":{"operationId":"createUser","summary":"Create a user account","tags":["Users"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResponse"}}}}},"description":"Creates a new user account for a wallet address. Call this only after login-with-wallet returns NO_USER; wallets that already have an account should log in instead of creating a duplicate.\n\nRate limited to 5 requests/minute, 20 requests/hour, 100 requests/day.","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"walletAddress":{"title":"Walletaddress","type":"string"},"username":{"title":"Username","type":"string"},"signatureString":{"title":"Signaturestring","type":"string"},"referralCode":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Referralcode"}},"required":["walletAddress","username","signatureString"],"title":"CreateUserRequest","type":"object"}}}}}},"/v1/users/{userId}/details":{"get":{"operationId":"getUserDetails","summary":"Get user account details","tags":["Users"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserDetailsResponse"}}}}},"description":"Returns account details for a user: username, display name, connected socials, and referral info.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}}]}},"/v1/users/{userId}/update-username":{"post":{"operationId":"updateUsername","summary":"Update a username","tags":["Users"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsernameResponse"}}}}},"description":"Changes a user's display username.\n\nRate limited to 15 requests/minute, 120 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"newUsername":{"title":"Newusername","type":"string"}},"required":["newUsername"],"title":"UpdateUsernameRequest","type":"object"}}}}}},"/v1/users/login-with-wallet":{"post":{"operationId":"loginWithWallet","summary":"Log in with a wallet address","tags":["Users"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginWithWalletResponse"}}}}},"description":"Resolves the userId for a wallet address. Sign a SIWE message with the wallet and send it as the Authorization signature header; on success the response contains the user, including userId. If the wallet has no account yet, this fails with a NO_USER error - call createUser with the same signature to create one, then use the userId it returns.\n\nRate limited to 5 requests/minute, 20 requests/hour, 100 requests/day.","security":[{"UserSignature":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"walletAddress":{"title":"Walletaddress","type":"string"}},"required":["walletAddress"],"title":"LoginWithWalletRequest","type":"object"}}}}}},"/v1/users/{userId}/agents":{"get":{"operationId":"listUserAgents","summary":"List a user's agents","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUserAgentsResponse"}}}}},"description":"Lists every agent owned by a user, including deactivated ones. Use this to find an existing agent for a given chain/asset before creating a new one.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}}]},"post":{"operationId":"createAgent","summary":"Create an agent","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentResponse"}}}}},"description":"Creates a new agent for a user. The agent wallet is deployed later by initializeAgent. Borrow creation is limited to members of the team experiment and needs the borrowed asset in assetAddressByRole.\n\nRate limited to 15 requests/minute, 120 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"title":"Name","type":"string"},"emoji":{"title":"Emoji","type":"string"},"chainId":{"default":8453,"exclusiveMaximum":2147483648,"exclusiveMinimum":0,"title":"Chainid","type":"integer"},"assetAddress":{"default":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","title":"Assetaddress","type":"string"},"type":{"default":"vault","title":"Type","type":"string"},"rulePreset":{"anyOf":[{"pattern":"^[a-z]+$","type":"string"},{"type":"null"}],"default":null,"title":"Rulepreset"},"assetAddressByRole":{"additionalProperties":{"type":"string"},"title":"Assetaddressbyrole","type":"object"}},"required":["name","emoji"],"title":"CreateAgentRequest","type":"object"}}}}}},"/v1/users/{userId}/agents/{agentId}":{"patch":{"operationId":"updateAgent","summary":"Rename or update an agent","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentResponse"}}}}},"description":"Renames an agent, changes its emoji, or switches its steering rule preset.\n\nRate limited to 15 requests/minute, 120 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Name"},"emoji":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Emoji"},"rulePreset":{"anyOf":[{"pattern":"^[a-z]+$","type":"string"},{"type":"null"}],"default":null,"title":"Rulepreset"}},"required":[],"title":"UpdateAgentRequest","type":"object"}}}}}},"/v1/users/{userId}/agents/{agentId}/deploy":{"post":{"operationId":"initializeAgent","summary":"Initialize an agent","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeployAgentResponse"}}}}},"description":"Deploys the agent smart wallet on-chain. Standard requests require the minimum base-asset balance; validated integrator requests may deploy before funding.\n\nRate limited to 15 requests/minute, 120 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/wallet":{"get":{"operationId":"getAgentWallet","summary":"Get an agent wallet","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAgentWalletResponse"}}}}},"description":"Returns the agent's smart wallet address and its current on-chain asset balances. The wallet address is deterministic and available even before the agent is deployed.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/snapshot":{"get":{"operationId":"getAgentSnapshot","summary":"Get an agent snapshot","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAgentSnapshotResponse"}}}}},"description":"Returns the agent's current portfolio snapshot: total value, net deposits, cumulative yield, and APY. Pass shouldForceRefresh=true to recompute from live on-chain data instead of the cached value.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}},{"name":"shouldForceRefresh","in":"query","required":false,"schema":{"default":false,"title":"Shouldforcerefresh","type":"boolean"}},{"name":"shouldOnlyUseRecentValue","in":"query","required":false,"schema":{"default":true,"title":"Shouldonlyuserecentvalue","type":"boolean"}},{"name":"shouldAllowStaleOnError","in":"query","required":false,"schema":{"default":false,"title":"Shouldallowstaleonerror","type":"boolean"}},{"name":"shouldUseStoredValueOnly","in":"query","required":false,"schema":{"default":false,"title":"Shouldusestoredvalueonly","type":"boolean"}}]}},"/v1/users/{userId}/agents/{agentId}/vault-positions":{"get":{"operationId":"getAgentVaultPositions","summary":"Get agent vault positions","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAgentVaultPositionsResponse"}}}}},"description":"Returns the agent's current live positions across all vaults it holds, including how much of each position is currently withdrawable.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/yield-positions":{"get":{"operationId":"getAgentYieldPositions","summary":"Get agent yield positions (deprecated)","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAgentYieldPositionsResponse"}}}}},"description":"Deprecated: use getAgentVaultPositions, which returns the same positions as `vaultPositions`, each with `vaultOption` in place of `yieldOption`.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}],"deprecated":true}},"/v1/users/{userId}/agents/{agentId}/balance-sheet":{"get":{"operationId":"getAgentBalanceSheet","summary":"Get agent balance sheet","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAgentBalanceSheetResponse"}}}}},"description":"Returns the agent's balance sheet from its stored snapshot, for any agent type: idle wallet balances and protocol positions (vault deposits, borrow positions with their collateral and debt), plus the agent's headline metrics.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/insights":{"get":{"operationId":"listAgentInsights","summary":"List agent insights","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentInsightsResponse"}}}}},"description":"Returns shareable insight cards about what the agent has done, built for its agent type.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/rule-boundaries":{"get":{"operationId":"listAgentRuleBoundaries","summary":"List agent rule boundaries","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentRuleBoundariesResponse"}}}}},"description":"Returns the active rule boundaries the monitor is watching for an agent.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/rule-boundary-states":{"get":{"operationId":"listAgentRuleBoundaryStates","summary":"List agent rule boundary states","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentRuleBoundaryStatesResponse"}}}}},"description":"Returns the latest monitor state (clear, pending_breach or triggered) of each evaluated active rule boundary for an agent.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/wrapped":{"get":{"operationId":"listAgentWrappedStories","summary":"List agent Wrapped stories","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentWrappedStoriesResponse"}}}}},"description":"Returns complete server-selected Wrapped stories currently available for an agent.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/wallet/historic-position":{"get":{"operationId":"getAgentWalletHistoricPosition","summary":"Get an agent wallet historic position","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAgentWalletHistoricPositionResponse"}}}}},"description":"Returns the agent wallet's known asset universe plus its full on-chain transfer history and any recorded daily yield snapshots.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/deactivate":{"post":{"operationId":"deactivateAgent","summary":"Deactivate an agent","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateAgentResponse"}}}}},"description":"Deactivates an agent. Fails with AGENT_HAS_ASSETS if the agent wallet still holds any value; withdraw everything first via withdrawFromPosition (for vault positions) and prepareWithdrawal (for idle wallet balance). Use reactivateAgent to bring it back with its memories and rules.\n\nRate limited to 15 requests/minute, 120 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/reactivate":{"post":{"operationId":"reactivateAgent","summary":"Reactivate an agent","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateAgentResponse"}}}}},"description":"Brings a deactivated agent back with the same agent wallet, memories (including a managed vault allow-list), rules, rule preset and history. Only agents on the current wallet version for their type can come back (AGENT_WALLET_OUTDATED otherwise; create a new agent instead). The same limits as creating an agent apply: USER_MAX_ACTIVE_AGENTS_REACHED when the user is at their active-agent limit, USER_ALREADY_HAS_AGENT_FOR_ASSET when another active agent already uses the asset (assets other than USDC), and AGENT_TYPE_NOT_SUPPORTED when the user can no longer create that agent type. Fails with AGENT_NOT_DEACTIVATED for an active agent. Autoseek picks the agent up again on its next run once the wallet holds at least the funding minimum.\n\nRate limited to 15 requests/minute, 120 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/deposit-made":{"post":{"operationId":"notifyAgentDeposit","summary":"Tell the agent a deposit landed","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositMadeToUserAgentResponse"}}}}},"description":"Call after a deposit to the agent wallet confirms so the agent allocates it straight away instead of on its next scheduled check (every 30 minutes). It queues an autoseek run that reads the wallet live; idle base asset worth at least the funding minimum skips the usual frequency limit. Nothing moves within an hour of a manual withdrawal, or before the agent is deployed.\n\nRate limited to 15 requests/minute, 120 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/chains/{chainId}/assets/{assetAddress}/vault-options":{"get":{"operationId":"listVaultOptions","summary":"List available vaults","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVaultOptionsResponse"}}}}},"description":"Lists the vaults a new agent can allocate to for a chain and base asset, without forcing a refresh: vaults YieldSeeker has disabled, gated or that the agent wallet cannot use are left out, so the list follows our filtering automatically. Set shouldIncludeUnavailable to also get those vaults. Use the returned vault addresses and metadata when building agent memories; availability, APY, liquidity, and rewards can change.\n\nRate limited to 30 requests/minute, 300 requests/hour.","parameters":[{"name":"chainId","in":"path","required":true,"schema":{"exclusiveMaximum":2147483648,"exclusiveMinimum":0,"title":"Chainid","type":"integer"}},{"name":"assetAddress","in":"path","required":true,"schema":{"title":"Assetaddress","type":"string"}},{"name":"shouldAllowStaleOnError","in":"query","required":false,"schema":{"default":false,"title":"Shouldallowstaleonerror","type":"boolean"}},{"name":"shouldIncludeUnavailable","in":"query","required":false,"schema":{"default":false,"description":"Also return vaults a new agent would never allocate to (disabled, gated or not supported by the agent wallet), for example to name vaults an agent still holds.","title":"Shouldincludeunavailable","type":"boolean"}}]}},"/v1/chains/{chainId}/assets/{assetAddress}/yield-options":{"get":{"operationId":"listYieldOptions","summary":"List available vaults (deprecated)","tags":["Agents"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetYieldOptionsResponse"}}}}},"description":"Deprecated: use listVaultOptions, which returns the same vaults as `vaultOptions`.\n\nRate limited to 30 requests/minute, 300 requests/hour.","parameters":[{"name":"chainId","in":"path","required":true,"schema":{"exclusiveMaximum":2147483648,"exclusiveMinimum":0,"title":"Chainid","type":"integer"}},{"name":"assetAddress","in":"path","required":true,"schema":{"title":"Assetaddress","type":"string"}},{"name":"shouldAllowStaleOnError","in":"query","required":false,"schema":{"default":false,"title":"Shouldallowstaleonerror","type":"boolean"}},{"name":"shouldIncludeUnavailable","in":"query","required":false,"schema":{"default":false,"description":"Also return vaults a new agent would never allocate to (disabled, gated or not supported by the agent wallet), for example to name vaults an agent still holds.","title":"Shouldincludeunavailable","type":"boolean"}}],"deprecated":true}},"/v1/users/{userId}/agents/{agentId}/conversations/{conversationId}/add-user-message":{"post":{"operationId":"addUserMessage","summary":"Add a message to an agent conversation","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddUserMessageResponse"}}}}},"description":"Sends a user message to an agent's conversation and returns the agent's full reply once generation is complete. Use addUserMessageStreamed instead for incremental output.\n\nRate limited to 6 requests/minute, 20 requests/5 minutes.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}},{"name":"conversationId","in":"path","required":true,"schema":{"title":"Conversationid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"content":{"title":"Content","type":"string"}},"required":["content"],"title":"AddUserMessageRequest","type":"object"}}}}}},"/v1/users/{userId}/agents/{agentId}/conversations/{conversationId}/add-user-message-streamed":{"post":{"operationId":"addUserMessageStreamed","summary":"Stream a message response","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/x-ndjson":{"schema":{"$ref":"#/components/schemas/AddUserMessageStreamedResponse"}}}}},"description":"Sends a user message to an agent's conversation and streams the agent's reply back incrementally as server-sent events while it is generated.\n\nRate limited to 6 requests/minute, 20 requests/5 minutes.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}},{"name":"conversationId","in":"path","required":true,"schema":{"title":"Conversationid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"content":{"title":"Content","type":"string"}},"required":["content"],"title":"AddUserMessageStreamedRequest","type":"object"}}}}}},"/v1/users/{userId}/agents/{agentId}/conversations/{conversationId}/history":{"get":{"operationId":"getChatHistory","summary":"Get conversation history","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChatHistoryResponse"}}}}},"description":"Returns the full message history for a single conversation between a user and an agent, in chronological order.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}},{"name":"conversationId","in":"path","required":true,"schema":{"title":"Conversationid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/actions":{"get":{"operationId":"listAgentActions","summary":"List agent actions","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAgentActionsResponse"}}}}},"description":"Lists the agent's past allocation and rebalance decisions, most recent first. `limit` and the cursor fields page the response; omit `limit` to return the full history.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Maximum actions to return. Omit to return the full history.","title":"Limit"}},{"name":"cursorCreatedDate","in":"query","required":false,"schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"description":"createdDate of the last action in the previous page.","title":"Cursorcreateddate"}},{"name":"cursorAgentActionId","in":"query","required":false,"schema":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"agentActionId of the last action in the previous page.","title":"Cursoragentactionid"}}]}},"/v1/users/{userId}/agents/{agentId}/memories":{"get":{"operationId":"listAgentMemories","summary":"List agent memories","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAgentMemoriesResponse"}}}}},"description":"Lists the steering memories (natural-language instructions) attached to an agent.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]},"post":{"operationId":"createAgentMemory","summary":"Add an agent memory","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentMemoryResponse"}}}}},"description":"Adds a new steering memory to an agent. Memories are natural-language instructions compiled into rules that influence future allocation decisions. With managedRuleType it creates or rewrites the agent's one managed memory for that setting: borrow_amount and risk_response for Borrow Agents, which can be edited but not deactivated or deleted, and ignored_vault for Vault Agents, an allow-list compiled from the vault addresses in the content without the language model. Only addresses of vaults YieldSeeker lists for the agent's chain and asset are kept, so no such address means no vault; listed vaults autoseek can't deposit into are skipped when it runs. It can also be deactivated or deleted to remove the restriction.\n\nRate limited to 15 requests/minute, 120 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"content":{"title":"Content","type":"string"},"managedRuleType":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Managedruletype"}},"required":["content"],"title":"CreateAgentMemoryRequest","type":"object"}}}}}},"/v1/users/{userId}/agents/{agentId}/memories/effective-rules":{"get":{"operationId":"getAgentEffectiveRules","summary":"Get effective agent steering rules","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAgentEffectiveRulesResponse"}}}}},"description":"Returns the agent's effective steering rules - both the rules derived from its memories and the platform defaults - as currently applied to its allocation decisions.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/borrow-limits":{"get":{"operationId":"getAgentBorrowLimits","summary":"Get how much a borrow agent can borrow","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAgentBorrowLimitsResponse"}}}}},"description":"Returns the most a borrow agent could owe right now at its target health factor, why it cannot borrow more right now, if it cannot, and how much collateral can be closed out without repaying any of the loan. How much it should borrow is its borrow amount memory.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}]}},"/v1/users/{userId}/agents/{agentId}/memories/{memoryId}":{"post":{"operationId":"updateAgentMemory","summary":"Update an agent memory","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentMemoryResponse"}}}}},"description":"Updates the content or active state of an existing agent memory.\n\nRate limited to 15 requests/minute, 120 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}},{"name":"memoryId","in":"path","required":true,"schema":{"title":"Memoryid","type":"integer"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"content":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Content"},"isActive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"title":"Isactive"}},"required":[],"title":"UpdateAgentMemoryRequest","type":"object"}}}}}},"/v1/users/{userId}/agents/{agentId}/memories/{memoryId}/delete":{"post":{"operationId":"deleteAgentMemory","summary":"Delete an agent memory","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAgentMemoryResponse"}}}}},"description":"Permanently deletes an agent memory.\n\nRate limited to 15 requests/minute, 120 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}},{"name":"memoryId","in":"path","required":true,"schema":{"title":"Memoryid","type":"integer"}}]}},"/v1/users/{userId}/agents/{agentId}/withdraw-from-position":{"post":{"operationId":"withdrawFromPosition","summary":"Withdraw assets from a position","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawFromPositionResponse"}}}}},"description":"Closes all or part of one of the agent's positions back into the agent's own smart wallet. Vault agents withdraw the given amount from a yield vault (vaultAddress is the vault address). Borrow agents close the given amount of collateral (vaultAddress is the borrow market id): collateral down to the warning health factor (freeCollateral in getAgentBorrowLimits) comes out without repaying, and anything past it repays the matching share of the loan so what stays open ends at the warning level; closing all of it repays the whole loan. The backend repays from the agent's idle borrowed asset and sells some of the closed collateral for any shortfall. Executed by the backend using the agent's session key; no signature or gas is required from the caller. This does not send funds to the user - call prepareWithdrawal afterward to move the withdrawn balance out of the agent wallet.\n\nRate limited to 5 requests/minute, 30 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"chainId":{"exclusiveMaximum":2147483648,"exclusiveMinimum":0,"title":"Chainid","type":"integer"},"vaultAddress":{"title":"Vaultaddress","type":"string"},"assetsRaw":{"title":"Assetsraw","type":"integer"}},"required":["chainId","vaultAddress","assetsRaw"],"title":"WithdrawFromPositionRequest","type":"object"}}}}}},"/v1/users/{userId}/agents/{agentId}/prepare-deposit":{"post":{"operationId":"prepareDeposit","summary":"Prepare a deposit transaction","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepareDepositResponse"}}}}},"description":"Builds unsigned transaction data for transferring amountRaw of the agent's base asset from the caller's own wallet into the agent's smart wallet. This endpoint does not move any funds or require a signature - it only returns calldata. The caller must sign and submit the returned transaction (from, to, data, value, chainId) themselves using their own wallet, then refresh the agent snapshot after the transaction confirms.\n\nRate limited to 5 requests/minute, 30 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"amountRaw":{"title":"Amountraw","type":"integer"}},"required":["amountRaw"],"title":"PrepareDepositRequest","type":"object"}}}}}},"/v1/users/{userId}/agents/{agentId}/prepare-withdrawal":{"post":{"operationId":"prepareWithdrawal","summary":"Prepare a withdrawal transaction","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepareWithdrawalResponse"}}}}},"description":"Builds unsigned transaction data for withdrawing an idle asset directly from the agent's smart wallet back to the caller's own wallet. Only the wallet owner (the user) can execute this on-chain call. Omit assetAddress to withdraw the agent's base asset; Borrow agents withdraw their borrowed asset. Omit amountRaw to withdraw the entire available balance. This endpoint does not move any funds - the caller must sign and submit the returned transaction (from, to, data, value, chainId) themselves. This only withdraws the agent wallet's idle balance; funds still deployed in a yield vault must first be withdrawn via withdrawFromPosition.\n\nRate limited to 5 requests/minute, 30 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"assetAddress":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Assetaddress"},"amountRaw":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Amountraw"}},"required":[],"title":"PrepareWithdrawalRequest","type":"object"}}}}}},"/v1/users/{userId}/agents/{agentId}/simulate":{"post":{"operationId":"runAgentSimulation","summary":"Simulate a set of agent memories","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunAgentSimulationResponse"}}}}},"description":"Previews the effect of adding one or more steering memories to an agent without actually saving them or changing the agent's real rules or allocation. Compiles the given memory strings into rules alongside the agent's existing defaults and its saved vault allow-list (a managed ignored_vault memory, which always applies), re-scores the available vaults, and returns the projected target allocation and derived rules. Each call consumes one simulation credit; check remaining credits with getSimulationCreditsStatus.\n\nRate limited to 3 requests/minute, 10 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}},{"name":"agentId","in":"path","required":true,"schema":{"title":"Agentid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"memories":{"items":{"type":"string"},"title":"Memories","type":"array"}},"required":["memories"],"title":"RunAgentSimulationRequest","type":"object"}}}}}},"/v1/users/{userId}/simulate/credits":{"get":{"operationId":"getSimulationCreditsStatus","summary":"Get remaining simulation credits","tags":["Agent Operations"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSimulationCreditsStatusResponse"}}}}},"description":"Returns how many runAgentSimulation calls the user has left today, along with their daily limit. Credits reset daily (UTC) and the limit is higher for Pro users.\n\nRate limited to 30 requests/minute, 300 requests/hour.","security":[{"UserSignature":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","type":"string"}}]}},"/v1/render-share-cards":{"post":{"operationId":"renderShareCards","summary":"Render multiple share cards","tags":["Share Cards"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderShareCardsResponse"}}}}},"description":"Renders multiple share cards in one rate-limited request.\n\nRate limited to 5 requests/minute, 30 requests/hour.","security":[{"UserSignature":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cards":{"items":{"$ref":"#/components/schemas/RenderShareCardRequest"},"maxItems":10,"minItems":1,"title":"Cards","type":"array"}},"required":["cards"],"title":"RenderShareCardsRequest","type":"object"}}}}}}},"components":{"schemas":{"Health":{"properties":{"status":{"const":"ok","title":"Status","type":"string"}},"required":["status"],"title":"Health","type":"object"},"HealthResponse":{"properties":{"health":{"$ref":"#/components/schemas/Health"}},"required":["health"],"title":"HealthResponse","type":"object"},"OnchainStatus":{"properties":{"chainId":{"title":"Chainid","type":"integer"},"timelockDelaySeconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timelockdelayseconds"},"contracts":{"items":{"$ref":"#/components/schemas/OnchainStatusContract"},"title":"Contracts","type":"array"},"registryEntries":{"items":{"$ref":"#/components/schemas/OnchainStatusRegistryEntry"},"title":"Registryentries","type":"array"},"timelockOperations":{"items":{"$ref":"#/components/schemas/TimelockOperation"},"title":"Timelockoperations","type":"array"}},"required":["chainId","timelockDelaySeconds","contracts","registryEntries","timelockOperations"],"title":"OnchainStatus","type":"object"},"OnchainStatusContract":{"properties":{"key":{"title":"Key","type":"string"},"name":{"title":"Name","type":"string"},"address":{"title":"Address","type":"string"},"category":{"title":"Category","type":"string"},"fieldValues":{"items":{"$ref":"#/components/schemas/OperationParameter"},"title":"Fieldvalues","type":"array"},"roles":{"items":{"$ref":"#/components/schemas/OnchainStatusRoleAssignment"},"title":"Roles","type":"array"}},"required":["key","name","address","category","fieldValues","roles"],"title":"OnchainStatusContract","type":"object"},"OnchainStatusRegistryEntry":{"properties":{"target":{"title":"Target","type":"string"},"targetName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Targetname"},"adapter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adapter"},"adapterName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adaptername"}},"required":["target","targetName","adapter","adapterName"],"title":"OnchainStatusRegistryEntry","type":"object"},"OnchainStatusRoleAssignment":{"properties":{"roleKey":{"title":"Rolekey","type":"string"},"roleLabel":{"title":"Rolelabel","type":"string"},"members":{"items":{"$ref":"#/components/schemas/RoleMember"},"title":"Members","type":"array"}},"required":["roleKey","roleLabel","members"],"title":"OnchainStatusRoleAssignment","type":"object"},"OperationParameter":{"properties":{"name":{"title":"Name","type":"string"},"value":{"title":"Value","type":"string"},"valueType":{"title":"Valuetype","type":"string"},"valueLabel":{"title":"Valuelabel","type":"string"}},"required":["name","value","valueType","valueLabel"],"title":"OperationParameter","type":"object"},"RoleMember":{"properties":{"address":{"title":"Address","type":"string"},"label":{"title":"Label","type":"string"}},"required":["address","label"],"title":"RoleMember","type":"object"},"TimelockOperation":{"properties":{"operationId":{"title":"Operationid","type":"string"},"status":{"title":"Status","type":"string"},"target":{"title":"Target","type":"string"},"targetName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Targetname"},"functionName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Functionname"},"functionSelector":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Functionselector"},"parameters":{"items":{"$ref":"#/components/schemas/OperationParameter"},"title":"Parameters","type":"array"},"scheduledTransactionHash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scheduledtransactionhash"},"executedTransactionHash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Executedtransactionhash"},"delay":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Delay"},"unlocksAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unlocksat"}},"required":["operationId","status","target","targetName","functionName","functionSelector","parameters","scheduledTransactionHash","executedTransactionHash","delay","unlocksAt"],"title":"TimelockOperation","type":"object"},"GetOnchainStatusResponse":{"properties":{"onchainStatus":{"$ref":"#/components/schemas/OnchainStatus"}},"required":["onchainStatus"],"title":"GetOnchainStatusResponse","type":"object"},"Asset":{"properties":{"chainId":{"title":"Chainid","type":"integer"},"address":{"title":"Address","type":"string"},"decimals":{"title":"Decimals","type":"integer"},"name":{"title":"Name","type":"string"},"symbol":{"title":"Symbol","type":"string"},"logoUri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logouri"},"totalSupply":{"$ref":"#/components/schemas/BigInt"},"isSpam":{"title":"Isspam","type":"boolean"}},"required":["chainId","address","decimals","name","symbol","logoUri","totalSupply","isSpam"],"title":"Asset","type":"object"},"BigInt":{"type":"string"},"SupportedAsset":{"properties":{"asset":{"$ref":"#/components/schemas/Asset"},"minApy":{"title":"Minapy","type":"number"},"maxApy":{"title":"Maxapy","type":"number"}},"required":["asset","minApy","maxApy"],"title":"SupportedAsset","type":"object"},"GetSupportedAssetsResponse":{"properties":{"supportedAssets":{"items":{"$ref":"#/components/schemas/SupportedAsset"},"title":"Supportedassets","type":"array"}},"required":["supportedAssets"],"title":"GetSupportedAssetsResponse","type":"object"},"BorrowPair":{"properties":{"collateralAsset":{"$ref":"#/components/schemas/Asset"},"borrowAsset":{"$ref":"#/components/schemas/Asset"},"netBorrowApy":{"title":"Netborrowapy","type":"number"},"maxNetBorrowApy":{"title":"Maxnetborrowapy","type":"number"}},"required":["collateralAsset","borrowAsset","netBorrowApy","maxNetBorrowApy"],"title":"BorrowPair","type":"object"},"GetBorrowPairsResponse":{"properties":{"borrowPairs":{"items":{"$ref":"#/components/schemas/BorrowPair"},"title":"Borrowpairs","type":"array"}},"required":["borrowPairs"],"title":"GetBorrowPairsResponse","type":"object"},"AssetApyStats":{"properties":{"chainId":{"title":"Chainid","type":"integer"},"assetAddress":{"title":"Assetaddress","type":"string"},"rulePreset":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rulepreset"},"apyMoneyWeighted7d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Average of active agents' 7-day APY on this asset, weighted by each agent's value. Realized returns, so already after platform fees. Counts agents worth at least $100 with at least 7 days of history, excluding users in a YieldSeeker Merkl or boost campaign that ran in the last 7 days (their APY includes campaign rewards). Null when fewer than 20 agents qualify.","title":"Apymoneyweighted7D"},"apy25thPercentile7d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"25th percentile (by value: a quarter of the money earned less) of active agents' 7-day APY on this asset, weighted by each agent's value. Realized returns, so already after platform fees. Counts agents worth at least $100 with at least 7 days of history, excluding users in a YieldSeeker Merkl or boost campaign that ran in the last 7 days (their APY includes campaign rewards). Null when fewer than 20 agents qualify.","title":"Apy25Thpercentile7D"},"apyMedian7d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Median (by value: half of the money earned less) of active agents' 7-day APY on this asset, weighted by each agent's value. Realized returns, so already after platform fees. Counts agents worth at least $100 with at least 7 days of history, excluding users in a YieldSeeker Merkl or boost campaign that ran in the last 7 days (their APY includes campaign rewards). Null when fewer than 20 agents qualify.","title":"Apymedian7D"},"apy75thPercentile7d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"75th percentile (by value: three quarters of the money earned less) of active agents' 7-day APY on this asset, weighted by each agent's value. Realized returns, so already after platform fees. Counts agents worth at least $100 with at least 7 days of history, excluding users in a YieldSeeker Merkl or boost campaign that ran in the last 7 days (their APY includes campaign rewards). Null when fewer than 20 agents qualify.","title":"Apy75Thpercentile7D"},"expectedApy7d":{"description":"The 7-day APY to show a new agent, after platform fees. apyMoneyWeighted7d when at least 20 agents qualify; otherwise an estimate from the allocation engine's current target allocation for a $10,000 deposit on this preset (default preset when rulePreset is omitted), weighted by each vault's 7-day average APY.","title":"Expectedapy7D","type":"number"},"apyMoneyWeighted30d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Average of active agents' 30-day APY on this asset, weighted by each agent's value. Realized returns, so already after platform fees. Counts agents worth at least $100 with at least 30 days of history, excluding users in a YieldSeeker Merkl or boost campaign that ran in the last 30 days (their APY includes campaign rewards). Null when fewer than 20 agents qualify.","title":"Apymoneyweighted30D"},"apy25thPercentile30d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"25th percentile (by value: a quarter of the money earned less) of active agents' 30-day APY on this asset, weighted by each agent's value. Realized returns, so already after platform fees. Counts agents worth at least $100 with at least 30 days of history, excluding users in a YieldSeeker Merkl or boost campaign that ran in the last 30 days (their APY includes campaign rewards). Null when fewer than 20 agents qualify.","title":"Apy25Thpercentile30D"},"apyMedian30d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Median (by value: half of the money earned less) of active agents' 30-day APY on this asset, weighted by each agent's value. Realized returns, so already after platform fees. Counts agents worth at least $100 with at least 30 days of history, excluding users in a YieldSeeker Merkl or boost campaign that ran in the last 30 days (their APY includes campaign rewards). Null when fewer than 20 agents qualify.","title":"Apymedian30D"},"apy75thPercentile30d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"75th percentile (by value: three quarters of the money earned less) of active agents' 30-day APY on this asset, weighted by each agent's value. Realized returns, so already after platform fees. Counts agents worth at least $100 with at least 30 days of history, excluding users in a YieldSeeker Merkl or boost campaign that ran in the last 30 days (their APY includes campaign rewards). Null when fewer than 20 agents qualify.","title":"Apy75Thpercentile30D"},"expectedApy30d":{"description":"The 30-day APY to show a new agent, after platform fees. apyMoneyWeighted30d when at least 20 agents qualify; otherwise an estimate from the allocation engine's current target allocation for a $10,000 deposit on this preset (default preset when rulePreset is omitted), weighted by each vault's 30-day average APY.","title":"Expectedapy30D","type":"number"}},"required":["chainId","assetAddress","rulePreset","apyMoneyWeighted7d","apy25thPercentile7d","apyMedian7d","apy75thPercentile7d","expectedApy7d","apyMoneyWeighted30d","apy25thPercentile30d","apyMedian30d","apy75thPercentile30d","expectedApy30d"],"title":"AssetApyStats","type":"object"},"GetAssetApyStatsResponse":{"properties":{"assetApyStats":{"$ref":"#/components/schemas/AssetApyStats"}},"required":["assetApyStats"],"title":"GetAssetApyStatsResponse","type":"object"},"GetPlatformStatsResponse":{"properties":{"userCount":{"description":"Total number of registered users.","title":"Usercount","type":"integer"},"agentCount":{"description":"Total number of agents across the platform.","title":"Agentcount","type":"integer"},"totalTvlUsd":{"description":"Total value currently tracked across agents, in USD.","title":"Totaltvlusd","type":"number"},"totalYieldEarnedUsd":{"description":"Cumulative yield earned across agents, in USD.","title":"Totalyieldearnedusd","type":"number"},"totalTransactionCount":{"description":"Total number of transactions executed by agents.","title":"Totaltransactioncount","type":"integer"},"totalTransactionValueUsd":{"description":"Total value of agent transactions, in USD.","title":"Totaltransactionvalueusd","type":"number"},"apy75thPercentile":{"description":"75th percentile APY across active agents, expressed as a percentage.","title":"Apy75Thpercentile","type":"number"},"apyMax":{"description":"Maximum APY across active agents, expressed as a percentage.","title":"Apymax","type":"number"}},"required":["userCount","agentCount","totalTvlUsd","totalYieldEarnedUsd","totalTransactionCount","totalTransactionValueUsd","apy75thPercentile","apyMax"],"title":"GetPlatformStatsResponse","type":"object"},"User":{"properties":{"userId":{"title":"Userid","type":"string"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"},"username":{"title":"Username","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"required":["userId","createdDate","username","name"],"title":"User","type":"object"},"CreateUserResponse":{"properties":{"user":{"$ref":"#/components/schemas/User"}},"required":["user"],"title":"CreateUserResponse","type":"object"},"UserDetails":{"properties":{"userId":{"title":"Userid","type":"string"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"},"username":{"title":"Username","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"twitterId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Twitterid"},"discordId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Discordid"},"telegramId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Telegramid"},"telegramChatId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Telegramchatid"},"referrerUserId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referreruserid"},"referrerUsername":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referrerusername"},"experimentCodes":{"items":{"type":"string"},"title":"Experimentcodes","type":"array"}},"required":["userId","createdDate","username","name","twitterId","discordId","telegramId","telegramChatId","referrerUserId","referrerUsername","experimentCodes"],"title":"UserDetails","type":"object"},"GetUserDetailsResponse":{"properties":{"userDetails":{"$ref":"#/components/schemas/UserDetails"}},"required":["userDetails"],"title":"GetUserDetailsResponse","type":"object"},"UpdateUsernameResponse":{"properties":{"user":{"$ref":"#/components/schemas/User"}},"required":["user"],"title":"UpdateUsernameResponse","type":"object"},"LoginWithWalletResponse":{"properties":{"user":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]}},"required":["user"],"title":"LoginWithWalletResponse","type":"object"},"Agent":{"properties":{"agentId":{"title":"Agentid","type":"string"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"},"name":{"title":"Name","type":"string"},"emoji":{"title":"Emoji","type":"string"},"chainId":{"title":"Chainid","type":"integer"},"assetAddress":{"title":"Assetaddress","type":"string"},"assetAddressByRole":{"additionalProperties":{"type":"string"},"title":"Assetaddressbyrole","type":"object"},"type":{"title":"Type","type":"string"},"rulePreset":{"title":"Rulepreset","type":"string"},"isYieldProduct":{"title":"Isyieldproduct","type":"boolean"}},"required":["agentId","createdDate","name","emoji","chainId","assetAddress","assetAddressByRole","type","rulePreset","isYieldProduct"],"title":"Agent","type":"object"},"ListUserAgentsResponse":{"properties":{"agents":{"items":{"$ref":"#/components/schemas/Agent"},"title":"Agents","type":"array"}},"required":["agents"],"title":"ListUserAgentsResponse","type":"object"},"CreateAgentResponse":{"properties":{"agent":{"$ref":"#/components/schemas/Agent"}},"required":["agent"],"title":"CreateAgentResponse","type":"object"},"UpdateAgentResponse":{"properties":{"agent":{"$ref":"#/components/schemas/Agent"}},"required":["agent"],"title":"UpdateAgentResponse","type":"object"},"AgentWallet":{"properties":{"agentWalletId":{"title":"Agentwalletid","type":"string"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"},"agentId":{"title":"Agentid","type":"string"},"walletAddress":{"title":"Walletaddress","type":"string"},"isPrimary":{"title":"Isprimary","type":"boolean"},"walletType":{"title":"Wallettype","type":"string"},"deactivatedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Deactivateddate"},"initializedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Initializeddate"}},"required":["agentWalletId","createdDate","agentId","walletAddress","isPrimary","walletType"],"title":"AgentWallet","type":"object"},"DeployAgentResponse":{"properties":{"agentWallet":{"$ref":"#/components/schemas/AgentWallet"}},"required":["agentWallet"],"title":"DeployAgentResponse","type":"object"},"GetAgentWalletResponse":{"properties":{"agentWallet":{"$ref":"#/components/schemas/AgentWallet"}},"required":["agentWallet"],"title":"GetAgentWalletResponse","type":"object"},"AgentWalletSnapshot":{"properties":{"agentWalletSnapshotId":{"title":"Agentwalletsnapshotid","type":"integer"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"},"updatedDate":{"format":"date-time","title":"Updateddate","type":"string"},"agentId":{"title":"Agentid","type":"string"},"tokenBalances":{"additionalProperties":{"$ref":"#/components/schemas/BigInt"},"title":"Tokenbalances","type":"object"},"tokenBalancesBase":{"additionalProperties":{"$ref":"#/components/schemas/BigInt"},"title":"Tokenbalancesbase","type":"object"},"totalValueBase":{"$ref":"#/components/schemas/BigInt"},"netDepositTokenBalances":{"additionalProperties":{"$ref":"#/components/schemas/BigInt"},"title":"Netdeposittokenbalances","type":"object"},"netDepositTokenBalancesBase":{"additionalProperties":{"$ref":"#/components/schemas/BigInt"},"title":"Netdeposittokenbalancesbase","type":"object"},"netDepositsBase":{"$ref":"#/components/schemas/BigInt"},"feesOwedBase":{"$ref":"#/components/schemas/BigInt"},"feesPaidBase":{"$ref":"#/components/schemas/BigInt"},"pendingFeesBase":{"$ref":"#/components/schemas/BigInt"},"feeRateBps":{"title":"Feeratebps","type":"integer"},"cumulativeYieldBase":{"$ref":"#/components/schemas/BigInt","description":"Total value minus net deposits, in base-asset units. For agent types where isYieldProduct is true (Vault) this is the yield earned, net of fees already charged and of pending fees on unrealized yield. For other types it is the change in value against deposits and not yield: for Borrow it is mostly loan interest plus the effect of the collateral price on the debt, which is counted in the collateral (base) asset."},"baseAssetPriceUsd":{"title":"Baseassetpriceusd","type":"number"},"baseAssetDecimals":{"title":"Baseassetdecimals","type":"integer"},"apy1d":{"description":"Annualised return over the last day, from daily time-weighted (Modified Dietz) returns of total value against deposits (Vault). For Borrow it is instead the loan's cost: interest charged over the window as a negative yearly share of the average loan.","title":"Apy1D","type":"number"},"apy7d":{"description":"Annualised return over the last 7 days, from daily time-weighted (Modified Dietz) returns of total value against deposits (Vault). For Borrow it is instead the loan's cost: interest charged over the window as a negative yearly share of the average loan.","title":"Apy7D","type":"number"},"apy30d":{"description":"Annualised return over the last 30 days, from daily time-weighted (Modified Dietz) returns of total value against deposits (Vault). For Borrow it is instead the loan's cost: interest charged over the window as a negative yearly share of the average loan.","title":"Apy30D","type":"number"},"apy90d":{"description":"Annualised return over the last 90 days, from daily time-weighted (Modified Dietz) returns of total value against deposits (Vault). For Borrow it is instead the loan's cost: interest charged over the window as a negative yearly share of the average loan.","title":"Apy90D","type":"number"},"apyAllTime":{"description":"Annualised return over all history since apyStartDate, from daily time-weighted (Modified Dietz) returns of total value against deposits (Vault). For Borrow it is instead the loan's cost: interest charged over the window as a negative yearly share of the average loan.","title":"Apyalltime","type":"number"},"apyStartDate":{"description":"First day the agent held value. The APY windows never start before it.","format":"date","title":"Apystartdate","type":"string"},"hasEnoughHistory":{"description":"True once apyStartDate is at least 5 days ago. Before that the APYs are too short-term to show.","title":"Hasenoughhistory","type":"boolean"}},"required":["agentWalletSnapshotId","createdDate","updatedDate","agentId","tokenBalances","tokenBalancesBase","totalValueBase","netDepositTokenBalances","netDepositTokenBalancesBase","netDepositsBase","feesOwedBase","feesPaidBase","pendingFeesBase","feeRateBps","cumulativeYieldBase","baseAssetPriceUsd","baseAssetDecimals","apy1d","apy7d","apy30d","apy90d","apyAllTime","apyStartDate","hasEnoughHistory"],"title":"AgentWalletSnapshot","type":"object"},"GetAgentSnapshotResponse":{"properties":{"agentSnapshot":{"$ref":"#/components/schemas/AgentWalletSnapshot"}},"required":["agentSnapshot"],"title":"GetAgentSnapshotResponse","type":"object"},"VaultOption":{"properties":{"provider":{"title":"Provider","type":"string"},"assetAddress":{"title":"Assetaddress","type":"string"},"name":{"title":"Name","type":"string"},"symbol":{"title":"Symbol","type":"string"},"address":{"title":"Address","type":"string"},"chainId":{"title":"Chainid","type":"integer"},"totalDepositsUsd":{"title":"Totaldepositsusd","type":"number"},"totalDeposits":{"title":"Totaldeposits","type":"number"},"startDate":{"format":"date-time","title":"Startdate","type":"string"},"totalApy":{"title":"Totalapy","type":"number"},"baseApy":{"title":"Baseapy","type":"number"},"riskAdjustedApy":{"title":"Riskadjustedapy","type":"number"},"riskAdjustedApy1dAverage":{"title":"Riskadjustedapy1Daverage","type":"number"},"riskAdjustedApy7dAverage":{"title":"Riskadjustedapy7Daverage","type":"number"},"riskAdjustedApy30dAverage":{"title":"Riskadjustedapy30Daverage","type":"number"},"riskAdjustedApy90dAverage":{"title":"Riskadjustedapy90Daverage","type":"number"},"rewards":{"items":{"$ref":"#/components/schemas/VaultOptionReward"},"title":"Rewards","type":"array"},"withdrawalFee":{"title":"Withdrawalfee","type":"number"},"maxDeposits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxdeposits"},"maxDepositsUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Maxdepositsusd"},"withdrawableDeposits":{"title":"Withdrawabledeposits","type":"integer"},"withdrawableDepositsUsd":{"title":"Withdrawabledepositsusd","type":"number"}},"required":["provider","assetAddress","name","symbol","address","chainId","totalDepositsUsd","totalDeposits","startDate","totalApy","baseApy","riskAdjustedApy","riskAdjustedApy1dAverage","riskAdjustedApy7dAverage","riskAdjustedApy30dAverage","riskAdjustedApy90dAverage","rewards","withdrawalFee","maxDeposits","maxDepositsUsd","withdrawableDeposits","withdrawableDepositsUsd"],"title":"VaultOption","type":"object"},"VaultOptionReward":{"properties":{"asset":{"$ref":"#/components/schemas/Asset"},"apy":{"title":"Apy","type":"number"},"riskAdjustedApy":{"title":"Riskadjustedapy","type":"number"}},"required":["asset","apy","riskAdjustedApy"],"title":"VaultOptionReward","type":"object"},"VaultPosition":{"properties":{"vaultOption":{"$ref":"#/components/schemas/VaultOption"},"assetsRaw":{"$ref":"#/components/schemas/BigInt"},"assetsBase":{"$ref":"#/components/schemas/BigInt"},"assetsUsd":{"title":"Assetsusd","type":"number"},"withdrawableAssetsRaw":{"$ref":"#/components/schemas/BigInt"},"withdrawableAssetsBase":{"$ref":"#/components/schemas/BigInt"},"netApy":{"description":"The vault's current riskAdjustedApy after the agent's platform fee. An estimate: the fee is only charged on realized positive yield.","title":"Netapy","type":"number"}},"required":["vaultOption","assetsRaw","assetsBase","assetsUsd","withdrawableAssetsRaw","withdrawableAssetsBase","netApy"],"title":"VaultPosition","type":"object"},"GetAgentVaultPositionsResponse":{"properties":{"vaultPositions":{"items":{"$ref":"#/components/schemas/VaultPosition"},"title":"Vaultpositions","type":"array"}},"required":["vaultPositions"],"title":"GetAgentVaultPositionsResponse","type":"object"},"YieldPosition":{"properties":{"yieldOption":{"$ref":"#/components/schemas/VaultOption"},"assetsRaw":{"$ref":"#/components/schemas/BigInt"},"assetsBase":{"$ref":"#/components/schemas/BigInt"},"assetsUsd":{"title":"Assetsusd","type":"number"},"withdrawableAssetsRaw":{"$ref":"#/components/schemas/BigInt"},"withdrawableAssetsBase":{"$ref":"#/components/schemas/BigInt"}},"required":["yieldOption","assetsRaw","assetsBase","assetsUsd","withdrawableAssetsRaw","withdrawableAssetsBase"],"title":"YieldPosition","type":"object"},"GetAgentYieldPositionsResponse":{"properties":{"yieldPositions":{"items":{"$ref":"#/components/schemas/YieldPosition"},"title":"Yieldpositions","type":"array"}},"required":["yieldPositions"],"title":"GetAgentYieldPositionsResponse","type":"object"},"AgentAmount":{"properties":{"asset":{"$ref":"#/components/schemas/Asset"},"amountRaw":{"$ref":"#/components/schemas/BigInt"},"valueUsd":{"title":"Valueusd","type":"number"}},"required":["asset","amountRaw","valueUsd"],"title":"AgentAmount","type":"object"},"AgentAmountMetric":{"properties":{"label":{"title":"Label","type":"string"},"amount":{"$ref":"#/components/schemas/AgentAmount"}},"required":["label","amount"],"title":"AgentAmountMetric","type":"object"},"AgentBalanceSheet":{"properties":{"summary":{"anyOf":[{"$ref":"#/components/schemas/AgentAmountMetric"},{"type":"null"}]},"metrics":{"items":{"$ref":"#/components/schemas/AgentMetric"},"title":"Metrics","type":"array"},"lines":{"items":{"$ref":"#/components/schemas/AgentBalanceSheetLine"},"title":"Lines","type":"array"},"details":{"items":{"$ref":"#/components/schemas/AgentAmountMetric"},"title":"Details","type":"array"}},"required":["summary","metrics","lines","details"],"title":"AgentBalanceSheet","type":"object"},"AgentBalanceSheetLine":{"properties":{"lineKey":{"title":"Linekey","type":"string"},"name":{"title":"Name","type":"string"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider"},"supplied":{"items":{"$ref":"#/components/schemas/AgentAmount"},"title":"Supplied","type":"array"},"borrowed":{"items":{"$ref":"#/components/schemas/AgentAmount"},"title":"Borrowed","type":"array"},"pendingFees":{"items":{"$ref":"#/components/schemas/AgentAmount"},"title":"Pendingfees","type":"array"},"apy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Apy"},"metrics":{"items":{"$ref":"#/components/schemas/AgentMetric"},"title":"Metrics","type":"array"},"isAwaitingAllocation":{"title":"Isawaitingallocation","type":"boolean"},"withdrawal":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Withdrawal"},"adjustment":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"An action that changes the line without withdrawing: `loan` changes how much the agent borrows and whether it may sell collateral (getAgentBorrowLimits, and createAgentMemory with managedRuleType).","title":"Adjustment"}},"required":["lineKey","name","provider","supplied","borrowed","pendingFees","apy","metrics","isAwaitingAllocation","withdrawal"],"title":"AgentBalanceSheetLine","type":"object"},"AgentMetric":{"properties":{"label":{"title":"Label","type":"string"},"unit":{"title":"Unit","type":"string"},"value":{"title":"Value","type":"number"},"decimals":{"title":"Decimals","type":"integer"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"required":["label","unit","value","decimals","description"],"title":"AgentMetric","type":"object"},"GetAgentBalanceSheetResponse":{"properties":{"balanceSheet":{"$ref":"#/components/schemas/AgentBalanceSheet"}},"required":["balanceSheet"],"title":"GetAgentBalanceSheetResponse","type":"object"},"AgentInsight":{"properties":{"key":{"title":"Key","type":"string"},"emoji":{"title":"Emoji","type":"string"},"title":{"title":"Title","type":"string"},"card":{"$ref":"#/components/schemas/ShareCard"}},"required":["key","emoji","title","card"],"title":"AgentInsight","type":"object"},"ShareCard":{"properties":{"bigMetric":{"title":"Bigmetric","type":"string"},"bigMetricLabel":{"title":"Bigmetriclabel","type":"string"},"eyebrow":{"title":"Eyebrow","type":"string"},"details":{"items":{"$ref":"#/components/schemas/ShareCardDetail"},"title":"Details","type":"array"},"detailText":{"title":"Detailtext","type":"string"},"shareText":{"title":"Sharetext","type":"string"}},"required":["bigMetric","bigMetricLabel","eyebrow","details","detailText","shareText"],"title":"ShareCard","type":"object"},"ShareCardDetail":{"properties":{"label":{"title":"Label","type":"string"},"value":{"title":"Value","type":"string"}},"required":["label","value"],"title":"ShareCardDetail","type":"object"},"ListAgentInsightsResponse":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/AgentInsight"},"title":"Insights","type":"array"}},"required":["insights"],"title":"ListAgentInsightsResponse","type":"object"},"AgentRuleBoundary":{"properties":{"agentRuleBoundaryId":{"title":"Agentruleboundaryid","type":"integer"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"},"updatedDate":{"format":"date-time","title":"Updateddate","type":"string"},"agentId":{"title":"Agentid","type":"string"},"agentRuleId":{"title":"Agentruleid","type":"integer"},"ruleType":{"title":"Ruletype","type":"string"},"chainId":{"title":"Chainid","type":"integer"},"subjectKey":{"title":"Subjectkey","type":"string"},"metric":{"title":"Metric","type":"string"},"comparator":{"title":"Comparator","type":"string"},"severity":{"title":"Severity","type":"string"},"thresholdFloatValue":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Thresholdfloatvalue"},"thresholdIntValue":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Thresholdintvalue"},"thresholdText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thresholdtext"}},"required":["agentRuleBoundaryId","createdDate","updatedDate","agentId","agentRuleId","ruleType","chainId","subjectKey","metric","comparator","severity","thresholdFloatValue","thresholdIntValue","thresholdText"],"title":"AgentRuleBoundary","type":"object"},"ListAgentRuleBoundariesResponse":{"properties":{"boundaries":{"items":{"$ref":"#/components/schemas/AgentRuleBoundary"},"title":"Boundaries","type":"array"}},"required":["boundaries"],"title":"ListAgentRuleBoundariesResponse","type":"object"},"AgentRuleBoundaryState":{"properties":{"agentRuleBoundaryStateId":{"title":"Agentruleboundarystateid","type":"integer"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"},"updatedDate":{"format":"date-time","title":"Updateddate","type":"string"},"boundary":{"$ref":"#/components/schemas/AgentRuleBoundary"},"subjectName":{"title":"Subjectname","type":"string"},"metricLabel":{"title":"Metriclabel","type":"string"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"status":{"title":"Status","type":"string"},"statusSinceDate":{"format":"date-time","title":"Statussincedate","type":"string"}},"required":["agentRuleBoundaryStateId","createdDate","updatedDate","boundary","subjectName","metricLabel","unit","status","statusSinceDate"],"title":"AgentRuleBoundaryState","type":"object"},"ListAgentRuleBoundaryStatesResponse":{"properties":{"boundaryStates":{"items":{"$ref":"#/components/schemas/AgentRuleBoundaryState"},"title":"Boundarystates","type":"array"}},"required":["boundaryStates"],"title":"ListAgentRuleBoundaryStatesResponse","type":"object"},"WrappedStory":{"properties":{"storyId":{"title":"Storyid","type":"string"},"kind":{"enum":["birthday","yearInReview"],"title":"Kind","type":"string"},"title":{"title":"Title","type":"string"},"subtitle":{"title":"Subtitle","type":"string"},"buttonText":{"title":"Buttontext","type":"string"},"shouldShowBanner":{"title":"Shouldshowbanner","type":"boolean"},"cards":{"items":{"$ref":"#/components/schemas/ShareCard"},"title":"Cards","type":"array"}},"required":["storyId","kind","title","subtitle","buttonText","shouldShowBanner","cards"],"title":"WrappedStory","type":"object"},"ListAgentWrappedStoriesResponse":{"properties":{"stories":{"items":{"$ref":"#/components/schemas/WrappedStory"},"title":"Stories","type":"array"}},"required":["stories"],"title":"ListAgentWrappedStoriesResponse","type":"object"},"AgentHistoryChart":{"properties":{"key":{"title":"Key","type":"string"},"title":{"title":"Title","type":"string"},"unit":{"title":"Unit","type":"string"},"series":{"items":{"$ref":"#/components/schemas/AgentHistorySeries"},"title":"Series","type":"array"},"isDefault":{"description":"True for the chart the app opens first for this agent type.","title":"Isdefault","type":"boolean"},"emptyText":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Shown instead of the chart when it has no points yet.","title":"Emptytext"}},"required":["key","title","unit","series","isDefault"],"title":"AgentHistoryChart","type":"object"},"AgentHistoryPoint":{"properties":{"date":{"format":"date","title":"Date","type":"string"},"value":{"title":"Value","type":"number"}},"required":["date","value"],"title":"AgentHistoryPoint","type":"object"},"AgentHistorySeries":{"properties":{"label":{"title":"Label","type":"string"},"points":{"items":{"$ref":"#/components/schemas/AgentHistoryPoint"},"title":"Points","type":"array"}},"required":["label","points"],"title":"AgentHistorySeries","type":"object"},"AgentWalletMovement":{"properties":{"agentWalletMovementId":{"title":"Agentwalletmovementid","type":"integer"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"},"updatedDate":{"format":"date-time","title":"Updateddate","type":"string"},"chainId":{"title":"Chainid","type":"integer"},"agentWalletId":{"title":"Agentwalletid","type":"string"},"blockNumber":{"title":"Blocknumber","type":"integer"},"blockDate":{"format":"date-time","title":"Blockdate","type":"string"},"transactionHash":{"title":"Transactionhash","type":"string"},"logIndex":{"title":"Logindex","type":"integer"},"assetAddress":{"title":"Assetaddress","type":"string"},"assetAmount":{"$ref":"#/components/schemas/BigInt"},"fromAddress":{"title":"Fromaddress","type":"string"},"toAddress":{"title":"Toaddress","type":"string"},"transactionSignerAddress":{"title":"Transactionsigneraddress","type":"string"}},"required":["agentWalletMovementId","createdDate","updatedDate","chainId","agentWalletId","blockNumber","blockDate","transactionHash","logIndex","assetAddress","assetAmount","fromAddress","toAddress","transactionSignerAddress"],"title":"AgentWalletMovement","type":"object"},"DailyYieldSnapshot":{"properties":{"date":{"format":"date","title":"Date","type":"string"},"totalValueBase":{"$ref":"#/components/schemas/BigInt"},"netDepositsBase":{"$ref":"#/components/schemas/BigInt"},"dailyYieldBase":{"$ref":"#/components/schemas/BigInt","description":"Change in cumulativeYieldBase from the previous day, in base-asset units. Yield only when the agent isYieldProduct; see cumulativeYieldBase."},"cumulativeYieldBase":{"$ref":"#/components/schemas/BigInt","description":"Total value minus net deposits, in base-asset units. For agent types where isYieldProduct is true (Vault) this is the yield earned, net of fees already charged and of pending fees on unrealized yield. For other types it is the change in value against deposits and not yield: for Borrow it is mostly loan interest plus the effect of the collateral price on the debt, which is counted in the collateral (base) asset."},"baseAssetPriceUsd":{"title":"Baseassetpriceusd","type":"number"},"baseAssetDecimals":{"title":"Baseassetdecimals","type":"integer"}},"required":["date","totalValueBase","netDepositsBase","dailyYieldBase","cumulativeYieldBase","baseAssetPriceUsd","baseAssetDecimals"],"title":"DailyYieldSnapshot","type":"object"},"WalletHistoricPosition":{"properties":{"assets":{"items":{"$ref":"#/components/schemas/Asset"},"title":"Assets","type":"array"},"movements":{"items":{"$ref":"#/components/schemas/AgentWalletMovement"},"title":"Movements","type":"array"},"dailyYieldSnapshots":{"items":{"$ref":"#/components/schemas/DailyYieldSnapshot"},"title":"Dailyyieldsnapshots","type":"array"},"charts":{"items":{"$ref":"#/components/schemas/AgentHistoryChart"},"title":"Charts","type":"array"}},"required":["assets","movements","dailyYieldSnapshots","charts"],"title":"WalletHistoricPosition","type":"object"},"GetAgentWalletHistoricPositionResponse":{"properties":{"position":{"$ref":"#/components/schemas/WalletHistoricPosition"}},"required":["position"],"title":"GetAgentWalletHistoricPositionResponse","type":"object"},"DeactivateAgentResponse":{"properties":{},"title":"DeactivateAgentResponse","type":"object"},"ReactivateAgentResponse":{"properties":{"agent":{"$ref":"#/components/schemas/Agent"}},"required":["agent"],"title":"ReactivateAgentResponse","type":"object"},"DepositMadeToUserAgentResponse":{"properties":{},"title":"DepositMadeToUserAgentResponse","type":"object"},"GetVaultOptionsResponse":{"properties":{"vaultOptions":{"items":{"$ref":"#/components/schemas/VaultOption"},"title":"Vaultoptions","type":"array"}},"required":["vaultOptions"],"title":"GetVaultOptionsResponse","type":"object"},"GetYieldOptionsResponse":{"properties":{"yieldOptions":{"items":{"$ref":"#/components/schemas/VaultOption"},"title":"Yieldoptions","type":"array"}},"required":["yieldOptions"],"title":"GetYieldOptionsResponse","type":"object"},"ChatMessage":{"properties":{"content":{"title":"Content","type":"string"},"isUser":{"title":"Isuser","type":"boolean"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"}},"required":["content","isUser","createdDate"],"title":"ChatMessage","type":"object"},"AddUserMessageResponse":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/ChatMessage"},"title":"Messages","type":"array"}},"required":["messages"],"title":"AddUserMessageResponse","type":"object"},"ChatStreamEvent":{"properties":{"type":{"title":"Type","type":"string"},"toolName":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Toolname"},"toolLabel":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Toollabel"},"message":{"anyOf":[{"$ref":"#/components/schemas/ChatMessage"},{"type":"null"}],"default":null}},"required":["type"],"title":"ChatStreamEvent","type":"object"},"AddUserMessageStreamedResponse":{"properties":{"event":{"$ref":"#/components/schemas/ChatStreamEvent"}},"required":["event"],"title":"AddUserMessageStreamedResponse","type":"object"},"GetChatHistoryResponse":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/ChatMessage"},"title":"Messages","type":"array"}},"required":["messages"],"title":"GetChatHistoryResponse","type":"object"},"AgentAction":{"properties":{"agentActionId":{"title":"Agentactionid","type":"integer"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"},"updatedDate":{"format":"date-time","title":"Updateddate","type":"string"},"agentId":{"title":"Agentid","type":"string"},"actionType":{"title":"Actiontype","type":"string"},"value":{"title":"Value","type":"string"},"valueId":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Valueid"},"details":{"anyOf":[{"$ref":"#/components/schemas/JsonObject"},{"type":"null"}],"default":null},"title":{"title":"Title","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"required":["agentActionId","createdDate","updatedDate","agentId","actionType","value","title","description"],"title":"AgentAction","type":"object"},"Json":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Json"},"type":"object"},{"items":{"$ref":"#/components/schemas/Json"},"type":"array"},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"JsonObject":{"additionalProperties":{"$ref":"#/components/schemas/Json"},"type":"object"},"GetAgentActionsResponse":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/AgentAction"},"title":"Actions","type":"array"},"hasMore":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Whether another page is available.","title":"Hasmore"},"nextCursorCreatedDate":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"description":"createdDate cursor for the next page.","title":"Nextcursorcreateddate"},"nextCursorAgentActionId":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"agentActionId cursor for the next page.","title":"Nextcursoragentactionid"}},"required":["actions"],"title":"GetAgentActionsResponse","type":"object"},"AgentMemory":{"properties":{"agentMemoryId":{"title":"Agentmemoryid","type":"integer"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"},"updatedDate":{"format":"date-time","title":"Updateddate","type":"string"},"agentId":{"title":"Agentid","type":"string"},"content":{"title":"Content","type":"string"},"source":{"title":"Source","type":"string"},"isActive":{"title":"Isactive","type":"boolean"},"classification":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Classification"},"hasUnmappedRuleSuggestion":{"default":false,"title":"Hasunmappedrulesuggestion","type":"boolean"},"unmappedRuleDescription":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Unmappedruledescription"},"isDeleted":{"default":false,"title":"Isdeleted","type":"boolean"},"managedRuleType":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"The rule type (such as borrow_amount or ignored_vault) of a memory the app or an integrator writes for a setting. It can be edited; only an ignored_vault memory can also be deactivated or deleted.","title":"Managedruletype"},"contributingRules":{"items":{"$ref":"#/components/schemas/AgentRule"},"title":"Contributingrules","type":"array"}},"required":["agentMemoryId","createdDate","updatedDate","agentId","content","source","isActive"],"title":"AgentMemory","type":"object"},"AgentRule":{"properties":{"agentRuleId":{"title":"Agentruleid","type":"integer"},"createdDate":{"format":"date-time","title":"Createddate","type":"string"},"updatedDate":{"format":"date-time","title":"Updateddate","type":"string"},"agentId":{"title":"Agentid","type":"string"},"ruleType":{"title":"Ruletype","type":"string"},"ruleConfig":{"$ref":"#/components/schemas/JsonObject"},"contributingMemoryIds":{"items":{"type":"integer"},"title":"Contributingmemoryids","type":"array"}},"required":["agentRuleId","createdDate","updatedDate","agentId","ruleType","ruleConfig"],"title":"AgentRule","type":"object"},"GetAgentMemoriesResponse":{"properties":{"memories":{"items":{"$ref":"#/components/schemas/AgentMemory"},"title":"Memories","type":"array"}},"required":["memories"],"title":"GetAgentMemoriesResponse","type":"object"},"GetAgentEffectiveRulesResponse":{"properties":{"userRules":{"items":{"$ref":"#/components/schemas/AgentRule"},"title":"Userrules","type":"array"},"defaultRules":{"items":{"$ref":"#/components/schemas/AgentRule"},"title":"Defaultrules","type":"array"}},"required":["userRules","defaultRules"],"title":"GetAgentEffectiveRulesResponse","type":"object"},"AgentBorrowLimits":{"properties":{"debt":{"$ref":"#/components/schemas/AgentAmount","description":"What the agent owes now."},"borrowAmount":{"anyOf":[{"$ref":"#/components/schemas/AgentAmount"},{"type":"null"}],"description":"How much the agent is set to borrow (its borrow amount memory), in the borrowed asset at the current price; null means as much as its safety rules allow."},"maxDebt":{"$ref":"#/components/schemas/AgentAmount","description":"The most the agent could owe at its target health factor, including idle collateral it would supply. Reported even when it cannot borrow right now; see problem."},"freeCollateral":{"$ref":"#/components/schemas/AgentAmount","description":"Collateral the user can close out of the position without repaying any of the loan: down to the warning health factor, or none when the position is already below it."},"riskResponse":{"description":"What the agent does when the loan gets risky (its risk response memory): deleverage sells collateral to stay safe, repay_only only repays with cash in the agent wallet, alert_only only notifies.","title":"Riskresponse","type":"string"},"problem":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why the agent cannot borrow more right now, if it cannot.","title":"Problem"}},"required":["debt","borrowAmount","maxDebt","freeCollateral","riskResponse","problem"],"title":"AgentBorrowLimits","type":"object"},"GetAgentBorrowLimitsResponse":{"properties":{"borrowLimits":{"$ref":"#/components/schemas/AgentBorrowLimits"}},"required":["borrowLimits"],"title":"GetAgentBorrowLimitsResponse","type":"object"},"CreateAgentMemoryResponse":{"properties":{"memory":{"$ref":"#/components/schemas/AgentMemory"}},"required":["memory"],"title":"CreateAgentMemoryResponse","type":"object"},"UpdateAgentMemoryResponse":{"properties":{"memory":{"$ref":"#/components/schemas/AgentMemory"}},"required":["memory"],"title":"UpdateAgentMemoryResponse","type":"object"},"DeleteAgentMemoryResponse":{"properties":{"memoryId":{"title":"Memoryid","type":"integer"}},"required":["memoryId"],"title":"DeleteAgentMemoryResponse","type":"object"},"WithdrawFromPositionResponse":{"properties":{"transactionHash":{"title":"Transactionhash","type":"string"}},"required":["transactionHash"],"title":"WithdrawFromPositionResponse","type":"object"},"Transaction":{"properties":{"from":{"title":"From","type":"string"},"to":{"title":"To","type":"string"},"data":{"title":"Data","type":"string"},"value":{"$ref":"#/components/schemas/BigInt"},"chainId":{"title":"Chainid","type":"integer"}},"required":["from","to","data","value","chainId"],"title":"Transaction","type":"object"},"PrepareDepositResponse":{"properties":{"transaction":{"$ref":"#/components/schemas/Transaction"}},"required":["transaction"],"title":"PrepareDepositResponse","type":"object"},"PrepareWithdrawalResponse":{"properties":{"transaction":{"$ref":"#/components/schemas/Transaction"}},"required":["transaction"],"title":"PrepareWithdrawalResponse","type":"object"},"SimulationDerivedRule":{"properties":{"ruleType":{"title":"Ruletype","type":"string"},"ruleConfig":{"$ref":"#/components/schemas/JsonObject"},"isDefault":{"title":"Isdefault","type":"boolean"}},"required":["ruleType","ruleConfig","isDefault"],"title":"SimulationDerivedRule","type":"object"},"SimulationResult":{"properties":{"derivedRules":{"items":{"$ref":"#/components/schemas/SimulationDerivedRule"},"title":"Derivedrules","type":"array"},"vaultBreakdown":{"items":{"$ref":"#/components/schemas/SimulationVaultBreakdown"},"title":"Vaultbreakdown","type":"array"},"decision":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Decision"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"projectedLines":{"items":{"$ref":"#/components/schemas/AgentBalanceSheetLine"},"title":"Projectedlines","type":"array"},"creditsRemaining":{"title":"Creditsremaining","type":"integer"}},"required":["derivedRules","vaultBreakdown","decision","reason","projectedLines","creditsRemaining"],"title":"SimulationResult","type":"object"},"SimulationVaultBreakdown":{"properties":{"vaultAddress":{"title":"Vaultaddress","type":"string"},"vaultName":{"title":"Vaultname","type":"string"},"selected":{"title":"Selected","type":"boolean"},"targetAllocationBase":{"$ref":"#/components/schemas/BigInt"},"score":{"title":"Score","type":"number"},"rank":{"title":"Rank","type":"integer"},"appliedRules":{"items":{"$ref":"#/components/schemas/JsonObject"},"title":"Appliedrules","type":"array"}},"required":["vaultAddress","vaultName","selected","targetAllocationBase","score","rank"],"title":"SimulationVaultBreakdown","type":"object"},"RunAgentSimulationResponse":{"properties":{"simulation":{"$ref":"#/components/schemas/SimulationResult"}},"required":["simulation"],"title":"RunAgentSimulationResponse","type":"object"},"SimulationCreditsStatus":{"properties":{"creditsRemaining":{"title":"Creditsremaining","type":"integer"},"dailyLimit":{"title":"Dailylimit","type":"integer"},"dateUtc":{"title":"Dateutc","type":"string"}},"required":["creditsRemaining","dailyLimit","dateUtc"],"title":"SimulationCreditsStatus","type":"object"},"GetSimulationCreditsStatusResponse":{"properties":{"simulationCreditsStatus":{"$ref":"#/components/schemas/SimulationCreditsStatus"}},"required":["simulationCreditsStatus"],"title":"GetSimulationCreditsStatusResponse","type":"object"},"RenderShareCardsResponse":{"properties":{"urls":{"items":{"type":"string"},"title":"Urls","type":"array"}},"required":["urls"],"title":"RenderShareCardsResponse","type":"object"},"RenderShareCardDetail":{"properties":{"label":{"maxLength":100,"title":"Label","type":"string"},"value":{"maxLength":100,"title":"Value","type":"string"}},"required":["label","value"],"title":"RenderShareCardDetail","type":"object"},"RenderShareCardRequest":{"properties":{"eyebrow":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"title":"Eyebrow"},"bigMetric":{"maxLength":100,"title":"Bigmetric","type":"string"},"bigMetricLabel":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"title":"Bigmetriclabel"},"details":{"items":{"$ref":"#/components/schemas/RenderShareCardDetail"},"maxItems":4,"title":"Details","type":"array"},"accentColor":{"anyOf":[{"pattern":"^#[0-9A-Fa-f]{3,8}$","type":"string"},{"type":"null"}],"default":null,"title":"Accentcolor"},"backgroundColor":{"anyOf":[{"pattern":"^#[0-9A-Fa-f]{3,8}$","type":"string"},{"type":"null"}],"default":null,"title":"Backgroundcolor"}},"required":["bigMetric"],"title":"RenderShareCardRequest","type":"object"}},"securitySchemes":{"IntegratorApiKey":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"Integrator API key. Example: `ysk_...`."},"UserSignature":{"type":"apiKey","in":"header","name":"Authorization","description":"Required user signature. Enter the complete header value: `Signature <signature-token>`."}}}}