Docs

Day-1 platform invariants every API consumer needs to know, plus links to every developer surface FastYoke ships.

Developers

If you're calling the FastYoke API or building on top of the platform, start here. The four pages below are the day-1 platform invariants every API consumer needs to know; the link clusters underneath route you to whichever developer surface you came for.

Day-1 invariants

  • Error envelope — what every 4xx and 5xx response looks like, and what each status code means in FastYoke specifically.
  • Tenant scoping — how the platform enforces multi-tenancy and what your code does (and doesn't) send.
  • Idempotency — making safe retries on the endpoints that support Idempotency-Key.
  • Rate limits — what the platform throttles, the 429 response shape, and recommended client behaviour.

Building on the platform

  • SDK — typed client for JavaScript / TypeScript.
  • CLIfastyoke command-line operations.
  • Extensions — ship your own React UI mounted inside the admin shell.
  • Integrations — inbound webhooks and outbound webhook subscriptions.
  • LCAP — low-code app platform primitives (annotations, field types, formatting).
  • Primitives — server-side compute building blocks (aggregator, scheduler, pdf-generator, and more).
  • Recipes — end-to-end how-to guides.

Per-feature API references

Feature-specific API documentation lives next to the admin pages those features ship with:

If this is your first time, the ten-minute first-integration tutorial is the fastest way to confirm the contract works end-to-end against your tenant.