OpenWOP SDKs

OpenWOP is the open-source protocol for multi-agent workflow orchestration: run AI agents as workflows you can watch, pause for human approval and replay, on any host that implements it.

This repo holds the official TypeScript, Python, and Go client SDKs, in lockstep with the spec.

openwop.dev · Quickstart

npm install @openwop/openwop@2                   # TypeScript
pip install "openwop-client>=2,<3"                # Python
go get github.com/openwop/openwop-sdks/go/v2      # Go

Carved out of the openwop/openwop spec corpus (full history preserved) so the protocol repo stays a lean spec + conformance contract.

v2 is the current protocol major, and the 2.x packages are the ones a new integration uses. They are v2-ONLY (spec/v2/: bare-origin unversioned paths, OpenWOP-Version negotiation, the closed discovery root, the generated error registry — RFC 0172 / 0171 / 0173, RFC 0168 §D), cover all 68 operations of spec/v2/path-manifest.json at corpus v2.46.38 (CORPUS_TAG). The latest published release is 2.10.0, on corpus v2.46.41.

The 1.x packages target v1 hosts (/v1/…) and are the maintained parallel line through the v1 overlap, until v1 end-of-support (earliest 2026-12-04). Unpinned installs now resolve to 2.x, so a v1 integration must pin the major.

SDK	Install (v2)	Install (v1 line)	2.x path	1.x path	2.x tag form
TypeScript @openwop/openwop	npm install @openwop/openwop@2	npm install @openwop/openwop@1	sdk/typescript-v2/	sdk/typescript/	openwop/v2.Y.Z
Python openwop-client	pip install "openwop-client>=2,<3"	pip install "openwop-client<2"	sdk/python-v2/	sdk/python/	openwop-client/v2.Y.Z
Go	go get github.com/openwop/openwop-sdks/go/v2	go get github.com/openwop/openwop-sdks/go	go/v2/	go/	go/v2.Y.Z

import openwop "github.com/openwop/openwop-sdks/go/v2" // v2 hosts
// import openwop "github.com/openwop/openwop-sdks/go" // the v1 line

Same npm / PyPI names across the two generations; Go's v2 is the major-subdirectory module …/go/v2. A coordinated corpus tag (v1.Y.Z / v2.Y.Z, rc's v2.0.0-rc.N) publishes the three packages of that major; a pre-release tag publishes to npm under dist-tag next and requires a PEP 440 pre-release version on PyPI.

Go import path (from the monorepo era)

Before the SDKs left the spec corpus, the Go module lived at github.com/openwop/openwop/sdk/go. That path is frozen at its last in-corpus tag; the v1 line continues at github.com/openwop/openwop-sdks/go (tags go/v1.Y.Z) and v2 at …/go/v2 (tags go/v2.Y.Z).

Versioning

Per PUBLISHING.md, the three SDKs track the spec major — a spec at v1.x always has SDKs at v1.x; patch versions float independently within the major. A spec minor/major release triggers a coordinated tag here.

Checks

npm run check           # 1.x + 2.x legs: TS build/typecheck + Python + Go + generated-registry --check + parity + release-surface
npm run check:parity    # 1.x: OpenAPI operations <-> typed helpers across the three SDKs
npm run check:parity:v2 # 2.x: spec/v2/path-manifest.json operations <-> one method per SDK (mandatory symbols)
npm run check:vendored  # vendored schemas/api/spec registries match the corpus at CORPUS_TAG

api/openapi.yaml, api/v2/*.yaml, schemas/** and spec/v2/{path-manifest,errors}.json are vendored copies of the canonical spec-corpus files at CORPUS_TAG (source of truth in openwop/openwop); re-vendor from a published tag, never main. sdk/PARITY.md tracks cross-SDK feature parity for both generations.

Note: the SDK ↔ canonical-REST-error-vocabulary consistency test (formerly the describe.skipIf block in the spec corpus's spec-corpus-validity.test.ts, which now auto-skips there since the SDK sources left) should be ported here as a follow-up; the machine-enforced check-sdk-parity.mjs gate above already covers the operation-level surface.

License

Apache-2.0.