Skip to content

Add replay to docs#1643

Merged
monadoid merged 2 commits intomainfrom
add_replay_to_docs
Jan 30, 2026
Merged

Add replay to docs#1643
monadoid merged 2 commits intomainfrom
add_replay_to_docs

Conversation

@monadoid
Copy link
Contributor

@monadoid monadoid commented Jan 30, 2026

why

Was missing in mintlify docs

what changed

test plan


Summary by cubic

Added the GET /v1/sessions/{id}/replay endpoint to the API docs so users can fetch session replays.

Written for commit 193b983. Summary will update on new commits. Review in cubic

@changeset-bot
Copy link

changeset-bot bot commented Jan 30, 2026

🦋 Changeset detected

Latest commit: 193b983

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@browserbasehq/stagehand-docs Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@monadoid monadoid merged commit d1bc3be into main Jan 30, 2026
19 checks passed
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Jan 30, 2026

Greptile Overview

Greptile Summary

Added the GET /v1/sessions/{id}/replay endpoint to API documentation across all language SDKs (Python, Java, Go, Ruby).

  • Consistently added the replay endpoint to all four API reference sections
  • Properly formatted JSON with correct trailing commas
  • Included appropriate changeset for documentation update

The changes are straightforward and complete the documentation for the replay functionality.

Confidence Score: 5/5

  • This PR is safe to merge with no risks
  • Simple documentation update that consistently adds a missing endpoint across all SDK documentation sections with proper formatting and changeset
  • No files require special attention

Important Files Changed

Filename Overview
.changeset/crazy-lions-wear.md Added changeset file documenting the addition of /replay endpoint to docs
packages/docs/docs.json Added GET /v1/sessions/{id}/replay endpoint to Python, Java, Go, and Ruby API reference sections

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Docs as Documentation System
    participant API as Stagehand API
    
    Dev->>Docs: Navigate to API Reference
    Note over Dev,Docs: Selects Python/Java/Go/Ruby SDK
    Docs->>Dev: Display available endpoints
    Note over Docs: Now includes GET /replay
    Dev->>API: GET /v1/sessions/{id}/replay
    API->>Dev: Returns session replay data
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.
Architecture diagram
sequenceDiagram
    participant User as Developer/Client
    participant Docs as Mintlify Documentation
    participant API as Stagehand API Server
    participant Storage as Session Storage
    
    Note over User,Docs: Documentation Discovery
    User->>Docs: Browse API Reference
    Docs-->>User: NEW: Show GET /v1/sessions/{id}/replay
    
    Note over User,Storage: NEW: Runtime Request Flow
    User->>API: GET /v1/sessions/{id}/replay
    API->>API: Authenticate Request
    
    alt Session Exists
        API->>Storage: Retrieve session replay data/artifacts
        Storage-->>API: Replay content (video or event log)
        API-->>User: 200 OK (Replay Data)
    else Session Missing or Expired
        API-->>User: 404 Not Found
    end
Loading

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