Skip to content
This repository was archived by the owner on Jun 7, 2026. It is now read-only.

docs: add stream-object documentation across all guides - #81

Merged
matthew-petty merged 1 commit into
mainfrom
docs/stream-object-documentation
Dec 27, 2025
Merged

docs: add stream-object documentation across all guides#81
matthew-petty merged 1 commit into
mainfrom
docs/stream-object-documentation

Conversation

@matthew-petty

Copy link
Copy Markdown
Member

Summary

  • Add /stream-object endpoint to API reference with concurrency limits
  • Add "Streaming Structured Output" section to SDK guide with TypeScript/Python examples
  • Update README features to mention streaming structured data
  • Add streamObject/stream_object to SDK READMEs (features, methods, types, examples)
  • Update architecture diagram and project structure to include stream-object
  • Document the prompt injection vs --json-schema implementation strategy

Test plan

  • Verify all markdown links resolve correctly
  • Verify code examples match actual SDK API
  • Check formatting renders correctly on GitHub

- Add /stream-object endpoint to API reference and concurrency limits
- Add "Streaming Structured Output" section to SDK guide with TS/Python examples
- Update README features to mention streaming structured data
- Add streamObject/stream_object to SDK READMEs (features, methods, types)
- Add stream-object examples to examples READMEs
- Update architecture diagram and project structure
- Document prompt injection vs --json-schema implementation strategy
@codecov

codecov Bot commented Dec 27, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@matthew-petty
matthew-petty merged commit 4936e60 into main Dec 27, 2025
3 checks passed
@matthew-petty
matthew-petty deleted the docs/stream-object-documentation branch December 27, 2025 18:25
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant