Skip to content

docs: enhance README with comprehensive API examples#30

Merged
ZhiXiao-Lin merged 1 commit into
mainfrom
docs/enhance-readme-api-examples
May 15, 2026
Merged

docs: enhance README with comprehensive API examples#30
ZhiXiao-Lin merged 1 commit into
mainfrom
docs/enhance-readme-api-examples

Conversation

@ZhiXiao-Lin
Copy link
Copy Markdown
Contributor

Summary

  • Add "Main APIs At A Glance" section showcasing 13 core API groups
  • Include both Python and TypeScript examples side-by-side
  • Cover session config, send/stream, direct tools, delegation, programmatic calling, structured output, runs/replay, verification, HITL, MCP, memory, registries, and persistence
  • Make the full SDK surface discoverable from the README

Test plan

  • Verified all referenced API names exist in Python SDK (sdk/python/src/lib.rs)
  • Verified all referenced API names exist in Node SDK (sdk/node/index.d.ts)
  • Section structure remains consistent with existing README layout

🤖 Generated with Claude Code

Add "Main APIs At A Glance" section showcasing 13 core API groups with both Python and TypeScript examples side-by-side. Covers session config, send/stream, direct tools, delegation, programmatic calling, structured output, runs/replay, verification, HITL, MCP, memory, registries, and persistence. Makes the full SDK surface discoverable upfront.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@ZhiXiao-Lin ZhiXiao-Lin merged commit d18348e into main May 15, 2026
1 check passed
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.

2 participants