Skip to content

Reference

The reference quadrant documents typed surfaces — the wire shape of an HTTP endpoint, the props of a frontend component, the contract of a platform helper package. Pages here are flat and specification-shaped: little prose, lots of tables and code blocks. Read them when you need a precise answer to "what does this surface accept and return".

What is here

When to read this section

  • You are integrating with a /v1 endpoint and need the exact request and response shape.
  • You are calling into one of the platform packages and want to confirm the function signature and error contract.

For the architectural context behind a surface, jump from the reference page back into the relevant bounded context — the cross-references at the bottom of each reference page point to the right place.