-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathsession.go
More file actions
2039 lines (1830 loc) · 78.7 KB
/
session.go
File metadata and controls
2039 lines (1830 loc) · 78.7 KB
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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package stagehand
import (
"context"
"encoding/json"
"errors"
"fmt"
"net/http"
"slices"
"github.com/browserbase/stagehand-go/v3/internal/apijson"
"github.com/browserbase/stagehand-go/v3/internal/requestconfig"
"github.com/browserbase/stagehand-go/v3/option"
"github.com/browserbase/stagehand-go/v3/packages/param"
"github.com/browserbase/stagehand-go/v3/packages/respjson"
"github.com/browserbase/stagehand-go/v3/packages/ssestream"
"github.com/browserbase/stagehand-go/v3/shared/constant"
)
// SessionService contains methods and other services that help with interacting
// with the stagehand API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewSessionService] method instead.
type SessionService struct {
Options []option.RequestOption
}
// NewSessionService generates a new service that applies the given options to each
// request. These options are applied after the parent client's options (if there
// is one), and before any request-specific options.
func NewSessionService(opts ...option.RequestOption) (r SessionService) {
r = SessionService{}
r.Options = opts
return
}
// Executes a browser action using natural language instructions or a predefined
// Action object.
func (r *SessionService) Act(ctx context.Context, id string, params SessionActParams, opts ...option.RequestOption) (res *SessionActResponse, err error) {
if !param.IsOmitted(params.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", params.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
if id == "" {
err = errors.New("missing required id parameter")
return nil, err
}
path := fmt.Sprintf("v1/sessions/%s/act", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &res, opts...)
return res, err
}
// Executes a browser action using natural language instructions or a predefined
// Action object.
func (r *SessionService) ActStreaming(ctx context.Context, id string, params SessionActParams, opts ...option.RequestOption) (stream *ssestream.Stream[StreamEvent]) {
var (
raw *http.Response
err error
)
if !param.IsOmitted(params.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", params.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
opts = append(opts, option.WithJSONSet("streamResponse", true))
if id == "" {
err = errors.New("missing required id parameter")
return ssestream.NewStream[StreamEvent](nil, err)
}
path := fmt.Sprintf("v1/sessions/%s/act", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &raw, opts...)
return ssestream.NewStream[StreamEvent](ssestream.NewDecoder(raw), err)
}
// Terminates the browser session and releases all associated resources.
func (r *SessionService) End(ctx context.Context, id string, body SessionEndParams, opts ...option.RequestOption) (res *SessionEndResponse, err error) {
if !param.IsOmitted(body.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", body.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
if id == "" {
err = errors.New("missing required id parameter")
return nil, err
}
path := fmt.Sprintf("v1/sessions/%s/end", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, nil, &res, opts...)
return res, err
}
// Runs an autonomous AI agent that can perform complex multi-step browser tasks.
func (r *SessionService) Execute(ctx context.Context, id string, params SessionExecuteParams, opts ...option.RequestOption) (res *SessionExecuteResponse, err error) {
if !param.IsOmitted(params.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", params.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
if id == "" {
err = errors.New("missing required id parameter")
return nil, err
}
path := fmt.Sprintf("v1/sessions/%s/agentExecute", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &res, opts...)
return res, err
}
// Runs an autonomous AI agent that can perform complex multi-step browser tasks.
func (r *SessionService) ExecuteStreaming(ctx context.Context, id string, params SessionExecuteParams, opts ...option.RequestOption) (stream *ssestream.Stream[StreamEvent]) {
var (
raw *http.Response
err error
)
if !param.IsOmitted(params.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", params.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
opts = append(opts, option.WithJSONSet("streamResponse", true))
if id == "" {
err = errors.New("missing required id parameter")
return ssestream.NewStream[StreamEvent](nil, err)
}
path := fmt.Sprintf("v1/sessions/%s/agentExecute", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &raw, opts...)
return ssestream.NewStream[StreamEvent](ssestream.NewDecoder(raw), err)
}
// Extracts structured data from the current page using AI-powered analysis.
func (r *SessionService) Extract(ctx context.Context, id string, params SessionExtractParams, opts ...option.RequestOption) (res *SessionExtractResponse, err error) {
if !param.IsOmitted(params.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", params.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
if id == "" {
err = errors.New("missing required id parameter")
return nil, err
}
path := fmt.Sprintf("v1/sessions/%s/extract", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &res, opts...)
return res, err
}
// Extracts structured data from the current page using AI-powered analysis.
func (r *SessionService) ExtractStreaming(ctx context.Context, id string, params SessionExtractParams, opts ...option.RequestOption) (stream *ssestream.Stream[StreamEvent]) {
var (
raw *http.Response
err error
)
if !param.IsOmitted(params.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", params.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
opts = append(opts, option.WithJSONSet("streamResponse", true))
if id == "" {
err = errors.New("missing required id parameter")
return ssestream.NewStream[StreamEvent](nil, err)
}
path := fmt.Sprintf("v1/sessions/%s/extract", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &raw, opts...)
return ssestream.NewStream[StreamEvent](ssestream.NewDecoder(raw), err)
}
// Navigates the browser to the specified URL.
func (r *SessionService) Navigate(ctx context.Context, id string, params SessionNavigateParams, opts ...option.RequestOption) (res *SessionNavigateResponse, err error) {
if !param.IsOmitted(params.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", params.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
if id == "" {
err = errors.New("missing required id parameter")
return nil, err
}
path := fmt.Sprintf("v1/sessions/%s/navigate", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &res, opts...)
return res, err
}
// Identifies and returns available actions on the current page that match the
// given instruction.
func (r *SessionService) Observe(ctx context.Context, id string, params SessionObserveParams, opts ...option.RequestOption) (res *SessionObserveResponse, err error) {
if !param.IsOmitted(params.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", params.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
if id == "" {
err = errors.New("missing required id parameter")
return nil, err
}
path := fmt.Sprintf("v1/sessions/%s/observe", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &res, opts...)
return res, err
}
// Identifies and returns available actions on the current page that match the
// given instruction.
func (r *SessionService) ObserveStreaming(ctx context.Context, id string, params SessionObserveParams, opts ...option.RequestOption) (stream *ssestream.Stream[StreamEvent]) {
var (
raw *http.Response
err error
)
if !param.IsOmitted(params.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", params.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
opts = append(opts, option.WithJSONSet("streamResponse", true))
if id == "" {
err = errors.New("missing required id parameter")
return ssestream.NewStream[StreamEvent](nil, err)
}
path := fmt.Sprintf("v1/sessions/%s/observe", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &raw, opts...)
return ssestream.NewStream[StreamEvent](ssestream.NewDecoder(raw), err)
}
// Retrieves replay metrics for a session.
func (r *SessionService) Replay(ctx context.Context, id string, query SessionReplayParams, opts ...option.RequestOption) (res *SessionReplayResponse, err error) {
if !param.IsOmitted(query.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", query.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
if id == "" {
err = errors.New("missing required id parameter")
return nil, err
}
path := fmt.Sprintf("v1/sessions/%s/replay", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
return res, err
}
// Creates a new browser session with the specified configuration. Returns a
// session ID used for all subsequent operations.
func (r *SessionService) Start(ctx context.Context, params SessionStartParams, opts ...option.RequestOption) (res *SessionStartResponse, err error) {
if !param.IsOmitted(params.XStreamResponse) {
opts = append(opts, option.WithHeader("x-stream-response", fmt.Sprintf("%v", params.XStreamResponse)))
}
opts = slices.Concat(r.Options, opts)
path := "v1/sessions/start"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &res, opts...)
return res, err
}
// Action object returned by observe and used by act
//
// The properties Description, Selector are required.
type ActionParam struct {
// Human-readable description of the action
Description string `json:"description" api:"required"`
// CSS selector or XPath for the element
Selector string `json:"selector" api:"required"`
// Backend node ID for the element
BackendNodeID param.Opt[float64] `json:"backendNodeId,omitzero"`
// The method to execute (click, fill, etc.)
Method param.Opt[string] `json:"method,omitzero"`
// Arguments to pass to the method
Arguments []string `json:"arguments,omitzero"`
paramObj
}
func (r ActionParam) MarshalJSON() (data []byte, err error) {
type shadow ActionParam
return param.MarshalObject(r, (*shadow)(&r))
}
func (r *ActionParam) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// The property ModelName is required.
type ModelConfigParam struct {
// Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
ModelName string `json:"modelName" api:"required"`
// API key for the model provider
APIKey param.Opt[string] `json:"apiKey,omitzero"`
// Base URL for the model provider
BaseURL param.Opt[string] `json:"baseURL,omitzero" format:"uri"`
// Custom headers sent with every request to the model provider
Headers map[string]string `json:"headers,omitzero"`
// AI provider for the model (or provide a baseURL endpoint instead)
//
// Any of "openai", "anthropic", "google", "microsoft", "bedrock".
Provider ModelConfigProvider `json:"provider,omitzero"`
paramObj
}
func (r ModelConfigParam) MarshalJSON() (data []byte, err error) {
type shadow ModelConfigParam
return param.MarshalObject(r, (*shadow)(&r))
}
func (r *ModelConfigParam) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// AI provider for the model (or provide a baseURL endpoint instead)
type ModelConfigProvider string
const (
ModelConfigProviderOpenAI ModelConfigProvider = "openai"
ModelConfigProviderAnthropic ModelConfigProvider = "anthropic"
ModelConfigProviderGoogle ModelConfigProvider = "google"
ModelConfigProviderMicrosoft ModelConfigProvider = "microsoft"
ModelConfigProviderBedrock ModelConfigProvider = "bedrock"
)
// Server-Sent Event emitted during streaming responses. Events are sent as
// `event: <status>\ndata: <JSON>\n\n`, where the JSON payload has the shape
// `{ data, type, id }`.
type StreamEvent struct {
// Unique identifier for this event
ID string `json:"id" api:"required" format:"uuid"`
Data StreamEventDataUnion `json:"data" api:"required"`
// Type of stream event - system events or log messages
//
// Any of "system", "log".
Type StreamEventType `json:"type" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
ID respjson.Field
Data respjson.Field
Type respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r StreamEvent) RawJSON() string { return r.JSON.raw }
func (r *StreamEvent) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// StreamEventDataUnion contains all possible properties and values from
// [StreamEventDataStreamEventSystemDataOutput],
// [StreamEventDataStreamEventLogDataOutput].
//
// Use the methods beginning with 'As' to cast the union to one of its variants.
type StreamEventDataUnion struct {
Status string `json:"status"`
// This field is from variant [StreamEventDataStreamEventSystemDataOutput].
Error string `json:"error"`
// This field is from variant [StreamEventDataStreamEventSystemDataOutput].
Result any `json:"result"`
// This field is from variant [StreamEventDataStreamEventLogDataOutput].
Message string `json:"message"`
JSON struct {
Status respjson.Field
Error respjson.Field
Result respjson.Field
Message respjson.Field
raw string
} `json:"-"`
}
func (u StreamEventDataUnion) AsStreamEventDataStreamEventSystemDataOutput() (v StreamEventDataStreamEventSystemDataOutput) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u StreamEventDataUnion) AsStreamEventDataStreamEventLogDataOutput() (v StreamEventDataStreamEventLogDataOutput) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
// Returns the unmodified JSON received from the API
func (u StreamEventDataUnion) RawJSON() string { return u.JSON.raw }
func (r *StreamEventDataUnion) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type StreamEventDataStreamEventSystemDataOutput struct {
// Current status of the streaming operation
//
// Any of "starting", "connected", "running", "finished", "error".
Status string `json:"status" api:"required"`
// Error message (present when status is 'error')
Error string `json:"error"`
// Operation result (present when status is 'finished')
Result any `json:"result"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Status respjson.Field
Error respjson.Field
Result respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r StreamEventDataStreamEventSystemDataOutput) RawJSON() string { return r.JSON.raw }
func (r *StreamEventDataStreamEventSystemDataOutput) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type StreamEventDataStreamEventLogDataOutput struct {
// Log message from the operation
Message string `json:"message" api:"required"`
Status constant.Running `json:"status" default:"running"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Message respjson.Field
Status respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r StreamEventDataStreamEventLogDataOutput) RawJSON() string { return r.JSON.raw }
func (r *StreamEventDataStreamEventLogDataOutput) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Type of stream event - system events or log messages
type StreamEventType string
const (
StreamEventTypeSystem StreamEventType = "system"
StreamEventTypeLog StreamEventType = "log"
)
type SessionActResponse struct {
Data SessionActResponseData `json:"data" api:"required"`
// Indicates whether the request was successful
Success bool `json:"success" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Data respjson.Field
Success respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionActResponse) RawJSON() string { return r.JSON.raw }
func (r *SessionActResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionActResponseData struct {
Result SessionActResponseDataResult `json:"result" api:"required"`
// Action ID for tracking
ActionID string `json:"actionId"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Result respjson.Field
ActionID respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionActResponseData) RawJSON() string { return r.JSON.raw }
func (r *SessionActResponseData) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionActResponseDataResult struct {
// Description of the action that was performed
ActionDescription string `json:"actionDescription" api:"required"`
// List of actions that were executed
Actions []SessionActResponseDataResultAction `json:"actions" api:"required"`
// Human-readable result message
Message string `json:"message" api:"required"`
// Whether the action completed successfully
Success bool `json:"success" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
ActionDescription respjson.Field
Actions respjson.Field
Message respjson.Field
Success respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionActResponseDataResult) RawJSON() string { return r.JSON.raw }
func (r *SessionActResponseDataResult) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Action object returned by observe and used by act
type SessionActResponseDataResultAction struct {
// Human-readable description of the action
Description string `json:"description" api:"required"`
// CSS selector or XPath for the element
Selector string `json:"selector" api:"required"`
// Arguments to pass to the method
Arguments []string `json:"arguments"`
// Backend node ID for the element
BackendNodeID float64 `json:"backendNodeId"`
// The method to execute (click, fill, etc.)
Method string `json:"method"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Description respjson.Field
Selector respjson.Field
Arguments respjson.Field
BackendNodeID respjson.Field
Method respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionActResponseDataResultAction) RawJSON() string { return r.JSON.raw }
func (r *SessionActResponseDataResultAction) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionEndResponse struct {
// Indicates whether the request was successful
Success bool `json:"success" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Success respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionEndResponse) RawJSON() string { return r.JSON.raw }
func (r *SessionEndResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionExecuteResponse struct {
Data SessionExecuteResponseData `json:"data" api:"required"`
// Indicates whether the request was successful
Success bool `json:"success" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Data respjson.Field
Success respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionExecuteResponse) RawJSON() string { return r.JSON.raw }
func (r *SessionExecuteResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionExecuteResponseData struct {
Result SessionExecuteResponseDataResult `json:"result" api:"required"`
CacheEntry SessionExecuteResponseDataCacheEntry `json:"cacheEntry"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Result respjson.Field
CacheEntry respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionExecuteResponseData) RawJSON() string { return r.JSON.raw }
func (r *SessionExecuteResponseData) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionExecuteResponseDataResult struct {
Actions []SessionExecuteResponseDataResultAction `json:"actions" api:"required"`
// Whether the agent finished its task
Completed bool `json:"completed" api:"required"`
// Summary of what the agent accomplished
Message string `json:"message" api:"required"`
// Whether the agent completed successfully
Success bool `json:"success" api:"required"`
Metadata map[string]any `json:"metadata"`
Usage SessionExecuteResponseDataResultUsage `json:"usage"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Actions respjson.Field
Completed respjson.Field
Message respjson.Field
Success respjson.Field
Metadata respjson.Field
Usage respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionExecuteResponseDataResult) RawJSON() string { return r.JSON.raw }
func (r *SessionExecuteResponseDataResult) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionExecuteResponseDataResultAction struct {
// Type of action taken
Type string `json:"type" api:"required"`
Action string `json:"action"`
Instruction string `json:"instruction"`
PageText string `json:"pageText"`
PageURL string `json:"pageUrl"`
// Agent's reasoning for taking this action
Reasoning string `json:"reasoning"`
TaskCompleted bool `json:"taskCompleted"`
// Time taken for this action in ms
TimeMs float64 `json:"timeMs"`
ExtraFields map[string]any `json:"" api:"extrafields"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Type respjson.Field
Action respjson.Field
Instruction respjson.Field
PageText respjson.Field
PageURL respjson.Field
Reasoning respjson.Field
TaskCompleted respjson.Field
TimeMs respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionExecuteResponseDataResultAction) RawJSON() string { return r.JSON.raw }
func (r *SessionExecuteResponseDataResultAction) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionExecuteResponseDataResultUsage struct {
InferenceTimeMs float64 `json:"inference_time_ms" api:"required"`
InputTokens float64 `json:"input_tokens" api:"required"`
OutputTokens float64 `json:"output_tokens" api:"required"`
CachedInputTokens float64 `json:"cached_input_tokens"`
ReasoningTokens float64 `json:"reasoning_tokens"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
InferenceTimeMs respjson.Field
InputTokens respjson.Field
OutputTokens respjson.Field
CachedInputTokens respjson.Field
ReasoningTokens respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionExecuteResponseDataResultUsage) RawJSON() string { return r.JSON.raw }
func (r *SessionExecuteResponseDataResultUsage) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionExecuteResponseDataCacheEntry struct {
// Opaque cache identifier computed from instruction, URL, options, and config
CacheKey string `json:"cacheKey" api:"required"`
// Serialized cache entry that can be written to disk
Entry any `json:"entry" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
CacheKey respjson.Field
Entry respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionExecuteResponseDataCacheEntry) RawJSON() string { return r.JSON.raw }
func (r *SessionExecuteResponseDataCacheEntry) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionExtractResponse struct {
Data SessionExtractResponseData `json:"data" api:"required"`
// Indicates whether the request was successful
Success bool `json:"success" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Data respjson.Field
Success respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionExtractResponse) RawJSON() string { return r.JSON.raw }
func (r *SessionExtractResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionExtractResponseData struct {
// Extracted data matching the requested schema
Result any `json:"result" api:"required"`
// Action ID for tracking
ActionID string `json:"actionId"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Result respjson.Field
ActionID respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionExtractResponseData) RawJSON() string { return r.JSON.raw }
func (r *SessionExtractResponseData) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionNavigateResponse struct {
Data SessionNavigateResponseData `json:"data" api:"required"`
// Indicates whether the request was successful
Success bool `json:"success" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Data respjson.Field
Success respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionNavigateResponse) RawJSON() string { return r.JSON.raw }
func (r *SessionNavigateResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionNavigateResponseData struct {
// Navigation response (Playwright Response object or null)
Result any `json:"result" api:"required"`
// Action ID for tracking
ActionID string `json:"actionId"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Result respjson.Field
ActionID respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionNavigateResponseData) RawJSON() string { return r.JSON.raw }
func (r *SessionNavigateResponseData) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionObserveResponse struct {
Data SessionObserveResponseData `json:"data" api:"required"`
// Indicates whether the request was successful
Success bool `json:"success" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Data respjson.Field
Success respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionObserveResponse) RawJSON() string { return r.JSON.raw }
func (r *SessionObserveResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionObserveResponseData struct {
Result []SessionObserveResponseDataResult `json:"result" api:"required"`
// Action ID for tracking
ActionID string `json:"actionId"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Result respjson.Field
ActionID respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionObserveResponseData) RawJSON() string { return r.JSON.raw }
func (r *SessionObserveResponseData) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Action object returned by observe and used by act
type SessionObserveResponseDataResult struct {
// Human-readable description of the action
Description string `json:"description" api:"required"`
// CSS selector or XPath for the element
Selector string `json:"selector" api:"required"`
// Arguments to pass to the method
Arguments []string `json:"arguments"`
// Backend node ID for the element
BackendNodeID float64 `json:"backendNodeId"`
// The method to execute (click, fill, etc.)
Method string `json:"method"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Description respjson.Field
Selector respjson.Field
Arguments respjson.Field
BackendNodeID respjson.Field
Method respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionObserveResponseDataResult) RawJSON() string { return r.JSON.raw }
func (r *SessionObserveResponseDataResult) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionReplayResponse struct {
Data SessionReplayResponseData `json:"data" api:"required"`
// Indicates whether the request was successful
Success bool `json:"success" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Data respjson.Field
Success respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionReplayResponse) RawJSON() string { return r.JSON.raw }
func (r *SessionReplayResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionReplayResponseData struct {
Pages []SessionReplayResponseDataPage `json:"pages" api:"required"`
ClientLanguage string `json:"clientLanguage"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Pages respjson.Field
ClientLanguage respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionReplayResponseData) RawJSON() string { return r.JSON.raw }
func (r *SessionReplayResponseData) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionReplayResponseDataPage struct {
Actions []SessionReplayResponseDataPageAction `json:"actions" api:"required"`
Duration float64 `json:"duration" api:"required"`
Timestamp float64 `json:"timestamp" api:"required"`
URL string `json:"url" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Actions respjson.Field
Duration respjson.Field
Timestamp respjson.Field
URL respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionReplayResponseDataPage) RawJSON() string { return r.JSON.raw }
func (r *SessionReplayResponseDataPage) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionReplayResponseDataPageAction struct {
Method string `json:"method" api:"required"`
Parameters map[string]any `json:"parameters" api:"required"`
Result map[string]any `json:"result" api:"required"`
Timestamp float64 `json:"timestamp" api:"required"`
EndTime float64 `json:"endTime"`
TokenUsage SessionReplayResponseDataPageActionTokenUsage `json:"tokenUsage"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Method respjson.Field
Parameters respjson.Field
Result respjson.Field
Timestamp respjson.Field
EndTime respjson.Field
TokenUsage respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionReplayResponseDataPageAction) RawJSON() string { return r.JSON.raw }
func (r *SessionReplayResponseDataPageAction) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionReplayResponseDataPageActionTokenUsage struct {
Cost float64 `json:"cost"`
InputTokens float64 `json:"inputTokens"`
OutputTokens float64 `json:"outputTokens"`
TimeMs float64 `json:"timeMs"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Cost respjson.Field
InputTokens respjson.Field
OutputTokens respjson.Field
TimeMs respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionReplayResponseDataPageActionTokenUsage) RawJSON() string { return r.JSON.raw }
func (r *SessionReplayResponseDataPageActionTokenUsage) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionStartResponse struct {
Data SessionStartResponseData `json:"data" api:"required"`
// Indicates whether the request was successful
Success bool `json:"success" api:"required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Data respjson.Field
Success respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionStartResponse) RawJSON() string { return r.JSON.raw }
func (r *SessionStartResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionStartResponseData struct {
Available bool `json:"available" api:"required"`
// Unique Browserbase session identifier
SessionID string `json:"sessionId" api:"required"`
// CDP WebSocket URL for connecting to the Browserbase cloud browser (present when
// available)
CdpURL string `json:"cdpUrl" api:"nullable"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Available respjson.Field
SessionID respjson.Field
CdpURL respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r SessionStartResponseData) RawJSON() string { return r.JSON.raw }
func (r *SessionStartResponseData) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
type SessionActParams struct {
// Natural language instruction or Action object
Input SessionActParamsInputUnion `json:"input,omitzero" api:"required"`
// Target frame ID for the action
FrameID param.Opt[string] `json:"frameId,omitzero"`
Options SessionActParamsOptions `json:"options,omitzero"`
// Whether to stream the response via SSE
//
// Any of "true", "false".
XStreamResponse SessionActParamsXStreamResponse `header:"x-stream-response,omitzero" json:"-"`
paramObj
}
func (r SessionActParams) MarshalJSON() (data []byte, err error) {
type shadow SessionActParams
return param.MarshalObject(r, (*shadow)(&r))
}
func (r *SessionActParams) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Only one field can be non-zero.
//
// Use [param.IsOmitted] to confirm if a field is set.
type SessionActParamsInputUnion struct {
OfString param.Opt[string] `json:",omitzero,inline"`
OfAction *ActionParam `json:",omitzero,inline"`
paramUnion
}