Runtime Service APIs
Reference entry for runtime `services.*` APIs used by flow nodes, hooks, and plugins.
Runtime Service APIs
Binding note. These pages document the stable services.* contract surface
(signatures match the client SDK and packages/spec/src/contracts/). In this
repo's runtime, hook bodies reach the equivalent capabilities through ctx.api
(scoped data operations) and ctx.getService(...) (any registered service) —
a literal services.* object is not injected into hook contexts by the open
framework today. Managed runtimes provide the services.* binding directly.
This chapter documents the runtime services.* APIs used in hook/action/flow/plugin code:
services.dataservices.sharingservices.auditservices.queueservices.emailservices.settingsservices.storage
Stability Legend
| Level | Meaning |
|---|---|
stable | Backward-compatible within a major version |
experimental | API is available but may change in minor releases |
Source of Truth
Each page links the canonical TypeScript source used to derive signatures.
- Data:
packages/client/src/index.ts - Sharing:
packages/spec/src/contracts/sharing-service.ts - Queue:
packages/spec/src/contracts/queue-service.ts - Email:
packages/spec/src/contracts/email-service.ts - SMS:
packages/spec/src/contracts/sms-service.ts - Storage:
packages/spec/src/contracts/storage-service.ts - Settings:
packages/services/service-settings/src/settings-service.ts - Audit bridge:
packages/services/service-settings/src/settings-service.types.ts