Skip to content

Document released SDK 0.6.0 methods and migration #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DrAlexHarrison merged 2 commits into from
Sep 19, 2026
Merged

Document released SDK 0.6.0 methods and migration #42

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ccacd6
Document released SDK 0.6.0 methods and migration
DrAlexHarrison Sep 19, 2026
ce0ff21
Integrate current documentation into SDK release quickstart
DrAlexHarrison Sep 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,11 @@ Saturday publishes SDKs for Python and TypeScript:
<CodeGroup>

```bash Python
pip install saturday
pip install 'saturday>=0.6.0'
```

```bash TypeScript
npm install @saturdayinc/sdk
npm install '@saturdayinc/sdk@^0.6.0'
```

</CodeGroup>
Expand Down Expand Up @@ -148,7 +148,9 @@ console.log(result);

Both SDKs default to `https://api.saturday.fit` and accept a base URL override (`base_url` in Python, `baseUrl` in TypeScript) for sandbox work.

The SDKs cover the calculation methods shown here. For activity prescriptions and AI streaming, call the HTTP endpoints directly.
SDK 0.6.0 aligns prescription, batch, import, pagination, and athlete-settings types with the API while preserving raw response objects. Activity calculations return a tiered envelope; stored-prescription reads return `{prescription, safety}`, not the flat nutrition response above. Safety warnings may be `null`. Existing typed callers should read the migration notes in the [TypeScript SDK](https://github.com/SaturdayInc/saturday-node#readme) or [Python SDK](https://github.com/SaturdayInc/saturday-python#readme).

AI coaching remains [feature-gated](/guides/feature-gates). With `ai_coach` access, use `ai.createConversationStream` / `ai.sendMessageStream` in TypeScript, or the async context-managed `ai.create_conversation_stream` / `ai.send_message_stream` methods in Python. Consume all events, including safety warnings and errors. These writes are never automatically replayed, and a partial stream is not a complete answer. Legacy AI JSON-write methods fail locally with migration guidance; conversation metadata/history reads remain JSON. The SDK READMEs include executable stream examples and cancellation guidance.

## 3. Read the response

Expand Down
Loading