Skip to content

Add Streaming Events documentation (follow-up to #205) #217

@vrtnis

Description

@vrtnis

Following up on #205, which fixed agent_updated_stream_event to correctly emit the new agent after a handoff.

The current Streaming guide explains how to consume streams, but doesn’t document what the actual event types look like. There’s no reference for:

  • raw_model_stream_event
  • run_item_stream_event
  • agent_updated_stream_event

The Python SDK already documents such events in detail (with field definitions and usage examples). It would be great to bring the JS docs up to parity. This has also been requested in #202 which #205 resolved.


Proposal

Update streaming.mdx with:

  • A brief overview of the event system
  • Descriptions of each event type and their payload structure
  • JSON examples for common scenarios like handoffs and tool use
  • A link from the main Streaming guide

I'm opening this issue ahead of the docs PR to provide visibility and context for reviewers.

Will follow up shortly with a PR to implement this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions