Skip to main content

APIs and SDKs

Introduction​

Neosync, like many web services these days, is a full-fledged API. Check out the architecture page for an overview of how the Neosync API fits into the picture.

All of our APIs are generated from Protobuf files. For this reason, a client can easily be generated in any of the many supported languages. Internally, we make great use of the Go SDK as well as the TypeScript SDK.

Clients​

Go​

The Go SDK that is committed to the Neosync repo may be freely imported and utilized. See the Go SDK page for more information on how to use the SDK.

All of the generated code lives here.

TypeScript​

The TypeScript SDK is published to the npm registry. It is generated from Neosync protos and is used by the Neosync App. See the TS SDK page for more information on how to use the SDK.

All of the generated code lives here.

Protos​

All of Neosync's protos are public and can be found here. A new SDK can be easily generated by augmenting the buf.gen.yaml file, or providing a separate one when running the buf cli to generate a different SDK for other purposes.