From 2181dbdbd4e705e8d42107bad131cf89bb9acd1b Mon Sep 17 00:00:00 2001 From: Jascha Wanger Date: Wed, 1 Jul 2026 13:27:36 -0700 Subject: [PATCH] docs: add runtime compatibility note to README Document which Symbiont runtime versions this SDK targets, since the SDK (1.14.x) trails the current runtime (1.16.x). Adds a small compatibility table and guidance to pin the SDK minor to the runtime minor. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 7619f69..6439d5b 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,19 @@ for agent_id in client.list_agents(): --- +## Compatibility + +The SDK talks to the runtime over its versioned REST API (`/api/v1`). + +| SDK (`symbiont-sdk`) | Symbiont runtime | +|----------------------|------------------| +| 1.14.x | 1.14.x (tested); compatible with 1.15.x / 1.16.x for the documented surface | + +Pin the SDK's minor version to your runtime's minor version when you can; newer +1.x runtimes remain compatible for the endpoints documented here. + +--- + ## Capabilities The main `Client` exposes runtime functionality directly and through namespaced sub-clients.