Developer Guide

This section is for engineers integrating with SynckHub and Common.

It is contract-first: use specs and stable endpoint families, not reverse-engineered behavior or UI scraping.

Open the complete SynckHub server API reference to inspect endpoints, schemas, and example requests, or download the OpenAPI 3.1 JSON for tooling and client generation.

Start with uploading files and saving revisions for the document-filing workflows.

What this section covers

• architecture boundaries and local dev flow
• auth and error model
• repo API tokens and the machine-to-machine Repository Integration API
• Common control-plane API families
• SynckHub platform API families
• uploads, shared links, and coauthoring endpoints
• federation API surfaces
• public share infra routing with a version-controlled frontend map
• current product areas that matter to integrators: routing, authz, audit, connected accounts, folder-backed entities, and structured workflows

Recommended reading path

1. start-here/architecture-and-specs.md
2. start-here/local-development.md
3. api/authentication-and-error-model.md
4. api/repository-integration-api.md
5. api/common-control-plane-api.md
6. api/synckhub-platform-api.md
7. api/uploads-shared-links-and-coauthoring.md
8. api/federation-apis.md
9. guides/public-share-infra-routing.md

Working stance

Use the public docs here to orient yourself, then go to the authoritative contracts:

• synckhub/docs/platform/*.md
• common-control-plane/docs/openapi/v1.yaml
• synckhub/docs/openapi/integration-v1.json
• synckhub/docs/openapi/ai-v1.json where applicable

The platform is broad now. The only sane integration strategy is to respect service boundaries.