stagehand_sdk 0.3.0

Rust SDK for Stagehand - AI-powered browser automation with Browserbase
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
use futures::{Stream, StreamExt};
use serde::{Serialize, Deserialize};
use std::collections::HashMap;
use std::pin::Pin;
use std::sync::Arc;
use async_trait::async_trait;
use std::fmt;

// --- Rest API specific imports ---
use reqwest::Client;
use eventsource_client::{Client as SseClient, ClientBuilder, SSE};

// =============================================================================
// Constants
// =============================================================================

// TODO: Change to "rust" once the stagehand-api backend supports it
const SDK_LANGUAGE: &str = "typescript";
const SDK_VERSION: &str = "3.0.0";

// =============================================================================
// Native Response Types
// =============================================================================

/// Log line from the server
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct LogLine {
    #[serde(default)]
    pub message: String,
    #[serde(default)]
    pub status: Option<String>,
}

/// Result from start operation
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct StartResult {
    #[serde(default)]
    pub session_id: String,
}

/// Events that can occur during start
#[derive(Debug, Clone)]
pub enum StartResponseEvent {
    Log(LogLine),
    Result(StartResult),
}

/// Response from start operation
#[derive(Debug, Clone)]
pub struct StartResponse {
    pub event: Option<StartResponseEvent>,
}

/// Events that can occur during act
#[derive(Debug, Clone)]
pub enum ActResponseEvent {
    Log(LogLine),
    Success(bool),
}

/// Response from act operation
#[derive(Debug, Clone)]
pub struct ActResponse {
    pub event: Option<ActResponseEvent>,
}

/// Events that can occur during extract
#[derive(Debug, Clone)]
pub enum ExtractResponseEvent {
    Log(LogLine),
    DataJson(String),
}

/// Response from extract operation
#[derive(Debug, Clone)]
pub struct ExtractResponse {
    pub event: Option<ExtractResponseEvent>,
}

/// Events that can occur during observe
#[derive(Debug, Clone)]
pub enum ObserveResponseEvent {
    Log(LogLine),
    ElementsJson(String),
}

/// Response from observe operation
#[derive(Debug, Clone)]
pub struct ObserveResponse {
    pub event: Option<ObserveResponseEvent>,
}

/// Events that can occur during execute
#[derive(Debug, Clone)]
pub enum ExecuteResponseEvent {
    Log(LogLine),
    ResultJson(String),
}

/// Response from execute operation
#[derive(Debug, Clone)]
pub struct ExecuteResponse {
    pub event: Option<ExecuteResponseEvent>,
}

/// Events that can occur during navigate
#[derive(Debug, Clone)]
pub enum NavigateResponseEvent {
    Log(LogLine),
    Success(bool),
}

/// Response from navigate operation
#[derive(Debug, Clone)]
pub struct NavigateResponse {
    pub event: Option<NavigateResponseEvent>,
}

// =============================================================================
// Model Configuration Types (matches API exactly)
// =============================================================================

/// Model configuration object for API - uses camelCase field names
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ModelObj {
    pub model_name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub api_key: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "baseURL")]
    pub base_url: Option<String>,
}

/// Model configuration - always serializes as an object for proper API key inheritance
#[derive(Debug, Clone, Deserialize)]
#[serde(untagged)]
pub enum ModelConfiguration {
    String(String),
    Object(ModelObj),
}

impl Serialize for ModelConfiguration {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        // Always serialize as an object so the Stagehand agent inherits the API key
        match self {
            ModelConfiguration::String(s) => {
                let obj = ModelObj {
                    model_name: s.clone(),
                    api_key: None,
                    base_url: None,
                };
                obj.serialize(serializer)
            }
            ModelConfiguration::Object(obj) => obj.serialize(serializer),
        }
    }
}

// =============================================================================
// Agent Specific Structs (matching V3 API schema)
// =============================================================================

/// Agent config for agentExecute endpoint
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AgentConfig {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub provider: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub model: Option<ModelConfiguration>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub system_prompt: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cua: Option<bool>,
}

/// Execute options for agentExecute endpoint
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AgentExecuteOptions {
    pub instruction: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_steps: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub highlight_cursor: Option<bool>,
}

// =============================================================================
// Idiomatic Configuration Types
// =============================================================================

#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Env {
    Local,
    Browserbase,
}

impl ToString for Env {
    fn to_string(&self) -> String {
        match self {
            Env::Local => "LOCAL".to_string(),
            Env::Browserbase => "BROWSERBASE".to_string(),
        }
    }
}

/// User-facing model configuration
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum Model {
    String(String),
    Config {
        model_name: String,
        api_key: Option<String>,
        base_url: Option<String>,
    },
}

impl From<Model> for ModelConfiguration {
    fn from(m: Model) -> Self {
        match m {
            Model::String(s) => ModelConfiguration::String(s),
            Model::Config { model_name, api_key, base_url } => ModelConfiguration::Object(ModelObj {
                model_name,
                api_key,
                base_url,
            }),
        }
    }
}

#[derive(Debug, Clone, Default)]
pub struct LocalBrowserLaunchOptions {
    pub headless: Option<bool>,
    pub executable_path: Option<String>,
    pub args: Vec<String>,
    pub user_data_dir: Option<String>,
    pub viewport: Option<(i32, i32)>,
    pub devtools: Option<bool>,
    pub ignore_https_errors: Option<bool>,
    pub cdp_url: Option<String>,
}

#[derive(Debug, Clone, Default)]
pub struct V3Options {
    pub env: Option<Env>,
    pub api_key: Option<String>,
    pub project_id: Option<String>,
    pub browserbase_session_id: Option<String>,
    pub browserbase_session_create_params: Option<serde_json::Value>,
    pub local_browser_launch_options: Option<LocalBrowserLaunchOptions>,
    pub model: Option<Model>,
    pub system_prompt: Option<String>,
    pub self_heal: Option<bool>,
    pub wait_for_captcha_solves: Option<bool>,
    pub experimental: Option<bool>,
    pub dom_settle_timeout_ms: Option<u32>,
    pub act_timeout_ms: Option<u32>,
    pub verbose: Option<i32>,
}

// =============================================================================
// Transport Choice (abstraction layer for future transports)
// =============================================================================

/// Transport selection for connecting to Stagehand API
#[derive(Debug, Clone, PartialEq)]
pub enum TransportChoice {
    /// REST + SSE transport (the primary supported transport)
    Rest(String),
}

// =============================================================================
// Error Types
// =============================================================================

#[derive(Debug)]
pub enum StagehandError {
    Transport(String),
    Api(String),
    MissingApiKey(String),
}

impl fmt::Display for StagehandError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            StagehandError::Transport(msg) => write!(f, "Transport error: {}", msg),
            StagehandError::Api(msg) => write!(f, "API error: {}", msg),
            StagehandError::MissingApiKey(key) => write!(f, "Missing API key: {}", key),
        }
    }
}

impl std::error::Error for StagehandError {}

impl From<reqwest::Error> for StagehandError {
    fn from(err: reqwest::Error) -> Self {
        StagehandError::Transport(err.to_string())
    }
}

impl From<eventsource_client::Error> for StagehandError {
    fn from(err: eventsource_client::Error) -> Self {
        StagehandError::Transport(err.to_string())
    }
}

// =============================================================================
// Transport Abstraction Layer
// =============================================================================

/// Transport trait for Stagehand API communication
#[async_trait]
pub trait Transport: Send + Sync {
    async fn start(&mut self, opts: V3Options) -> Result<Pin<Box<dyn Stream<Item = Result<StartResponse, StagehandError>> + Send>>, StagehandError>;
    async fn navigate(&mut self, session_id: &str, url: String, timeout: Option<u32>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<NavigateResponse, StagehandError>> + Send>>, StagehandError>;
    async fn act(&mut self, session_id: &str, instruction: String, model: Option<Model>, variables: HashMap<String, String>, timeout: Option<u32>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ActResponse, StagehandError>> + Send>>, StagehandError>;
    async fn extract(&mut self, session_id: &str, instruction: String, schema: serde_json::Value, model: Option<Model>, timeout: Option<u32>, selector: Option<String>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ExtractResponse, StagehandError>> + Send>>, StagehandError>;
    async fn observe(&mut self, session_id: &str, instruction: Option<String>, model: Option<Model>, timeout: Option<u32>, selector: Option<String>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ObserveResponse, StagehandError>> + Send>>, StagehandError>;
    async fn execute(&mut self, session_id: &str, agent_config: AgentConfig, execute_options: AgentExecuteOptions, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ExecuteResponse, StagehandError>> + Send>>, StagehandError>;
    async fn end(&mut self, session_id: &str) -> Result<(), StagehandError>;
}

// =============================================================================
// REST Transport Implementation
// =============================================================================

pub struct RestTransport {
    base_url: String,
    api_key: String,
    project_id: String,
    model_api_key: String,
    client: Arc<Client>,
}

impl RestTransport {
    /// Supported model API key environment variables (checked in order)
    const MODEL_API_KEY_ENV_VARS: &'static [&'static str] = &[
        "MODEL_API_KEY",                // Generic override (highest priority)
        "OPENAI_API_KEY",               // OpenAI
        "ANTHROPIC_API_KEY",            // Anthropic (Claude)
        "GOOGLE_GENERATIVE_AI_API_KEY", // Google Gemini
        "AZURE_API_KEY",                // Azure OpenAI
        "MISTRAL_API_KEY",              // Mistral
        "GROQ_API_KEY",                 // Groq
        "CEREBRAS_API_KEY",             // Cerebras
        "DEEPSEEK_API_KEY",             // DeepSeek
    ];

    pub fn new(base_url: String) -> Result<Self, StagehandError> {
        let model_api_key = Self::MODEL_API_KEY_ENV_VARS
            .iter()
            .find_map(|var| std::env::var(var).ok())
            .ok_or_else(|| StagehandError::MissingApiKey(
                format!("One of: {}", Self::MODEL_API_KEY_ENV_VARS.join(", "))
            ))?;

        Ok(Self {
            base_url,
            api_key: std::env::var("BROWSERBASE_API_KEY").map_err(|_| StagehandError::MissingApiKey("BROWSERBASE_API_KEY".to_string()))?,
            project_id: std::env::var("BROWSERBASE_PROJECT_ID").map_err(|_| StagehandError::MissingApiKey("BROWSERBASE_PROJECT_ID".to_string()))?,
            model_api_key,
            client: Arc::new(Client::new()),
        })
    }

    async fn execute_stream(&self, _session_id: &str, path: &str, body: serde_json::Value) -> Result<Pin<Box<dyn Stream<Item = Result<serde_json::Value, StagehandError>> + Send>>, StagehandError> {
        let url = format!("{}{}", self.base_url, path);

        // Debug: print request details
        // eprintln!("[DEBUG] POST {} body={}", url, body);

        let client_builder = ClientBuilder::for_url(&url)?
            .header("x-bb-api-key", &self.api_key)?
            .header("x-bb-project-id", &self.project_id)?
            .header("x-model-api-key", &self.model_api_key)?
            .header("x-stream-response", "true")?
            .header("x-language", SDK_LANGUAGE)?
            .header("x-sdk-version", SDK_VERSION)?
            .header("Content-Type", "application/json")?
            .method(reqwest::Method::POST.to_string())
            .body(body.to_string());

        let sse_client = client_builder.build();
        let (tx, rx) = async_channel::bounded(100);

        let sse_task = async move {
            let mut stream = sse_client.stream();
            while let Some(event) = stream.next().await {
                match event {
                    Ok(sse_event) => {
                        match sse_event {
                            SSE::Event(e) => {
                                // Debug: print raw SSE event
                                // eprintln!("[DEBUG] SSE event: type={} data={}", e.event_type, &e.data);
                                if let Ok(event_data) = serde_json::from_str::<serde_json::Value>(&e.data) {
                                    if tx.send(Ok(event_data)).await.is_err() {
                                        break;
                                    }
                                } else {
                                    let _ = tx.send(Err(StagehandError::Api(format!("Failed to parse SSE event: {}", e.data)))).await;
                                }
                            },
                            SSE::Comment(_c) => {
                                // eprintln!("[DEBUG] SSE comment: {}", _c);
                            },
                            SSE::Connected(_) => {
                                // eprintln!("[DEBUG] SSE connected");
                            },
                        }
                    },
                    Err(e) => {
                        // EOF is expected when the SSE stream closes normally
                        let err_str = e.to_string();
                        if !err_str.contains("eof") {
                            let _ = tx.send(Err(StagehandError::Transport(err_str))).await;
                        }
                        break;
                    }
                }
            }
        };

        // Spawn the SSE reading task using the appropriate runtime
        #[cfg(feature = "tokio-runtime")]
        tokio::spawn(sse_task);

        #[cfg(all(feature = "async-std-runtime", not(feature = "tokio-runtime")))]
        async_std::task::spawn(sse_task);

        // Convert async-channel receiver to a Stream
        Ok(Box::pin(futures::stream::unfold(rx, |rx| async move {
            rx.recv().await.ok().map(|item| (item, rx))
        })))
    }

    fn parse_log_event(json_value: &serde_json::Value) -> Option<LogLine> {
        let data = &json_value["data"];
        Some(LogLine {
            message: data["message"].as_str().unwrap_or("").to_string(),
            status: data["status"].as_str().map(|s| s.to_string()),
        })
    }
}

#[async_trait]
impl Transport for RestTransport {
    async fn start(&mut self, opts: V3Options) -> Result<Pin<Box<dyn Stream<Item = Result<StartResponse, StagehandError>> + Send>>, StagehandError> {
        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct StartPayload<'a> {
            model_name: String,
            #[serde(skip_serializing_if = "Option::is_none")]
            dom_settle_timeout_ms: Option<u32>,
            #[serde(skip_serializing_if = "Option::is_none")]
            verbose: Option<String>,
            #[serde(skip_serializing_if = "Option::is_none")]
            system_prompt: Option<&'a String>,
            #[serde(skip_serializing_if = "Option::is_none")]
            self_heal: Option<bool>,
            #[serde(skip_serializing_if = "Option::is_none")]
            wait_for_captcha_solves: Option<bool>,
            #[serde(skip_serializing_if = "Option::is_none")]
            browserbase_session_create_params: Option<&'a serde_json::Value>,
            #[serde(rename = "browserbaseSessionID")]
            #[serde(skip_serializing_if = "Option::is_none")]
            browserbase_session_id: Option<&'a String>,
            #[serde(skip_serializing_if = "Option::is_none")]
            experimental: Option<bool>,
            #[serde(skip_serializing_if = "Option::is_none")]
            act_timeout_ms: Option<u32>,
        }

        let model_name = opts.model.as_ref().map(|m| match m {
            Model::String(s) => s.clone(),
            Model::Config { model_name, .. } => model_name.clone(),
        }).unwrap_or_else(|| "openai/gpt-5-nano".to_string());

        let payload = StartPayload {
            model_name,
            dom_settle_timeout_ms: opts.dom_settle_timeout_ms,
            verbose: opts.verbose.map(|v| v.to_string()),
            system_prompt: opts.system_prompt.as_ref(),
            self_heal: opts.self_heal,
            wait_for_captcha_solves: opts.wait_for_captcha_solves,
            browserbase_session_create_params: opts.browserbase_session_create_params.as_ref(),
            browserbase_session_id: opts.browserbase_session_id.as_ref(),
            experimental: opts.experimental,
            act_timeout_ms: opts.act_timeout_ms,
        };

        let body = serde_json::to_value(payload).map_err(|e| StagehandError::Api(e.to_string()))?;

        // Start uses regular HTTP POST, not SSE streaming
        let url = format!("{}/sessions/start", self.base_url);
        let response = self.client
            .post(&url)
            .header("x-bb-api-key", &self.api_key)
            .header("x-bb-project-id", &self.project_id)
            .header("x-model-api-key", &self.model_api_key)
            .header("x-language", SDK_LANGUAGE)
            .header("x-sdk-version", SDK_VERSION)
            .header("Content-Type", "application/json")
            .json(&body)
            .send()
            .await?;

        let json_value: serde_json::Value = response.json().await?;

        // Check for error response
        if !json_value["success"].as_bool().unwrap_or(false) {
            return Err(StagehandError::Api(json_value["error"].as_str().unwrap_or("Unknown error").to_string()));
        }

        // Check if available
        if !json_value["data"]["available"].as_bool().unwrap_or(false) {
            return Err(StagehandError::Api("Stagehand API not available for this account".to_string()));
        }

        let session_id = json_value["data"]["sessionId"]
            .as_str()
            .unwrap_or("")
            .to_string();

        // Return a single-item stream with the result
        let result = StartResponse {
            event: Some(StartResponseEvent::Result(StartResult { session_id }))
        };

        Ok(Box::pin(futures::stream::once(async move { Ok(result) })))
    }

    async fn navigate(&mut self, session_id: &str, url: String, timeout: Option<u32>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<NavigateResponse, StagehandError>> + Send>>, StagehandError> {
        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct NavigatePayload {
            url: String,
            #[serde(skip_serializing_if = "Option::is_none")]
            options: Option<NavigateOptions>,
            // V3 schema requires frameId, use empty string for active page
            frame_id: String,
        }

        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct NavigateOptions {
            #[serde(skip_serializing_if = "Option::is_none")]
            timeout: Option<u32>,
        }

        let options = timeout.map(|t| NavigateOptions { timeout: Some(t) });

        let payload = NavigatePayload {
            url,
            options,
            // Use provided frame_id or empty string (backend uses active page for empty/falsy)
            frame_id: frame_id.unwrap_or_default(),
        };

        let body = serde_json::to_value(payload).map_err(|e| StagehandError::Api(e.to_string()))?;
        let json_stream = self.execute_stream(session_id, &format!("/sessions/{}/navigate", session_id), body).await?;

        Ok(Box::pin(json_stream.map(|item| {
            item.and_then(|json_value| {
                if let Some(event_type) = json_value["type"].as_str() {
                    match event_type {
                        "system" => {
                            if let Some(status) = json_value["data"]["status"].as_str() {
                                match status {
                                    "finished" => {
                                        Ok(NavigateResponse { event: Some(NavigateResponseEvent::Success(true)) })
                                    },
                                    "error" => {
                                        Err(StagehandError::Api(json_value["data"]["error"].as_str().unwrap_or("Unknown error").to_string()))
                                    },
                                    _ => Ok(NavigateResponse { event: None })
                                }
                            } else {
                                Ok(NavigateResponse { event: None })
                            }
                        },
                        "log" => {
                            if let Some(log) = RestTransport::parse_log_event(&json_value) {
                                Ok(NavigateResponse { event: Some(NavigateResponseEvent::Log(log)) })
                            } else {
                                Ok(NavigateResponse { event: None })
                            }
                        },
                        _ => Ok(NavigateResponse { event: None })
                    }
                } else {
                    Ok(NavigateResponse { event: Some(NavigateResponseEvent::Success(true)) })
                }
            })
        })))
    }

    async fn act(&mut self, session_id: &str, instruction: String, model: Option<Model>, variables: HashMap<String, String>, timeout: Option<u32>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ActResponse, StagehandError>> + Send>>, StagehandError> {
        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct ActPayload {
            input: String,
            #[serde(skip_serializing_if = "Option::is_none")]
            options: Option<ActOptions>,
            #[serde(skip_serializing_if = "Option::is_none")]
            frame_id: Option<String>,
        }

        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct ActOptions {
            #[serde(skip_serializing_if = "Option::is_none")]
            model: Option<ModelObj>,
            #[serde(skip_serializing_if = "Option::is_none")]
            variables: Option<HashMap<String, String>>,
            #[serde(skip_serializing_if = "Option::is_none")]
            timeout: Option<u32>,
        }

        let model_obj = model.map(|m| match m {
            Model::String(s) => ModelObj { model_name: s, api_key: None, base_url: None },
            Model::Config { model_name, api_key, base_url } => ModelObj { model_name, api_key, base_url },
        });

        let options = if model_obj.is_some() || !variables.is_empty() || timeout.is_some() {
            Some(ActOptions {
                model: model_obj,
                variables: if variables.is_empty() { None } else { Some(variables) },
                timeout,
            })
        } else {
            None
        };

        let payload = ActPayload {
            input: instruction,
            options,
            frame_id,
        };

        let body = serde_json::to_value(payload).map_err(|e| StagehandError::Api(e.to_string()))?;
        let json_stream = self.execute_stream(session_id, &format!("/sessions/{}/act", session_id), body).await?;

        Ok(Box::pin(json_stream.map(|item| {
            item.and_then(|json_value| {
                if let Some(event_type) = json_value["type"].as_str() {
                    match event_type {
                        "system" => {
                            if let Some(status) = json_value["data"]["status"].as_str() {
                                match status {
                                    "finished" => {
                                        let success = json_value["data"]["result"]["success"].as_bool().unwrap_or(true);
                                        Ok(ActResponse { event: Some(ActResponseEvent::Success(success)) })
                                    },
                                    "error" => {
                                        Err(StagehandError::Api(json_value["data"]["error"].as_str().unwrap_or("Unknown error").to_string()))
                                    },
                                    _ => Ok(ActResponse { event: None })
                                }
                            } else {
                                Ok(ActResponse { event: None })
                            }
                        },
                        "log" => {
                            if let Some(log) = RestTransport::parse_log_event(&json_value) {
                                Ok(ActResponse { event: Some(ActResponseEvent::Log(log)) })
                            } else {
                                Ok(ActResponse { event: None })
                            }
                        },
                        _ => Ok(ActResponse { event: None })
                    }
                } else {
                    let success = json_value["success"].as_bool().unwrap_or(true);
                    Ok(ActResponse { event: Some(ActResponseEvent::Success(success)) })
                }
            })
        })))
    }

    async fn extract(&mut self, session_id: &str, instruction: String, schema: serde_json::Value, model: Option<Model>, timeout: Option<u32>, selector: Option<String>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ExtractResponse, StagehandError>> + Send>>, StagehandError> {
        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct ExtractPayload {
            #[serde(skip_serializing_if = "Option::is_none")]
            instruction: Option<String>,
            #[serde(skip_serializing_if = "Option::is_none")]
            schema: Option<serde_json::Value>,
            #[serde(skip_serializing_if = "Option::is_none")]
            options: Option<ExtractOptions>,
            #[serde(skip_serializing_if = "Option::is_none")]
            frame_id: Option<String>,
        }

        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct ExtractOptions {
            #[serde(skip_serializing_if = "Option::is_none")]
            model: Option<ModelObj>,
            #[serde(skip_serializing_if = "Option::is_none")]
            timeout: Option<u32>,
            #[serde(skip_serializing_if = "Option::is_none")]
            selector: Option<String>,
        }

        let model_obj = model.map(|m| match m {
            Model::String(s) => ModelObj { model_name: s, api_key: None, base_url: None },
            Model::Config { model_name, api_key, base_url } => ModelObj { model_name, api_key, base_url },
        });

        let options = if model_obj.is_some() || timeout.is_some() || selector.is_some() {
            Some(ExtractOptions {
                model: model_obj,
                timeout,
                selector,
            })
        } else {
            None
        };

        let payload = ExtractPayload {
            instruction: if instruction.is_empty() { None } else { Some(instruction) },
            schema: if schema.is_null() { None } else { Some(schema) },
            options,
            frame_id,
        };

        let body = serde_json::to_value(payload).map_err(|e| StagehandError::Api(e.to_string()))?;
        let json_stream = self.execute_stream(session_id, &format!("/sessions/{}/extract", session_id), body).await?;

        Ok(Box::pin(json_stream.map(|item| {
            item.and_then(|json_value| {
                if let Some(event_type) = json_value["type"].as_str() {
                    match event_type {
                        "system" => {
                            if let Some(status) = json_value["data"]["status"].as_str() {
                                match status {
                                    "finished" => {
                                        let result = &json_value["data"]["result"];
                                        Ok(ExtractResponse { event: Some(ExtractResponseEvent::DataJson(result.to_string())) })
                                    },
                                    "error" => {
                                        Err(StagehandError::Api(json_value["data"]["error"].as_str().unwrap_or("Unknown error").to_string()))
                                    },
                                    _ => Ok(ExtractResponse { event: None })
                                }
                            } else {
                                Ok(ExtractResponse { event: None })
                            }
                        },
                        "log" => {
                            if let Some(log) = RestTransport::parse_log_event(&json_value) {
                                Ok(ExtractResponse { event: Some(ExtractResponseEvent::Log(log)) })
                            } else {
                                Ok(ExtractResponse { event: None })
                            }
                        },
                        _ => Ok(ExtractResponse { event: None })
                    }
                } else {
                    Ok(ExtractResponse { event: Some(ExtractResponseEvent::DataJson(json_value.to_string())) })
                }
            })
        })))
    }

    async fn observe(&mut self, session_id: &str, instruction: Option<String>, model: Option<Model>, timeout: Option<u32>, selector: Option<String>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ObserveResponse, StagehandError>> + Send>>, StagehandError> {
        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct ObservePayload {
            #[serde(skip_serializing_if = "Option::is_none")]
            instruction: Option<String>,
            #[serde(skip_serializing_if = "Option::is_none")]
            options: Option<ObserveOptions>,
            #[serde(skip_serializing_if = "Option::is_none")]
            frame_id: Option<String>,
        }

        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct ObserveOptions {
            #[serde(skip_serializing_if = "Option::is_none")]
            model: Option<ModelObj>,
            #[serde(skip_serializing_if = "Option::is_none")]
            timeout: Option<u32>,
            #[serde(skip_serializing_if = "Option::is_none")]
            selector: Option<String>,
        }

        let model_obj = model.map(|m| match m {
            Model::String(s) => ModelObj { model_name: s, api_key: None, base_url: None },
            Model::Config { model_name, api_key, base_url } => ModelObj { model_name, api_key, base_url },
        });

        let options = if model_obj.is_some() || timeout.is_some() || selector.is_some() {
            Some(ObserveOptions {
                model: model_obj,
                timeout,
                selector,
            })
        } else {
            None
        };

        let payload = ObservePayload {
            instruction,
            options,
            frame_id,
        };

        let body = serde_json::to_value(payload).map_err(|e| StagehandError::Api(e.to_string()))?;
        let json_stream = self.execute_stream(session_id, &format!("/sessions/{}/observe", session_id), body).await?;

        Ok(Box::pin(json_stream.map(|item| {
            item.and_then(|json_value| {
                if let Some(event_type) = json_value["type"].as_str() {
                    match event_type {
                        "system" => {
                            if let Some(status) = json_value["data"]["status"].as_str() {
                                match status {
                                    "finished" => {
                                        let result = &json_value["data"]["result"];
                                        Ok(ObserveResponse { event: Some(ObserveResponseEvent::ElementsJson(result.to_string())) })
                                    },
                                    "error" => {
                                        Err(StagehandError::Api(json_value["data"]["error"].as_str().unwrap_or("Unknown error").to_string()))
                                    },
                                    _ => Ok(ObserveResponse { event: None })
                                }
                            } else {
                                Ok(ObserveResponse { event: None })
                            }
                        },
                        "log" => {
                            if let Some(log) = RestTransport::parse_log_event(&json_value) {
                                Ok(ObserveResponse { event: Some(ObserveResponseEvent::Log(log)) })
                            } else {
                                Ok(ObserveResponse { event: None })
                            }
                        },
                        _ => Ok(ObserveResponse { event: None })
                    }
                } else {
                    Ok(ObserveResponse { event: Some(ObserveResponseEvent::ElementsJson(json_value.to_string())) })
                }
            })
        })))
    }

    async fn execute(&mut self, session_id: &str, agent_config: AgentConfig, execute_options: AgentExecuteOptions, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ExecuteResponse, StagehandError>> + Send>>, StagehandError> {
        #[derive(Serialize)]
        #[serde(rename_all = "camelCase")]
        struct ExecutePayload {
            agent_config: AgentConfig,
            execute_options: AgentExecuteOptions,
            #[serde(skip_serializing_if = "Option::is_none")]
            frame_id: Option<String>,
        }

        let payload = ExecutePayload {
            agent_config,
            execute_options,
            frame_id,
        };

        let body = serde_json::to_value(payload).map_err(|e| StagehandError::Api(e.to_string()))?;
        let json_stream = self.execute_stream(session_id, &format!("/sessions/{}/agentExecute", session_id), body).await?;

        Ok(Box::pin(json_stream.map(|item| {
            item.and_then(|json_value| {
                if let Some(event_type) = json_value["type"].as_str() {
                    match event_type {
                        "system" => {
                            if let Some(status) = json_value["data"]["status"].as_str() {
                                match status {
                                    "finished" => {
                                        let result = &json_value["data"]["result"];
                                        Ok(ExecuteResponse { event: Some(ExecuteResponseEvent::ResultJson(result.to_string())) })
                                    },
                                    "error" => {
                                        Err(StagehandError::Api(json_value["data"]["error"].as_str().unwrap_or("Unknown error").to_string()))
                                    },
                                    _ => Ok(ExecuteResponse { event: None })
                                }
                            } else {
                                Ok(ExecuteResponse { event: None })
                            }
                        },
                        "log" => {
                            if let Some(log) = RestTransport::parse_log_event(&json_value) {
                                Ok(ExecuteResponse { event: Some(ExecuteResponseEvent::Log(log)) })
                            } else {
                                Ok(ExecuteResponse { event: None })
                            }
                        },
                        _ => Ok(ExecuteResponse { event: None })
                    }
                } else {
                    Ok(ExecuteResponse { event: Some(ExecuteResponseEvent::ResultJson(json_value.to_string())) })
                }
            })
        })))
    }

    async fn end(&mut self, session_id: &str) -> Result<(), StagehandError> {
        let url = format!("{}/sessions/{}/end", self.base_url, session_id);
        self.client.post(&url)
            .header("x-bb-api-key", &self.api_key)
            .header("x-bb-project-id", &self.project_id)
            .header("x-model-api-key", &self.model_api_key)
            .header("x-stream-response", "false")
            .send()
            .await?;
        Ok(())
    }
}

// =============================================================================
// The Stagehand Client
// =============================================================================

pub struct Stagehand {
    transport: Box<dyn Transport + Send + Sync>,
    session_id: Option<String>,
}

impl Stagehand {
    pub async fn connect(transport_choice: TransportChoice) -> Result<Self, StagehandError> {
        let transport: Box<dyn Transport + Send + Sync> = match transport_choice {
            TransportChoice::Rest(base_url) => Box::new(RestTransport::new(base_url)?),
        };
        Ok(Self { transport, session_id: None })
    }

    pub async fn start(&mut self, opts: V3Options) -> Result<(), StagehandError> {
        let mut stream = self.transport.start(opts).await?;
        while let Some(item) = stream.next().await {
            match item {
                Ok(response) => {
                    if let Some(StartResponseEvent::Result(res)) = response.event {
                        if !res.session_id.is_empty() {
                            self.session_id = Some(res.session_id);
                            return Ok(());
                        }
                    }
                },
                Err(e) => return Err(e),
            }
        }
        Err(StagehandError::Api("Start did not return a session ID.".to_string()))
    }

    pub async fn navigate(&mut self, url: impl Into<String>, timeout: Option<u32>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<NavigateResponse, StagehandError>> + Send>>, StagehandError> {
        let session_id = self.session_id.as_ref().ok_or_else(|| StagehandError::Api("Session not initialized".to_string()))?.clone();
        self.transport.navigate(&session_id, url.into(), timeout, frame_id).await
    }

    pub async fn act(&mut self, instruction: impl Into<String>, model: Option<Model>, variables: HashMap<String, String>, timeout: Option<u32>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ActResponse, StagehandError>> + Send>>, StagehandError> {
        let session_id = self.session_id.as_ref().ok_or_else(|| StagehandError::Api("Session not initialized".to_string()))?.clone();
        self.transport.act(&session_id, instruction.into(), model, variables, timeout, frame_id).await
    }

    /// Extract data from the page using AI.
    ///
    /// The `schema` parameter should be a JSON Schema object describing the expected output format.
    /// Example:
    /// ```json
    /// {
    ///   "type": "object",
    ///   "properties": {
    ///     "title": { "type": "string" },
    ///     "description": { "type": "string" }
    ///   }
    /// }
    /// ```
    pub async fn extract(&mut self, instruction: impl Into<String>, schema: serde_json::Value, model: Option<Model>, timeout: Option<u32>, selector: Option<String>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ExtractResponse, StagehandError>> + Send>>, StagehandError> {
        let session_id = self.session_id.as_ref().ok_or_else(|| StagehandError::Api("Session not initialized".to_string()))?.clone();
        self.transport.extract(&session_id, instruction.into(), schema, model, timeout, selector, frame_id).await
    }

    pub async fn observe(&mut self, instruction: Option<String>, model: Option<Model>, timeout: Option<u32>, selector: Option<String>, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ObserveResponse, StagehandError>> + Send>>, StagehandError> {
        let session_id = self.session_id.as_ref().ok_or_else(|| StagehandError::Api("Session not initialized".to_string()))?.clone();
        self.transport.observe(&session_id, instruction, model, timeout, selector, frame_id).await
    }

    pub async fn execute(&mut self, agent_config: AgentConfig, execute_options: AgentExecuteOptions, frame_id: Option<String>) -> Result<Pin<Box<dyn Stream<Item = Result<ExecuteResponse, StagehandError>> + Send>>, StagehandError> {
        let session_id = self.session_id.as_ref().ok_or_else(|| StagehandError::Api("Session not initialized".to_string()))?.clone();
        self.transport.execute(&session_id, agent_config, execute_options, frame_id).await
    }

    pub async fn end(&mut self) -> Result<(), StagehandError> {
        let session_id = self.session_id.as_ref().ok_or_else(|| StagehandError::Api("Session not started".to_string()))?.clone();
        self.transport.end(&session_id).await
    }

    /// Returns the Browserbase session ID if initialized
    pub fn session_id(&self) -> Option<&str> {
        self.session_id.as_deref()
    }

    /// Returns the Browserbase CDP WebSocket URL for connecting external tools like chromiumoxide.
    ///
    /// This fetches the session from the Browserbase API to get the proper `connectUrl`
    /// with signing key, which is required for CDP connections.
    ///
    /// # Example
    /// ```ignore
    /// let cdp_url = stagehand.browserbase_cdp_url().await?;
    /// let (browser, handler) = Browser::connect(&cdp_url).await?;
    /// ```
    pub async fn browserbase_cdp_url(&self) -> Result<String, StagehandError> {
        let session_id = self.session_id.as_ref()
            .ok_or_else(|| StagehandError::Api("Session not initialized".to_string()))?;
        let api_key = std::env::var("BROWSERBASE_API_KEY")
            .map_err(|_| StagehandError::MissingApiKey("BROWSERBASE_API_KEY".to_string()))?;

        let client = reqwest::Client::new();
        let response = client
            .get(format!("https://api.browserbase.com/v1/sessions/{}", session_id))
            .header("x-bb-api-key", &api_key)
            .send()
            .await
            .map_err(|e| StagehandError::Api(format!("Failed to fetch session: {}", e)))?;

        if !response.status().is_success() {
            return Err(StagehandError::Api(format!(
                "Failed to fetch session: HTTP {}",
                response.status()
            )));
        }

        let session_data: serde_json::Value = response.json().await
            .map_err(|e| StagehandError::Api(format!("Failed to parse session response: {}", e)))?;

        let connect_url = session_data["connectUrl"]
            .as_str()
            .ok_or_else(|| StagehandError::Api("Session response missing connectUrl".to_string()))?;

        // Fix URL format: Browserbase returns URLs like "wss://host?query" but AWS ELB
        // requires a path before the query string. We normalize to "wss://host/?query"
        if let Some((before_query, query)) = connect_url.split_once('?') {
            // Check if there's no path after the host (no '/' after "://")
            if let Some((_, after_scheme)) = before_query.split_once("://") {
                if !after_scheme.contains('/') {
                    return Ok(format!("{}/?{}", before_query, query));
                }
            }
        }
        Ok(connect_url.to_string())
    }
}