RPC API
Integrate with Relet RPC contracts using typed, validated interaction patterns.
Use the RPC API for typed operations between client and server components while maintaining contract safety and validation discipline.
API integration goals
These goals keep API integrations maintainable and safe.
- Request and response contracts stay explicit and validated.
- Authorization requirements are enforced at procedure boundaries.
- Mutations include predictable error handling and recovery semantics.
API usage workflow
Apply this workflow for every new integration path.
Define the required operation and expected output contract.
Validate input constraints before submission.
Handle success and failure outcomes with explicit user feedback.
Verify downstream state consistency after mutation operations.
Contract and runtime controls
Use these controls to avoid API drift.
- Keep contract naming stable and descriptive.
- Keep validation close to procedure boundaries.
- Treat breaking changes as planned migrations.
- Verify authorization outcomes for each role scope.
Error-handling expectations
Use this pattern for reliable operator experience.
Provide corrective guidance and allow safe retry for validation and temporary dependency errors.
Surface clear failure messaging and escalate with full request context.
Next steps
- Align event-based behavior in Webhook callbacks.
- Validate operational impact in Admin monitoring.
- Document recurring issues in Troubleshooting.
Last updated on