# HelloNear

> Documentation for HelloNear: AI agents on NEAR whose money rules sit outside the model.

- [Introduction](https://docs.hellonear.xyz/index.md): HelloNear gives a person a Mind, an AI agent with a persona, memory, skills and its own NEAR wallet, whose money rules sit outside the model.
- [Quickstart](https://docs.hellonear.xyz/quickstart.md): Try HelloNear in the web app as a guest, or drive it with curl through the public API.
- [How it works](https://docs.hellonear.xyz/how-it-works.md): The parts of HelloNear and how one payment goes from a chat message to a NEAR transaction.
- [Tech stack](https://docs.hellonear.xyz/tech-stack.md): What is used where: NEAR, NEAR AI Cloud, NEAR Intents, OutLayer, Mastra and the rest.
- [Minds and templates](https://docs.hellonear.xyz/minds.md): What a Mind is, the three templates it starts from, and what the owner can change afterwards.
- [Skills and tools](https://docs.hellonear.xyz/skills.md): How skills grant tools, why a Mind without a payment skill cannot pay, and where every skill and tool is listed.
- [Wallet, limits and approvals](https://docs.hellonear.xyz/wallet-and-approvals.md): The layers that keep a Mind from paying what the owner did not allow: approval, the wallet policy in a TEE, the daily limit and Freeze.
- [Verified replies](https://docs.hellonear.xyz/verified-replies.md): How every reply is checked against NEAR AI Cloud's TEE attestation, what the badge levels mean, and how to open the proof on Phala's TEE Explorer.
- [Privacy: what is kept](https://docs.hellonear.xyz/privacy.md): What the TEE protects, what HelloNear stores, what is never stored, and how the owner deletes it.
- [Autopilot and Builder](https://docs.hellonear.xyz/autopilot.md): The visual Builder for jobs a Mind runs, Autopilot schedules, and why unattended jobs get no payment tools.
- [Telegram](https://docs.hellonear.xyz/telegram.md): Chat with a Mind from Telegram, with streamed replies and Approve or Decline buttons, answered only in the owner's chat.
- [Connections and keys](https://docs.hellonear.xyz/connections.md): How a Mind uses your apps through Composio, and how API keys are stored so the model never sees them.
- [The agent](https://docs.hellonear.xyz/agent.md): How each Mind runs on Mastra and NEAR AI Cloud: design, every tool, every skill, and how it is tested.
- [The six tracks](https://docs.hellonear.xyz/tracks.md): What HelloNear built for each NEAR HACKATHON track, the skills that carry it, and how to check it.
- [Haggling with a seller](https://docs.hellonear.xyz/haggling.md): How a Mind makes one offer below a seller's price, within the owner's budget, then buys at the agreed price or walks away.
- [Hire on Agent Market](https://docs.hellonear.xyz/agent-market.md): How a Mind searches the NEAR AI Agent Market, gets each agent's price for a job and recommends the cheapest within budget, without hiring.
- [Contract check before paying](https://docs.hellonear.xyz/contract-check.md): How the Recipient guard skill warns before a plain transfer to a smart contract and asks the owner instead of showing an approval card.
- [Payments CSV](https://docs.hellonear.xyz/payments-csv.md): A file of every payment a Mind made or tried, with who approved it and the transaction link, that an accountant can open without asking.
- [Gas relayer (NEP-366)](https://docs.hellonear.xyz/relayer.md): A meta-transaction relayer that pays the gas for an owner's calls to the registry contract, never a deposit.
- [Swarm auction](https://docs.hellonear.xyz/swarm-auction.md): A sealed-bid group-buying auction contract on NEAR testnet where buyer agents pool demand and seller agents compete at one clearing price.
- [API reference](https://docs.hellonear.xyz/api-reference.md): How the HelloNear backend API is described: the OpenAPI spec, the server, auth, errors and streams. Every route is in the Endpoints tab.
- [API overview](https://docs.hellonear.xyz/api.md): How the public HTTP API works, every route, and where the OpenAPI spec lives.
- [Streaming events](https://docs.hellonear.xyz/events.md): The server-sent events every chat, approval, workflow and attack run streams, in order.
- [Errors](https://docs.hellonear.xyz/errors.md): The shape of every error the HelloNear API returns, what each status means, and the codes you are most likely to meet.
- [Status](https://docs.hellonear.xyz/status.md): Where to see whether HelloNear and its providers are up, and the contract of the public GET /v1/status endpoint.
- [Receipts and smart contracts](https://docs.hellonear.xyz/contracts.md): Every on-chain claim with its transaction: payments, policies, the verified registry contract and the swarm auction round.
- [Run locally](https://docs.hellonear.xyz/run-locally.md): Run the engine, backend and web app on your own machine.
- [Connectors](https://docs.hellonear.xyz/connectors.md): The apps and services a Mind can use, and what each one is for.
- [Hackathon phase and roadmap](https://docs.hellonear.xyz/hackathon-phase.md): What runs on NEAR testnet during the hackathon, what becomes real on mainnet, and the roadmap.
- [Health of the backend and the engine](https://docs.hellonear.xyz/api-reference/system/health-of-the-backend-and-the-engine.md)
- [Status page data: HelloNear and every service it depends on, checked every 5 minutes](https://docs.hellonear.xyz/api-reference/system/status-page-data:-hellonear-and-every-service-it-depends-on-checked-every-5-minutes.md): Public, any origin, no cookies (`access-control-allow-origin: *`, `cache-control: public, max-age=30`). Read by status.hellonear.xyz. See docs/api-contract.md §7.
- [Get a NEP-413 sign-in message and a one-time nonce](https://docs.hellonear.xyz/api-reference/auth/get-a-nep-413-sign-in-message-and-a-one-time-nonce.md)
- [Sign in with a NEAR wallet signature (NEP-413)](https://docs.hellonear.xyz/api-reference/auth/sign-in-with-a-near-wallet-signature-nep-413.md)
- [Start a try-out (guest) session: no wallet, 20 messages](https://docs.hellonear.xyz/api-reference/auth/start-a-try-out-guest-session:-no-wallet-20-messages.md)
- [Sign out](https://docs.hellonear.xyz/api-reference/auth/sign-out.md)
- [The signed-in user](https://docs.hellonear.xyz/api-reference/auth/the-signed-in-user.md)
- [Mind templates](https://docs.hellonear.xyz/api-reference/catalog/mind-templates.md)
- [Every skill a Mind can equip, with its tools](https://docs.hellonear.xyz/api-reference/catalog/every-skill-a-mind-can-equip-with-its-tools.md)
- [One skill with its playbook (SKILL.md body)](https://docs.hellonear.xyz/api-reference/catalog/one-skill-with-its-playbook-skillmd-body.md)
- [The user's Minds, newest first](https://docs.hellonear.xyz/api-reference/minds/the-users-minds-newest-first.md)
- [Create a Mind from a template](https://docs.hellonear.xyz/api-reference/minds/create-a-mind-from-a-template.md)
- [One Mind](https://docs.hellonear.xyz/api-reference/minds/one-mind.md)
- [Delete a Mind (and its workflows, schedules and wallet key)](https://docs.hellonear.xyz/api-reference/minds/delete-a-mind-and-its-workflows-schedules-and-wallet-key.md)
- [Change a Mind: name, voice, model, skills, memory switches, auto-approve rules](https://docs.hellonear.xyz/api-reference/minds/change-a-mind:-name-voice-model-skills-memory-switches-auto-approve-rules.md)
- [Send a message; the reply streams as server-sent events](https://docs.hellonear.xyz/api-reference/chat/send-a-message;-the-reply-streams-as-server-sent-events.md)
- [Chat threads, newest first](https://docs.hellonear.xyz/api-reference/chat/chat-threads-newest-first.md)
- [A thread's messages, oldest first, paged by `before`](https://docs.hellonear.xyz/api-reference/chat/a-threads-messages-oldest-first-paged-by-`before`.md)
- [Delete a thread for good (the engine forgets it too)](https://docs.hellonear.xyz/api-reference/chat/delete-a-thread-for-good-the-engine-forgets-it-too.md)
- [Rename a thread](https://docs.hellonear.xyz/api-reference/chat/rename-a-thread.md)
- [Runs of a Mind, with tokens and cost](https://docs.hellonear.xyz/api-reference/runs/runs-of-a-mind-with-tokens-and-cost.md)
- [One run with all its stored events](https://docs.hellonear.xyz/api-reference/runs/one-run-with-all-its-stored-events.md)
- [Stop a run that is still streaming](https://docs.hellonear.xyz/api-reference/runs/stop-a-run-that-is-still-streaming.md)
- [Events across runs since a time (Mind Graph history)](https://docs.hellonear.xyz/api-reference/runs/events-across-runs-since-a-time-mind-graph-history.md)
- [The proof behind a reply's Verified badge](https://docs.hellonear.xyz/api-reference/verification/the-proof-behind-a-replys-verified-badge.md)
- [Upload the run's Intel quote to Phala's TEE Explorer and get the verified report](https://docs.hellonear.xyz/api-reference/verification/upload-the-runs-intel-quote-to-phalas-tee-explorer-and-get-the-verified-report.md)
- [Runs waiting for the owner's approval](https://docs.hellonear.xyz/api-reference/approvals/runs-waiting-for-the-owners-approval.md)
- [Approve a waiting tool call; the run resumes as SSE](https://docs.hellonear.xyz/api-reference/approvals/approve-a-waiting-tool-call;-the-run-resumes-as-sse.md)
- [Decline a waiting tool call; the run resumes as SSE](https://docs.hellonear.xyz/api-reference/approvals/decline-a-waiting-tool-call;-the-run-resumes-as-sse.md)
- [Balance, spent today, frozen, and the policy](https://docs.hellonear.xyz/api-reference/wallet/balance-spent-today-frozen-and-the-policy.md)
- [Create the Mind's OutLayer wallet (testnet)](https://docs.hellonear.xyz/api-reference/wallet/create-the-minds-outlayer-wallet-testnet.md)
- [Payment receipts, refused ones included](https://docs.hellonear.xyz/api-reference/wallet/payment-receipts-refused-ones-included.md)
- [Every payment as a CSV an accountant can open](https://docs.hellonear.xyz/api-reference/wallet/every-payment-as-a-csv-an-accountant-can-open.md)
- [Build a store_wallet_policy transaction for the owner to sign](https://docs.hellonear.xyz/api-reference/wallet/build-a-store_wallet_policy-transaction-for-the-owner-to-sign.md)
- [Build a freeze_wallet transaction for the owner to sign](https://docs.hellonear.xyz/api-reference/wallet/build-a-freeze_wallet-transaction-for-the-owner-to-sign.md)
- [Build an unfreeze_wallet transaction for the owner to sign](https://docs.hellonear.xyz/api-reference/wallet/build-an-unfreeze_wallet-transaction-for-the-owner-to-sign.md)
- [Meta-transaction relayer: HelloNear pays the gas for an owner's signed registry call (NEP-366)](https://docs.hellonear.xyz/api-reference/wallet/meta-transaction-relayer:-hellonear-pays-the-gas-for-an-owners-signed-registry-call-nep-366.md): The owner signs a delegate action in their own NEAR wallet; the relayer wraps it in a transaction and pays the gas. Only for `REGISTRY_CONTRACT_ID`, only `unequip_skill` and `set_wallet` with exactly 1 yoctoNEAR (the relayer would pay any deposit), at most 4 calls of at most 30 Tgas, a full-access k…
- [What the Mind remembers about the owner](https://docs.hellonear.xyz/api-reference/memory/what-the-mind-remembers-about-the-owner.md)
- [Replace the Mind's memory](https://docs.hellonear.xyz/api-reference/memory/replace-the-minds-memory.md)
- [Clear the Mind's memory](https://docs.hellonear.xyz/api-reference/memory/clear-the-minds-memory.md)
- [The Mind's own email address, if any](https://docs.hellonear.xyz/api-reference/email/the-minds-own-email-address-if-any.md)
- [Create the Mind's own email address (AgentMail)](https://docs.hellonear.xyz/api-reference/email/create-the-minds-own-email-address-agentmail.md)
- [Emails the Mind sent, refusals included](https://docs.hellonear.xyz/api-reference/email/emails-the-mind-sent-refusals-included.md)
- [Saved Builder workflows](https://docs.hellonear.xyz/api-reference/autopilot/saved-builder-workflows.md)
- [One workflow with its canvas](https://docs.hellonear.xyz/api-reference/autopilot/one-workflow-with-its-canvas.md)
- [Save a Builder canvas (compiled to a Mastra workflow)](https://docs.hellonear.xyz/api-reference/autopilot/save-a-builder-canvas-compiled-to-a-mastra-workflow.md)
- [Delete a workflow and its schedule](https://docs.hellonear.xyz/api-reference/autopilot/delete-a-workflow-and-its-schedule.md)
- [Past runs of a workflow, newest first, with each step](https://docs.hellonear.xyz/api-reference/autopilot/past-runs-of-a-workflow-newest-first-with-each-step.md)
- [Run a workflow now; steps stream as SSE](https://docs.hellonear.xyz/api-reference/autopilot/run-a-workflow-now;-steps-stream-as-sse.md)
- [The schedule's state](https://docs.hellonear.xyz/api-reference/autopilot/the-schedules-state.md)
- [Turn the schedule on (wallet sign-in only)](https://docs.hellonear.xyz/api-reference/autopilot/turn-the-schedule-on-wallet-sign-in-only.md)
- [Turn the schedule off](https://docs.hellonear.xyz/api-reference/autopilot/turn-the-schedule-off.md)
- [Apps the user connected through Composio](https://docs.hellonear.xyz/api-reference/connections/apps-the-user-connected-through-composio.md)
- [Get a Composio Connect Link for an app](https://docs.hellonear.xyz/api-reference/connections/get-a-composio-connect-link-for-an-app.md)
- [Disconnect an app](https://docs.hellonear.xyz/api-reference/connections/disconnect-an-app.md)
- [The Mind's Telegram bot, if connected](https://docs.hellonear.xyz/api-reference/telegram/the-minds-telegram-bot-if-connected.md)
- [Connect a BotFather token to the Mind](https://docs.hellonear.xyz/api-reference/telegram/connect-a-botfather-token-to-the-mind.md)
- [Disconnect the bot](https://docs.hellonear.xyz/api-reference/telegram/disconnect-the-bot.md)
- [Saved API keys (names and hosts, never values)](https://docs.hellonear.xyz/api-reference/secrets/saved-api-keys-names-and-hosts-never-values.md)
- [Save an API key for the Mind's HTTP request skill](https://docs.hellonear.xyz/api-reference/secrets/save-an-api-key-for-the-minds-http-request-skill.md)
- [Delete a saved key](https://docs.hellonear.xyz/api-reference/secrets/delete-a-saved-key.md)
- [The prompt-injection scenarios](https://docs.hellonear.xyz/api-reference/attack-playground/the-prompt-injection-scenarios.md)
- [Run a scenario on a hidden test Mind; ends with attack.verdict](https://docs.hellonear.xyz/api-reference/attack-playground/run-a-scenario-on-a-hidden-test-mind;-ends-with-attackverdict.md)

## OpenAPI Specs

- [openapi](https://raw.githubusercontent.com/Hellonear-AI/hellonear/main/docs/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.