Skip to content

Worker API Reference

Rafiki exposes two complementary API documentation surfaces after deployment:

  • API Usage Guide for the canonical public routes, payloads, and behavior
  • generated Worker API HTML for low-level details from the public Worker module

Read This First

Start with the Getting Started deployment flow, then use the API Usage Guide for the main API reference. Use the generated HTML only when you need module-level details from contracts/public-api.

Generated Worker API HTML