Skip to content

README: one-liner, privacy line, research-first Usage example - #67

Open
tessak22 wants to merge 3 commits into
mainfrom
messaging-refresh
Open

tessak22 wants to merge 3 commits into
mainfrom
messaging-refresh

Conversation

@tessak22

@tessak22 tessak22 commented Nov 2, 2026 •

Copy link
Copy Markdown
  • Adds the one-liner and the privacy line above the Stainless boilerplate.
  • The first Usage example is now a streaming client.agent.research call.
  • README is human-owned: codegen only touches the generated surface.
  • The snippet passes pyright against the package.

Follow-up worth doing separately: later README sections still assign automate_event = client.agent.automate(...) as if it returned one event.

Streaming fix

client.agent.automate() always streams. The README examples (types, async usage, nested params, errors, retries, timeouts, raw response) now iterate the event stream and read the result from the complete event, checking success and error. Also notes that automate and research default to a 10 minute timeout, and that the raw-response helpers return the event stream for these methods. Examples typechecked against the repo source; the TS error-handling example ran live.

@tessak22
tessak22 requested a review from MrTravisB November 2, 2026 18:59
…te event

Co-Authored-By: Claude <noreply@anthropic.com>
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