REFERENCE · API
API
A hosted HTTP API is part of the runtime, not the protocol. v0.1.0 does not ship one. This page records what we plan once an HTTP surface is on the menu.
Status
We will add a thin HTTP surface alongside the runtime, when the runtime ships. Until then, every read in this docs site is a viem call into a Base RPC endpoint, and every write is a transaction you submit from your own wallet. There is nothing in the middle to authenticate against.
What you can use today
Use Base RPC directly. The contracts speak normal ABI, and the ABI fragments are linked under Contracts. Both the web app and the CLI use viem; there is nothing exclusive about the API shape.
- Read state with
readContractagainst any Base RPC of your choice. - Subscribe to events listed under Events through your indexer of choice (Envio, Goldsky, Ponder, your own node).
- Submit transactions from a wallet for owner-side mutations (mint, revoke, summon, deposit, withdraw).
- Sign Cast intents off-chain with the ephemeral session key, then submit the resulting
cast(...)from any wallet that holds gas.
Planned shape
When the runtime arrives, the HTTP surface is likely to focus on three things: cadence (a hosted watcher for users who do not want to run cron), notifications (per-cast pre-trade plan, on-chain receipt, halt events), and read-side conveniences (indexed history per agent). Auth will be wallet-signed bearer tokens with short expiry, not long-lived API keys.
This page will fill in once that work begins. Until then, the source of truth is the contracts.