Skip to content

Official SDK Strategy for Python, TypeScript and Go #39

@FTMahringer

Description

@FTMahringer

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestfuture ideaIdea for a future feature, not planned yet

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions