Problem / Motivation
The ongoing roadmap mentions official SDKs for Python, TypeScript and Go. As Synapse grows into a plugin and automation platform, external developers and future clients will need stable SDKs instead of directly calling raw REST/WebSocket APIs.
SDKs would also help keep plugins, CLI tooling, frontend integrations and external automations consistent.
Proposed Solution
Create an official SDK strategy covering:
- Python SDK
- TypeScript SDK
- Go SDK
- Versioning rules
- API compatibility policy
- Auth handling
- Streaming/event handling
- Plugin development helpers
- Generated API clients where useful
- Handwritten ergonomic wrappers for common workflows
Possible SDK scopes:
synapse-sdk-python
@synapse/sdk
synapse-go-sdk
Core SDK features:
- Authentication helpers
- Agent API client
- Conversation API client
- Task API client
- Plugin registry/store API client
- Event/WebSocket client
- Error model normalization
- Pagination helpers
- Typed request/response models
Future Ideas
- Generate baseline clients from OpenAPI
- Add higher-level helpers manually
- Provide examples for automation scripts
- Use the SDKs internally for CLI/tests where possible
- Add SDK compatibility tests in CI
Priority
Medium / High
This becomes more important once external users, plugins, and separate clients interact with Synapse.
Problem / Motivation
The ongoing roadmap mentions official SDKs for Python, TypeScript and Go. As Synapse grows into a plugin and automation platform, external developers and future clients will need stable SDKs instead of directly calling raw REST/WebSocket APIs.
SDKs would also help keep plugins, CLI tooling, frontend integrations and external automations consistent.
Proposed Solution
Create an official SDK strategy covering:
Possible SDK scopes:
Core SDK features:
Future Ideas
Priority
Medium / High
This becomes more important once external users, plugins, and separate clients interact with Synapse.