Skip to content

docs: let clients implement sessions and payment without the sdk - #50

Draft
rickstaa wants to merge 3 commits into
mainfrom
rs/client-protocol-docs
Draft

rickstaa wants to merge 3 commits into
mainfrom
rs/client-protocol-docs

Conversation

@rickstaa

@rickstaa rickstaa commented Nov 5, 2026

Copy link
Copy Markdown
Member

Documents the client contract so integrators can reserve, pay and stream without the SDK, after the HTTP PUT transcoding discussion with Marco and Thulinma. It adds the client flow, proxy and O2R behavior, orchestrator response codes and tested nginx settings to the existing docs, JSON schemas for the session, challenge, signer and error messages, a first set of conformance tests that use a plain HTTP client, and a PR template that asks about protocol changes. Node behavior does not change.

This demo shows the media path on an unmodified orchestrator: ffmpeg PUTs the source and a GET returns the ABR ladder.

Two things to settle in review: the docs now state that session URLs are the only client credential, so should that stay or should they get a token check, and can clients rely on the signer's 10-second first payment, given that the Python SDK's 3-second interval is only its own choice? The 480 refresh path is documented, but only the pinned SDK test covers it.

rickstaa and others added 3 commits November 5, 2026 14:21
The compat tests go through the SDKs, so they cannot show that the
protocol alone is enough. These use a plain HTTP client, real listeners
and JSON schemas, with only the chain faked.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Routes were listed, but not their order, the payer header, the challenge
body or top-up timing, which could only be found in SDK code.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch was previously deployed

1 inactive deployment
docker-publish — d484976d Deployed Nov 5, 2026 by rickstaa via docker-pr / promote #70
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant