API Guide

This section groups endpoint families by responsibility.

Read in order

  1. authentication-and-error-model.md
  2. common-control-plane-api.md
  3. synckhub-platform-api.md
  4. uploads-shared-links-and-coauthoring.md
  5. federation-apis.md

API discipline

  • authenticate first
  • resolve routing context
  • call the right plane (Common vs SynckHub)
  • handle error envelopes deterministically
Previous
Start Here
Next
Architecture and Specs