Developer

API Reference

Platform APIs available to custom resources.

API Reference

Custom resources access platform capabilities through typed APIs. Each API requires a capability declared in your resource.json manifest.

Available APIs

APICapabilityDescription
HTTPnetwork:httpOutbound HTTP requests (GET, POST, PUT, DELETE, PATCH) with streaming support
Storagestorage:kvKey-value storage scoped to your resource

Coming Soon

APICapabilityDescription
Filesystemfs:resourceRead/write files in a resource-scoped directory
Databasedatabase:resourcePer-resource SQLite database
WebSocketnetwork:wsPersistent connections to external services
Credentialscredentials:storeSecure storage for API keys and secrets
Hookshooks:provide, hooks:consumeInter-resource communication
Relayrelay:channelReal-time cross-device messaging

Access Model

All APIs are available from both the frontend (iframe) and the optional backend (Node.js). The underlying implementation is the same — requests route through the Tauri native layer.

Frontend (iframe)  →  postMessage  →  Bridge  →  Tauri Command  →  Result
Backend (Node.js)  →  JSON-RPC     →  Handler →  Tauri Command  →  Result