diff --git a/src/libs/Browserbase/Generated/Browserbase.BrowserbaseClient.SessionsCreate.g.cs b/src/libs/Browserbase/Generated/Browserbase.BrowserbaseClient.SessionsCreate.g.cs index 1fbfaa1..2796166 100644 --- a/src/libs/Browserbase/Generated/Browserbase.BrowserbaseClient.SessionsCreate.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.BrowserbaseClient.SessionsCreate.g.cs @@ -417,7 +417,7 @@ partial void ProcessSessionsCreateResponseContent( /// Default Value: us-west-2 /// /// - /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/platform/browser/core-features/session-metadata). + /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata). /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. /// The token to cancel the operation with diff --git a/src/libs/Browserbase/Generated/Browserbase.BrowserbaseClient.SessionsGetRecording.g.cs b/src/libs/Browserbase/Generated/Browserbase.BrowserbaseClient.SessionsGetRecording.g.cs new file mode 100644 index 0000000..27199f1 --- /dev/null +++ b/src/libs/Browserbase/Generated/Browserbase.BrowserbaseClient.SessionsGetRecording.g.cs @@ -0,0 +1,381 @@ + +#nullable enable + +namespace Browserbase +{ + public partial class BrowserbaseClient + { + + + private static readonly global::Browserbase.EndPointSecurityRequirement s_SessionsGetRecordingSecurityRequirement0 = + new global::Browserbase.EndPointSecurityRequirement + { + Authorizations = new global::Browserbase.EndPointAuthorizationRequirement[] + { new global::Browserbase.EndPointAuthorizationRequirement + { + Type = "Http", + SchemeId = "HttpBearer", + Location = "Header", + Name = "Bearer", + FriendlyName = "Bearer", + }, + }, + }; + private static readonly global::Browserbase.EndPointSecurityRequirement[] s_SessionsGetRecordingSecurityRequirements = + new global::Browserbase.EndPointSecurityRequirement[] + { s_SessionsGetRecordingSecurityRequirement0, + }; + partial void PrepareSessionsGetRecordingArguments( + global::System.Net.Http.HttpClient httpClient, + ref string id); + partial void PrepareSessionsGetRecordingRequest( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpRequestMessage httpRequestMessage, + string id); + partial void ProcessSessionsGetRecordingResponse( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpResponseMessage httpResponseMessage); + + partial void ProcessSessionsGetRecordingResponseContent( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpResponseMessage httpResponseMessage, + ref string content); + + /// + /// Session Recording + /// + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + public async global::System.Threading.Tasks.Task> SessionsGetRecordingAsync( + string id, + global::Browserbase.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default) + { + PrepareArguments( + client: HttpClient); + PrepareSessionsGetRecordingArguments( + httpClient: HttpClient, + id: ref id); + + + var __authorizations = global::Browserbase.EndPointSecurityResolver.ResolveAuthorizations( + availableAuthorizations: Authorizations, + securityRequirements: s_SessionsGetRecordingSecurityRequirements, + operationName: "SessionsGetRecordingAsync"); + + using var __timeoutCancellationTokenSource = global::Browserbase.AutoSDKRequestOptionsSupport.CreateTimeoutCancellationTokenSource( + clientOptions: Options, + requestOptions: requestOptions, + cancellationToken: cancellationToken); + var __effectiveCancellationToken = __timeoutCancellationTokenSource?.Token ?? cancellationToken; + var __effectiveReadResponseAsString = global::Browserbase.AutoSDKRequestOptionsSupport.GetReadResponseAsString( + clientOptions: Options, + requestOptions: requestOptions, + fallbackValue: ReadResponseAsString); + var __maxAttempts = global::Browserbase.AutoSDKRequestOptionsSupport.GetMaxAttempts( + clientOptions: Options, + requestOptions: requestOptions, + supportsRetry: true); + + global::System.Net.Http.HttpRequestMessage __CreateHttpRequest() + { + var __pathBuilder = new global::Browserbase.PathBuilder( + path: $"/v1/sessions/{id}/recording", + baseUri: HttpClient.BaseAddress); + var __path = __pathBuilder.ToString(); + __path = global::Browserbase.AutoSDKRequestOptionsSupport.AppendQueryParameters( + path: __path, + clientParameters: Options.QueryParameters, + requestParameters: requestOptions?.QueryParameters); + var __httpRequest = new global::System.Net.Http.HttpRequestMessage( + method: global::System.Net.Http.HttpMethod.Get, + requestUri: new global::System.Uri(__path, global::System.UriKind.RelativeOrAbsolute)); +#if NET6_0_OR_GREATER + __httpRequest.Version = global::System.Net.HttpVersion.Version11; + __httpRequest.VersionPolicy = global::System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher; +#endif + + foreach (var __authorization in __authorizations) + { + if (__authorization.Type == "Http" || + __authorization.Type == "OAuth2" || + __authorization.Type == "OpenIdConnect") + { + __httpRequest.Headers.Authorization = new global::System.Net.Http.Headers.AuthenticationHeaderValue( + scheme: __authorization.Name, + parameter: __authorization.Value); + } + else if (__authorization.Type == "ApiKey" && + __authorization.Location == "Header") + { + __httpRequest.Headers.Add(__authorization.Name, __authorization.Value); + } + } + global::Browserbase.AutoSDKRequestOptionsSupport.ApplyHeaders( + request: __httpRequest, + clientHeaders: Options.Headers, + requestHeaders: requestOptions?.Headers); + + PrepareRequest( + client: HttpClient, + request: __httpRequest); + PrepareSessionsGetRecordingRequest( + httpClient: HttpClient, + httpRequestMessage: __httpRequest, + id: id); + + return __httpRequest; + } + + global::System.Net.Http.HttpRequestMessage? __httpRequest = null; + global::System.Net.Http.HttpResponseMessage? __response = null; + var __attemptNumber = 0; + try + { + for (var __attempt = 1; __attempt <= __maxAttempts; __attempt++) + { + __attemptNumber = __attempt; + __httpRequest = __CreateHttpRequest(); + await global::Browserbase.AutoSDKRequestOptionsSupport.OnBeforeRequestAsync( + clientOptions: Options, + context: global::Browserbase.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "SessionsGetRecording", + methodName: "SessionsGetRecordingAsync", + pathTemplate: "$\"/v1/sessions/{id}/recording\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest!, + response: null, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: false, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + try + { + __response = await HttpClient.SendAsync( + request: __httpRequest, + completionOption: global::System.Net.Http.HttpCompletionOption.ResponseContentRead, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + } + catch (global::System.Net.Http.HttpRequestException __exception) + { + var __willRetry = __attempt < __maxAttempts && !__effectiveCancellationToken.IsCancellationRequested; + await global::Browserbase.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Browserbase.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "SessionsGetRecording", + methodName: "SessionsGetRecordingAsync", + pathTemplate: "$\"/v1/sessions/{id}/recording\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest!, + response: null, + exception: __exception, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: __willRetry, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + if (!__willRetry) + { + throw; + } + + __httpRequest.Dispose(); + __httpRequest = null; + await global::Browserbase.AutoSDKRequestOptionsSupport.DelayBeforeRetryAsync( + clientOptions: Options, + requestOptions: requestOptions, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + continue; + } + + if (__response != null && + __attempt < __maxAttempts && + global::Browserbase.AutoSDKRequestOptionsSupport.ShouldRetryStatusCode(__response.StatusCode)) + { + await global::Browserbase.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Browserbase.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "SessionsGetRecording", + methodName: "SessionsGetRecordingAsync", + pathTemplate: "$\"/v1/sessions/{id}/recording\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest!, + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: true, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + __response.Dispose(); + __response = null; + __httpRequest.Dispose(); + __httpRequest = null; + await global::Browserbase.AutoSDKRequestOptionsSupport.DelayBeforeRetryAsync( + clientOptions: Options, + requestOptions: requestOptions, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + continue; + } + + break; + } + + if (__response == null) + { + throw new global::System.InvalidOperationException("No response received."); + } + + using (__response) + { + + ProcessResponse( + client: HttpClient, + response: __response); + ProcessSessionsGetRecordingResponse( + httpClient: HttpClient, + httpResponseMessage: __response); + if (__response.IsSuccessStatusCode) + { + await global::Browserbase.AutoSDKRequestOptionsSupport.OnAfterSuccessAsync( + clientOptions: Options, + context: global::Browserbase.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "SessionsGetRecording", + methodName: "SessionsGetRecordingAsync", + pathTemplate: "$\"/v1/sessions/{id}/recording\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest!, + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attemptNumber, + maxAttempts: __maxAttempts, + willRetry: false, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + } + else + { + await global::Browserbase.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Browserbase.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "SessionsGetRecording", + methodName: "SessionsGetRecordingAsync", + pathTemplate: "$\"/v1/sessions/{id}/recording\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest!, + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attemptNumber, + maxAttempts: __maxAttempts, + willRetry: false, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + } + + if (__effectiveReadResponseAsString) + { + var __content = await __response.Content.ReadAsStringAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + + ProcessResponseContent( + client: HttpClient, + response: __response, + content: ref __content); + ProcessSessionsGetRecordingResponseContent( + httpClient: HttpClient, + httpResponseMessage: __response, + content: ref __content); + + try + { + __response.EnsureSuccessStatusCode(); + + return + (global::System.Collections.Generic.IList?)global::System.Text.Json.JsonSerializer.Deserialize(__content, typeof(global::System.Collections.Generic.IList), JsonSerializerContext) ?? + throw new global::System.InvalidOperationException($"Response deserialization failed for \"{__content}\" "); + } + catch (global::System.Exception __ex) + { + throw new global::Browserbase.ApiException( + message: __content ?? __response.ReasonPhrase ?? string.Empty, + innerException: __ex, + statusCode: __response.StatusCode) + { + ResponseBody = __content, + ResponseHeaders = global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value), + }; + } + } + else + { + try + { + __response.EnsureSuccessStatusCode(); + using var __content = await __response.Content.ReadAsStreamAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + + return + (global::System.Collections.Generic.IList?)await global::System.Text.Json.JsonSerializer.DeserializeAsync(__content, typeof(global::System.Collections.Generic.IList), JsonSerializerContext).ConfigureAwait(false) ?? + throw new global::System.InvalidOperationException("Response deserialization failed."); + } + catch (global::System.Exception __ex) + { + string? __content = null; + try + { + __content = await __response.Content.ReadAsStringAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + } + catch (global::System.Exception) + { + } + + throw new global::Browserbase.ApiException( + message: __content ?? __response.ReasonPhrase ?? string.Empty, + innerException: __ex, + statusCode: __response.StatusCode) + { + ResponseBody = __content, + ResponseHeaders = global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value), + }; + } + } + + } + } + finally + { + __httpRequest?.Dispose(); + } + } + } +} \ No newline at end of file diff --git a/src/libs/Browserbase/Generated/Browserbase.IBrowserbaseClient.SessionsCreate.g.cs b/src/libs/Browserbase/Generated/Browserbase.IBrowserbaseClient.SessionsCreate.g.cs index 3966fd5..bc8ac8e 100644 --- a/src/libs/Browserbase/Generated/Browserbase.IBrowserbaseClient.SessionsCreate.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.IBrowserbaseClient.SessionsCreate.g.cs @@ -47,7 +47,7 @@ public partial interface IBrowserbaseClient /// Default Value: us-west-2 /// /// - /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/platform/browser/core-features/session-metadata). + /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata). /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. /// The token to cancel the operation with diff --git a/src/libs/Browserbase/Generated/Browserbase.IBrowserbaseClient.SessionsGetRecording.g.cs b/src/libs/Browserbase/Generated/Browserbase.IBrowserbaseClient.SessionsGetRecording.g.cs new file mode 100644 index 0000000..ff85094 --- /dev/null +++ b/src/libs/Browserbase/Generated/Browserbase.IBrowserbaseClient.SessionsGetRecording.g.cs @@ -0,0 +1,19 @@ +#nullable enable + +namespace Browserbase +{ + public partial interface IBrowserbaseClient + { + /// + /// Session Recording + /// + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + global::System.Threading.Tasks.Task> SessionsGetRecordingAsync( + string id, + global::Browserbase.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default); + } +} \ No newline at end of file diff --git a/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContext.g.cs b/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContext.g.cs index f2afda8..9fc7131 100644 --- a/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContext.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContext.g.cs @@ -139,7 +139,7 @@ namespace Browserbase [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.SessionLog))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.SessionLogRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.SessionLogResponse))] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.SessionReplay))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.SessionRecording))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.ContextsCreateRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.ExtensionsUploadRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(byte[]))] @@ -208,7 +208,7 @@ namespace Browserbase [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.AllOf), TypeInfoPropertyName = "AllOfSessionSessionsGetResponse22")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.SessionsGetResponse2))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.SessionsUploadFileResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List>))] @@ -228,7 +228,7 @@ namespace Browserbase [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] public sealed partial class SourceGenerationContext : global::System.Text.Json.Serialization.JsonSerializerContext { } diff --git a/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContextTypes.g.cs b/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContextTypes.g.cs index eec1579..4fa4028 100644 --- a/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContextTypes.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContextTypes.g.cs @@ -200,7 +200,7 @@ public sealed partial class JsonSerializerContextTypes /// /// /// - public global::Browserbase.SessionReplay? Type43 { get; set; } + public global::Browserbase.SessionRecording? Type43 { get; set; } /// /// /// @@ -476,7 +476,7 @@ public sealed partial class JsonSerializerContextTypes /// /// /// - public global::System.Collections.Generic.IList? Type112 { get; set; } + public global::System.Collections.Generic.IList? Type112 { get; set; } /// /// /// @@ -557,6 +557,6 @@ public sealed partial class JsonSerializerContextTypes /// /// /// - public global::System.Collections.Generic.List? ListType18 { get; set; } + public global::System.Collections.Generic.List? ListType18 { get; set; } } } \ No newline at end of file diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.FunctionBuildsGetLogsResponse.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.FunctionBuildsGetLogsResponse.g.cs index 615dee5..50d9521 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.FunctionBuildsGetLogsResponse.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.FunctionBuildsGetLogsResponse.g.cs @@ -20,7 +20,7 @@ public sealed partial class FunctionBuildsGetLogsResponse /// [global::System.Text.Json.Serialization.JsonPropertyName("total")] [global::System.Text.Json.Serialization.JsonRequired] - public required double Total { get; set; } + public required int Total { get; set; } /// /// Additional properties that are not explicitly defined in the schema @@ -38,7 +38,7 @@ public sealed partial class FunctionBuildsGetLogsResponse #endif public FunctionBuildsGetLogsResponse( global::System.Collections.Generic.IList logs, - double total) + int total) { this.Logs = logs ?? throw new global::System.ArgumentNullException(nameof(logs)); this.Total = total; diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParams.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParams.g.cs index bc16284..d228199 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParams.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParams.g.cs @@ -20,12 +20,6 @@ public sealed partial class FunctionsInvokeRequestSessionCreateParams [global::System.Text.Json.Serialization.JsonPropertyName("browserSettings")] public global::Browserbase.FunctionsInvokeRequestSessionCreateParamsBrowserSettings? BrowserSettings { get; set; } - /// - /// Duration in seconds after which the session will automatically end. Defaults to the Project's `defaultTimeout`. - /// - [global::System.Text.Json.Serialization.JsonPropertyName("timeout")] - public int? Timeout { get; set; } - /// /// Proxy configuration. Can be true for default proxy, or an array of proxy configurations. /// @@ -40,11 +34,18 @@ public sealed partial class FunctionsInvokeRequestSessionCreateParams public global::Browserbase.FunctionsInvokeRequestSessionCreateParamsProxySettings? ProxySettings { get; set; } /// - /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/platform/browser/core-features/session-metadata). + /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata). /// [global::System.Text.Json.Serialization.JsonPropertyName("userMetadata")] public object? UserMetadata { get; set; } + /// + /// Duration in seconds after which the function invocation will automatically end. Defaults to 900 (15 minutes).
+ /// Default Value: 900 + /// + [global::System.Text.Json.Serialization.JsonPropertyName("timeout")] + public int? Timeout { get; set; } + /// /// Additional properties that are not explicitly defined in the schema /// @@ -58,9 +59,6 @@ public sealed partial class FunctionsInvokeRequestSessionCreateParams /// The uploaded Extension ID. See [Upload Extension](/reference/api/upload-an-extension). /// /// - /// - /// Duration in seconds after which the session will automatically end. Defaults to the Project's `defaultTimeout`. - /// /// /// Proxy configuration. Can be true for default proxy, or an array of proxy configurations. /// @@ -68,7 +66,11 @@ public sealed partial class FunctionsInvokeRequestSessionCreateParams /// [NOT IN DOCS] Supplementary proxy settings. Optional. /// /// - /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/platform/browser/core-features/session-metadata). + /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata). + /// + /// + /// Duration in seconds after which the function invocation will automatically end. Defaults to 900 (15 minutes).
+ /// Default Value: 900 /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] @@ -76,17 +78,17 @@ public sealed partial class FunctionsInvokeRequestSessionCreateParams public FunctionsInvokeRequestSessionCreateParams( string? extensionId, global::Browserbase.FunctionsInvokeRequestSessionCreateParamsBrowserSettings? browserSettings, - int? timeout, global::Browserbase.AnyOf>, bool?>? proxies, global::Browserbase.FunctionsInvokeRequestSessionCreateParamsProxySettings? proxySettings, - object? userMetadata) + object? userMetadata, + int? timeout) { this.ExtensionId = extensionId; this.BrowserSettings = browserSettings; - this.Timeout = timeout; this.Proxies = proxies; this.ProxySettings = proxySettings; this.UserMetadata = userMetadata; + this.Timeout = timeout; } /// diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParamsBrowserSettings.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParamsBrowserSettings.g.cs index 3701c2c..70a1816 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParamsBrowserSettings.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParamsBrowserSettings.g.cs @@ -115,6 +115,12 @@ public sealed partial class FunctionsInvokeRequestSessionCreateParamsBrowserSett [global::System.Text.Json.Serialization.JsonPropertyName("allowedDomains")] public global::System.Collections.Generic.IList? AllowedDomains { get; set; } + /// + /// Enable or disable ignoring of certificate errors in the browser. Defaults to `true`. + /// + [global::System.Text.Json.Serialization.JsonPropertyName("ignoreCertificateErrors")] + public bool? IgnoreCertificateErrors { get; set; } + /// /// Additional properties that are not explicitly defined in the schema /// @@ -174,6 +180,9 @@ public sealed partial class FunctionsInvokeRequestSessionCreateParamsBrowserSett /// An optional list of allowed domains for the session. If provided, navigation will be restricted to these domains.
/// Default Value: [] /// + /// + /// Enable or disable ignoring of certificate errors in the browser. Defaults to `true`. + /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] #endif @@ -194,7 +203,8 @@ public FunctionsInvokeRequestSessionCreateParamsBrowserSettings( bool? enableNativeSelectPolyfill, bool? enablePdfViewer, global::System.Collections.Generic.IList? extensions, - global::System.Collections.Generic.IList? allowedDomains) + global::System.Collections.Generic.IList? allowedDomains, + bool? ignoreCertificateErrors) { this.Context = context; this.ExtensionId = extensionId; @@ -213,6 +223,7 @@ public FunctionsInvokeRequestSessionCreateParamsBrowserSettings( this.EnablePdfViewer = enablePdfViewer; this.Extensions = extensions; this.AllowedDomains = allowedDomains; + this.IgnoreCertificateErrors = ignoreCertificateErrors; } /// diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParamsUserMetadata.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParamsUserMetadata.g.cs index dcb4df5..9e3c160 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParamsUserMetadata.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.FunctionsInvokeRequestSessionCreateParamsUserMetadata.g.cs @@ -4,7 +4,7 @@ namespace Browserbase { /// - /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/platform/browser/core-features/session-metadata). + /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata). /// public sealed partial class FunctionsInvokeRequestSessionCreateParamsUserMetadata { diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.InvocationsGetLogsResponse.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.InvocationsGetLogsResponse.g.cs index e67e2d5..ef07d70 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.InvocationsGetLogsResponse.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.InvocationsGetLogsResponse.g.cs @@ -20,7 +20,7 @@ public sealed partial class InvocationsGetLogsResponse /// [global::System.Text.Json.Serialization.JsonPropertyName("total")] [global::System.Text.Json.Serialization.JsonRequired] - public required double Total { get; set; } + public required int Total { get; set; } /// /// Additional properties that are not explicitly defined in the schema @@ -38,7 +38,7 @@ public sealed partial class InvocationsGetLogsResponse #endif public InvocationsGetLogsResponse( global::System.Collections.Generic.IList logs, - double total) + int total) { this.Logs = logs ?? throw new global::System.ArgumentNullException(nameof(logs)); this.Total = total; diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.Session.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.Session.g.cs index e564d06..8e3fa40 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.Session.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.Session.g.cs @@ -93,7 +93,7 @@ public sealed partial class Session public required global::Browserbase.SessionRegion Region { get; set; } /// - /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/platform/browser/core-features/session-metadata). + /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata). /// [global::System.Text.Json.Serialization.JsonPropertyName("userMetadata")] public object? UserMetadata { get; set; } @@ -130,7 +130,7 @@ public sealed partial class Session /// Optional. The Context linked to the Session. /// /// - /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/platform/browser/core-features/session-metadata). + /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata). /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.SessionReplay.Json.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.SessionRecording.Json.g.cs similarity index 88% rename from src/libs/Browserbase/Generated/Browserbase.Models.SessionReplay.Json.g.cs rename to src/libs/Browserbase/Generated/Browserbase.Models.SessionRecording.Json.g.cs index 1d52411..115310e 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.SessionReplay.Json.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.SessionRecording.Json.g.cs @@ -2,7 +2,7 @@ namespace Browserbase { - public sealed partial class SessionReplay + public sealed partial class SessionRecording { /// /// Serializes the current instance to a JSON string using the provided JsonSerializerContext. @@ -34,14 +34,14 @@ public string ToJson( /// /// Deserializes a JSON string using the provided JsonSerializerContext. /// - public static global::Browserbase.SessionReplay? FromJson( + public static global::Browserbase.SessionRecording? FromJson( string json, global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) { return global::System.Text.Json.JsonSerializer.Deserialize( json, - typeof(global::Browserbase.SessionReplay), - jsonSerializerContext) as global::Browserbase.SessionReplay; + typeof(global::Browserbase.SessionRecording), + jsonSerializerContext) as global::Browserbase.SessionRecording; } /// @@ -51,11 +51,11 @@ public string ToJson( [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] #endif - public static global::Browserbase.SessionReplay? FromJson( + public static global::Browserbase.SessionRecording? FromJson( string json, global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) { - return global::System.Text.Json.JsonSerializer.Deserialize( + return global::System.Text.Json.JsonSerializer.Deserialize( json, jsonSerializerOptions); } @@ -63,14 +63,14 @@ public string ToJson( /// /// Deserializes a JSON stream using the provided JsonSerializerContext. /// - public static async global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + public static async global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( global::System.IO.Stream jsonStream, global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) { return (await global::System.Text.Json.JsonSerializer.DeserializeAsync( jsonStream, - typeof(global::Browserbase.SessionReplay), - jsonSerializerContext).ConfigureAwait(false)) as global::Browserbase.SessionReplay; + typeof(global::Browserbase.SessionRecording), + jsonSerializerContext).ConfigureAwait(false)) as global::Browserbase.SessionRecording; } /// @@ -80,11 +80,11 @@ public string ToJson( [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] #endif - public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( global::System.IO.Stream jsonStream, global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) { - return global::System.Text.Json.JsonSerializer.DeserializeAsync( + return global::System.Text.Json.JsonSerializer.DeserializeAsync( jsonStream, jsonSerializerOptions); } diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.SessionReplay.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.SessionRecording.g.cs similarity index 82% rename from src/libs/Browserbase/Generated/Browserbase.Models.SessionReplay.g.cs rename to src/libs/Browserbase/Generated/Browserbase.Models.SessionRecording.g.cs index c8e1c98..3812982 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.SessionReplay.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.SessionRecording.g.cs @@ -4,12 +4,12 @@ namespace Browserbase { /// - /// Deprecated: rrweb-based session recording data. Contact support@browserbase.com if you need to use this. + /// /// - public sealed partial class SessionReplay + public sealed partial class SessionRecording { /// - /// Deprecated. See [rrweb documentation](https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/dive-into-event.md). + /// See [rrweb documentation](https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/dive-into-event.md). /// [global::System.Text.Json.Serialization.JsonPropertyName("data")] [global::System.Text.Json.Serialization.JsonRequired] @@ -43,10 +43,10 @@ public sealed partial class SessionReplay public global::System.Collections.Generic.IDictionary AdditionalProperties { get; set; } = new global::System.Collections.Generic.Dictionary(); /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// - /// Deprecated. See [rrweb documentation](https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/dive-into-event.md). + /// See [rrweb documentation](https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/dive-into-event.md). /// /// /// @@ -56,7 +56,7 @@ public sealed partial class SessionReplay #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] #endif - public SessionReplay( + public SessionRecording( object data, string sessionId, long timestamp, @@ -69,9 +69,9 @@ public SessionReplay( } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - public SessionReplay() + public SessionRecording() { } } diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.SessionReplayData.Json.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.SessionRecordingData.Json.g.cs similarity index 87% rename from src/libs/Browserbase/Generated/Browserbase.Models.SessionReplayData.Json.g.cs rename to src/libs/Browserbase/Generated/Browserbase.Models.SessionRecordingData.Json.g.cs index 1040bca..2985cf5 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.SessionReplayData.Json.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.SessionRecordingData.Json.g.cs @@ -2,7 +2,7 @@ namespace Browserbase { - public sealed partial class SessionReplayData + public sealed partial class SessionRecordingData { /// /// Serializes the current instance to a JSON string using the provided JsonSerializerContext. @@ -34,14 +34,14 @@ public string ToJson( /// /// Deserializes a JSON string using the provided JsonSerializerContext. /// - public static global::Browserbase.SessionReplayData? FromJson( + public static global::Browserbase.SessionRecordingData? FromJson( string json, global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) { return global::System.Text.Json.JsonSerializer.Deserialize( json, - typeof(global::Browserbase.SessionReplayData), - jsonSerializerContext) as global::Browserbase.SessionReplayData; + typeof(global::Browserbase.SessionRecordingData), + jsonSerializerContext) as global::Browserbase.SessionRecordingData; } /// @@ -51,11 +51,11 @@ public string ToJson( [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] #endif - public static global::Browserbase.SessionReplayData? FromJson( + public static global::Browserbase.SessionRecordingData? FromJson( string json, global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) { - return global::System.Text.Json.JsonSerializer.Deserialize( + return global::System.Text.Json.JsonSerializer.Deserialize( json, jsonSerializerOptions); } @@ -63,14 +63,14 @@ public string ToJson( /// /// Deserializes a JSON stream using the provided JsonSerializerContext. /// - public static async global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + public static async global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( global::System.IO.Stream jsonStream, global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) { return (await global::System.Text.Json.JsonSerializer.DeserializeAsync( jsonStream, - typeof(global::Browserbase.SessionReplayData), - jsonSerializerContext).ConfigureAwait(false)) as global::Browserbase.SessionReplayData; + typeof(global::Browserbase.SessionRecordingData), + jsonSerializerContext).ConfigureAwait(false)) as global::Browserbase.SessionRecordingData; } /// @@ -80,11 +80,11 @@ public string ToJson( [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] #endif - public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( global::System.IO.Stream jsonStream, global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) { - return global::System.Text.Json.JsonSerializer.DeserializeAsync( + return global::System.Text.Json.JsonSerializer.DeserializeAsync( jsonStream, jsonSerializerOptions); } diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.SessionReplayData.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.SessionRecordingData.g.cs similarity index 72% rename from src/libs/Browserbase/Generated/Browserbase.Models.SessionReplayData.g.cs rename to src/libs/Browserbase/Generated/Browserbase.Models.SessionRecordingData.g.cs index 728240d..dc10d00 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.SessionReplayData.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.SessionRecordingData.g.cs @@ -4,9 +4,9 @@ namespace Browserbase { /// - /// Deprecated. See [rrweb documentation](https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/dive-into-event.md). + /// See [rrweb documentation](https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/dive-into-event.md). /// - public sealed partial class SessionReplayData + public sealed partial class SessionRecordingData { /// diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.SessionUserMetadata.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.SessionUserMetadata.g.cs index 2e6186b..c0094c8 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.SessionUserMetadata.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.SessionUserMetadata.g.cs @@ -4,7 +4,7 @@ namespace Browserbase { /// - /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/platform/browser/core-features/session-metadata). + /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata). /// public sealed partial class SessionUserMetadata { diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequest.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequest.g.cs index bcb1bd9..69bd940 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequest.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequest.g.cs @@ -54,7 +54,7 @@ public sealed partial class SessionsCreateRequest public global::Browserbase.SessionsCreateRequestRegion? Region { get; set; } /// - /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/platform/browser/core-features/session-metadata). + /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata). /// [global::System.Text.Json.Serialization.JsonPropertyName("userMetadata")] public object? UserMetadata { get; set; } @@ -89,7 +89,7 @@ public sealed partial class SessionsCreateRequest /// Default Value: us-west-2 /// /// - /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/platform/browser/core-features/session-metadata). + /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata). /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequestBrowserSettings.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequestBrowserSettings.g.cs index 08f0d37..433c0b0 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequestBrowserSettings.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequestBrowserSettings.g.cs @@ -81,6 +81,12 @@ public sealed partial class SessionsCreateRequestBrowserSettings [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Browserbase.JsonConverters.SessionsCreateRequestBrowserSettingsOsJsonConverter))] public global::Browserbase.SessionsCreateRequestBrowserSettingsOs? Os { get; set; } + /// + /// Enable or disable ignoring of certificate errors in the browser. Defaults to `true`. + /// + [global::System.Text.Json.Serialization.JsonPropertyName("ignoreCertificateErrors")] + public bool? IgnoreCertificateErrors { get; set; } + /// /// Additional properties that are not explicitly defined in the schema /// @@ -122,6 +128,9 @@ public sealed partial class SessionsCreateRequestBrowserSettings /// /// Operating system for stealth mode. Valid values: windows, mac, linux, mobile, tablet /// + /// + /// Enable or disable ignoring of certificate errors in the browser. Defaults to `true`. + /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] #endif @@ -137,7 +146,8 @@ public SessionsCreateRequestBrowserSettings( bool? verified, string? captchaImageSelector, string? captchaInputSelector, - global::Browserbase.SessionsCreateRequestBrowserSettingsOs? os) + global::Browserbase.SessionsCreateRequestBrowserSettingsOs? os, + bool? ignoreCertificateErrors) { this.Context = context; this.ExtensionId = extensionId; @@ -151,6 +161,7 @@ public SessionsCreateRequestBrowserSettings( this.CaptchaImageSelector = captchaImageSelector; this.CaptchaInputSelector = captchaInputSelector; this.Os = os; + this.IgnoreCertificateErrors = ignoreCertificateErrors; } /// diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequestUserMetadata.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequestUserMetadata.g.cs index 8104a6c..a61c0f4 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequestUserMetadata.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.SessionsCreateRequestUserMetadata.g.cs @@ -4,7 +4,7 @@ namespace Browserbase { /// - /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/platform/browser/core-features/session-metadata). + /// Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata). /// public sealed partial class SessionsCreateRequestUserMetadata { diff --git a/src/libs/Browserbase/openapi.yaml b/src/libs/Browserbase/openapi.yaml index e07b930..8b47e0b 100644 --- a/src/libs/Browserbase/openapi.yaml +++ b/src/libs/Browserbase/openapi.yaml @@ -4,7 +4,7 @@ info: description: Browserbase API for 3rd party developers version: v1 servers: - - url: https://api.browserbase.com + - url: "https://api.browserbase.com" description: Public endpoint variables: {} paths: @@ -19,17 +19,11 @@ paths: type: object properties: projectId: - description: >- - The Project ID. Can be found in - [Settings](https://www.browserbase.com/settings). Optional - - if not provided, the project will be inferred from the API - key. + description: "The Project ID. Can be found in [Settings](https://www.browserbase.com/settings). Optional - if not provided, the project will be inferred from the API key." type: string responses: - '201': - description: >- - The request has succeeded and a new resource has been created as a - result. + "201": + description: The request has succeeded and a new resource has been created as a result. content: application/json: schema: @@ -45,16 +39,10 @@ paths: description: The public key to encrypt the user-data-directory. type: string cipherAlgorithm: - description: >- - The cipher algorithm used to encrypt the - user-data-directory. AES-256-CBC is currently the only - supported algorithm. + description: The cipher algorithm used to encrypt the user-data-directory. AES-256-CBC is currently the only supported algorithm. type: string initializationVectorSize: - description: >- - The initialization vector size used to encrypt the - user-data-directory. [Read more about how to use - it](/features/contexts). + description: "The initialization vector size used to encrypt the user-data-directory. [Read more about how to use it](/features/contexts)." type: integer format: uint8 required: @@ -63,7 +51,7 @@ paths: - publicKey - cipherAlgorithm - initializationVectorSize - /v1/contexts/{id}: + "/v1/contexts/{id}": get: operationId: Contexts_get summary: Get a Context @@ -74,12 +62,12 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: - $ref: '#/components/schemas/Context' + $ref: "#/components/schemas/Context" put: operationId: Contexts_update summary: Update a Context @@ -90,7 +78,7 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -107,16 +95,10 @@ paths: description: The public key to encrypt the user-data-directory. type: string cipherAlgorithm: - description: >- - The cipher algorithm used to encrypt the - user-data-directory. AES-256-CBC is currently the only - supported algorithm. + description: The cipher algorithm used to encrypt the user-data-directory. AES-256-CBC is currently the only supported algorithm. type: string initializationVectorSize: - description: >- - The initialization vector size used to encrypt the - user-data-directory. [Read more about how to use - it](/features/contexts). + description: "The initialization vector size used to encrypt the user-data-directory. [Read more about how to use it](/features/contexts)." type: integer format: uint8 required: @@ -135,10 +117,8 @@ paths: schema: type: string responses: - '204': - description: >- - There is no content to send for this request, but the headers may be - useful. + "204": + description: "There is no content to send for this request, but the headers may be useful." /v1/downloads: get: operationId: Downloads_list @@ -211,7 +191,7 @@ paths: default: 0 minimum: 0 responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -265,13 +245,11 @@ paths: - total - limit - offset - /v1/downloads/{id}: + "/v1/downloads/{id}": get: operationId: Downloads_get summary: Get a Download - description: >- - Get download metadata (Accept: application/json) or file content - (Accept: application/octet-stream). + description: "Get download metadata (Accept: application/json) or file content (Accept: application/octet-stream)." parameters: - name: id in: path @@ -280,7 +258,7 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -333,7 +311,7 @@ paths: schema: type: string responses: - '204': + "204": description: There is no content to send for this request. /v1/extensions: post: @@ -352,13 +330,13 @@ paths: required: - file responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: - $ref: '#/components/schemas/Extension' - /v1/extensions/{id}: + $ref: "#/components/schemas/Extension" + "/v1/extensions/{id}": get: operationId: Extensions_get summary: Get an Extension @@ -369,12 +347,12 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: - $ref: '#/components/schemas/Extension' + $ref: "#/components/schemas/Extension" delete: operationId: Extensions_delete summary: Delete an Extension @@ -385,15 +363,13 @@ paths: schema: type: string responses: - '204': - description: >- - There is no content to send for this request, but the headers may be - useful. + "204": + description: "There is no content to send for this request, but the headers may be useful." /v1/fetch: post: operationId: Fetch_create summary: Fetch a Page - description: Fetch a page and return its content, headers, and metadata. + description: "Fetch a page and return its content, headers, and metadata." requestBody: required: true content: @@ -420,7 +396,7 @@ paths: required: - url responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -454,7 +430,7 @@ paths: - content - contentType - encoding - '400': + "400": description: Invalid request body. content: application/json: @@ -477,7 +453,7 @@ paths: - statusCode - error - message - '429': + "429": description: Concurrent fetch request limit exceeded. content: application/json: @@ -500,10 +476,8 @@ paths: - statusCode - error - message - '502': - description: >- - The fetched response was too large or TLS certificate verification - failed. + "502": + description: The fetched response was too large or TLS certificate verification failed. content: application/json: schema: @@ -526,7 +500,7 @@ paths: - error - message - id - '504': + "504": description: The fetch request timed out. content: application/json: @@ -571,7 +545,7 @@ paths: maximum: 100 minimum: 1 responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -581,7 +555,7 @@ paths: data: type: array items: - $ref: '#/components/schemas/Function' + $ref: "#/components/schemas/Function" total: type: integer minimum: 0 @@ -614,7 +588,7 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -624,14 +598,14 @@ paths: data: type: array items: - $ref: '#/components/schemas/FunctionBuild' + $ref: "#/components/schemas/FunctionBuild" total: type: integer minimum: 0 required: - data - total - /v1/functions/builds/{id}: + "/v1/functions/builds/{id}": get: operationId: FunctionBuilds_get summary: Get a Function Build @@ -643,13 +617,13 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: - $ref: '#/components/schemas/FunctionBuild' - /v1/functions/builds/{id}/logs: + $ref: "#/components/schemas/FunctionBuild" + "/v1/functions/builds/{id}/logs": get: operationId: FunctionBuilds_getLogs summary: Get Function Build Logs @@ -661,7 +635,7 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -671,13 +645,14 @@ paths: logs: type: array items: - $ref: '#/components/schemas/FunctionBuildLog' + $ref: "#/components/schemas/FunctionBuildLog" total: - type: number + type: integer + minimum: 0 required: - logs - total - /v1/functions/invocations/{id}: + "/v1/functions/invocations/{id}": get: operationId: Invocations_get summary: Get an Invocation @@ -689,13 +664,13 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: allOf: - - $ref: '#/components/schemas/Invocation' + - $ref: "#/components/schemas/Invocation" - type: object properties: cause: @@ -712,7 +687,7 @@ paths: minLength: 1 required: - code - /v1/functions/invocations/{id}/logs: + "/v1/functions/invocations/{id}/logs": get: operationId: Invocations_getLogs summary: Get Invocation Logs @@ -724,7 +699,7 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -734,13 +709,14 @@ paths: logs: type: array items: - $ref: '#/components/schemas/InvocationLog' + $ref: "#/components/schemas/InvocationLog" total: - type: number + type: integer + minimum: 0 required: - logs - total - /v1/functions/versions/{id}: + "/v1/functions/versions/{id}": get: operationId: FunctionVersions_get summary: Get a Function Version @@ -752,13 +728,13 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: - $ref: '#/components/schemas/FunctionVersion' - /v1/functions/versions/{id}/invocations: + $ref: "#/components/schemas/FunctionVersion" + "/v1/functions/versions/{id}/invocations": get: operationId: FunctionVersions_listInvocations summary: List Invocations for a Function Version @@ -790,7 +766,7 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -800,14 +776,14 @@ paths: results: type: array items: - $ref: '#/components/schemas/Invocation' + $ref: "#/components/schemas/Invocation" total: type: integer minimum: 0 required: - results - total - /v1/functions/{id}: + "/v1/functions/{id}": get: operationId: Functions_get summary: Get a Function @@ -819,13 +795,13 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: - $ref: '#/components/schemas/Function' - /v1/functions/{id}/invoke: + $ref: "#/components/schemas/Function" + "/v1/functions/{id}/invoke": post: operationId: Functions_invoke summary: Invoke a Function @@ -851,9 +827,7 @@ paths: type: object properties: extensionId: - description: >- - The uploaded Extension ID. See [Upload - Extension](/reference/api/upload-an-extension). + description: "The uploaded Extension ID. See [Upload Extension](/reference/api/upload-an-extension)." type: string browserSettings: type: object @@ -865,16 +839,12 @@ paths: description: The Context ID. type: string persist: - description: >- - Whether or not to persist the context after - browsing. Defaults to `false`. + description: Whether or not to persist the context after browsing. Defaults to `false`. type: boolean required: - id extensionId: - description: >- - The uploaded Extension ID. See [Upload - Extension](/reference/api/upload-an-extension). + description: "The uploaded Extension ID. See [Upload Extension](/reference/api/upload-an-extension)." type: string viewport: type: object @@ -886,24 +856,16 @@ paths: description: The height of the browser. type: integer blockAds: - description: >- - Enable or disable ad blocking in the browser. - Defaults to `false`. + description: Enable or disable ad blocking in the browser. Defaults to `false`. type: boolean solveCaptchas: - description: >- - Enable or disable captcha solving in the browser. - Defaults to `true`. + description: Enable or disable captcha solving in the browser. Defaults to `true`. type: boolean recordSession: - description: >- - Enable or disable session recording. Defaults to - `true`. + description: Enable or disable session recording. Defaults to `true`. type: boolean logSession: - description: >- - Enable or disable session logging. Defaults to - `true`. + description: Enable or disable session logging. Defaults to `true`. type: boolean advancedStealth: description: Advanced Browser Stealth Mode @@ -912,21 +874,13 @@ paths: description: Verified Browser Mode type: boolean captchaImageSelector: - description: >- - Custom selector for captcha image. See [Custom - Captcha - Solving](/features/stealth-mode#custom-captcha-solving) + description: "Custom selector for captcha image. See [Custom Captcha Solving](/features/stealth-mode#custom-captcha-solving)" type: string captchaInputSelector: - description: >- - Custom selector for captcha input. See [Custom - Captcha - Solving](/features/stealth-mode#custom-captcha-solving) + description: "Custom selector for captcha input. See [Custom Captcha Solving](/features/stealth-mode#custom-captcha-solving)" type: string os: - description: >- - Operating system for stealth mode. Valid values: - windows, mac, linux, mobile, tablet + description: "Operating system for stealth mode. Valid values: windows, mac, linux, mobile, tablet" type: string enum: - windows @@ -935,7 +889,7 @@ paths: - mobile - tablet size: - description: '[NOT IN DOCS] Resource size of the browser.' + description: "[NOT IN DOCS] Resource size of the browser." type: string default: small enum: @@ -943,21 +897,13 @@ paths: - medium - large enableNativeSelectPolyfill: - description: >- - [NOT IN DOCS] Enable native select polyfill. This - gives support a break-glass option to disable the - polyfill. + description: "[NOT IN DOCS] Enable native select polyfill. This gives support a break-glass option to disable the polyfill." type: boolean enablePdfViewer: - description: >- - [NOT IN DOCS] Enable PDF viewer. This gives support - a break-glass option to enable the viewer when users - want to view PDFs in-browser. + description: "[NOT IN DOCS] Enable PDF viewer. This gives support a break-glass option to enable the viewer when users want to view PDFs in-browser." type: boolean extensions: - description: >- - [NOT IN DOCS] List of pre-installed extension names - and custom extension ids to enable on the browser + description: "[NOT IN DOCS] List of pre-installed extension names and custom extension ids to enable on the browser" type: array items: type: string @@ -966,68 +912,57 @@ paths: - browser-events default: [] allowedDomains: - description: >- - An optional list of allowed domains for the session. - If provided, navigation will be restricted to these - domains. + description: "An optional list of allowed domains for the session. If provided, navigation will be restricted to these domains." type: array items: type: string default: [] - timeout: - description: >- - Duration in seconds after which the session will - automatically end. Defaults to the Project's - `defaultTimeout`. - type: integer - maximum: 21600 - minimum: 60 + ignoreCertificateErrors: + description: Enable or disable ignoring of certificate errors in the browser. Defaults to `true`. + type: boolean proxies: - description: >- - Proxy configuration. Can be true for default proxy, or - an array of proxy configurations. + description: "Proxy configuration. Can be true for default proxy, or an array of proxy configurations." anyOf: - type: array items: anyOf: - - $ref: '#/components/schemas/BrowserbaseProxyConfig' - - $ref: '#/components/schemas/ExternalProxyConfig' - - $ref: '#/components/schemas/NoneProxyConfig' + - $ref: "#/components/schemas/BrowserbaseProxyConfig" + - $ref: "#/components/schemas/ExternalProxyConfig" + - $ref: "#/components/schemas/NoneProxyConfig" - type: boolean proxySettings: - description: '[NOT IN DOCS] Supplementary proxy settings. Optional.' + description: "[NOT IN DOCS] Supplementary proxy settings. Optional." type: object properties: caCertificates: - description: >- - [NOT IN DOCS] The TLS certificate IDs to trust. - Optional. + description: "[NOT IN DOCS] The TLS certificate IDs to trust. Optional." type: array items: format: uuid - description: '[NOT IN DOCS] The TLS certificate ID to trust.' + description: "[NOT IN DOCS] The TLS certificate ID to trust." type: string default: [] required: - caCertificates userMetadata: - description: >- - Arbitrary user metadata to attach to the session. To - learn more about user metadata, see [User - Metadata](/platform/browser/core-features/session-metadata). + description: "Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata)." type: object additionalProperties: true properties: {} + timeout: + description: Duration in seconds after which the function invocation will automatically end. Defaults to 900 (15 minutes). + type: integer + default: 900 + maximum: 900 + minimum: 60 responses: - '202': - description: >- - The request has been accepted for processing, but processing has not - yet completed. + "202": + description: "The request has been accepted for processing, but processing has not yet completed." content: application/json: schema: - $ref: '#/components/schemas/Invocation' - /v1/functions/{id}/versions: + $ref: "#/components/schemas/Invocation" + "/v1/functions/{id}/versions": get: operationId: Functions_listVersions summary: List Function Versions @@ -1054,7 +989,7 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -1064,7 +999,7 @@ paths: results: type: array items: - $ref: '#/components/schemas/FunctionVersion' + $ref: "#/components/schemas/FunctionVersion" total: type: integer minimum: 0 @@ -1076,15 +1011,15 @@ paths: operationId: Projects_list summary: List Projects responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: type: array items: - $ref: '#/components/schemas/Project' - /v1/projects/{id}: + $ref: "#/components/schemas/Project" + "/v1/projects/{id}": get: operationId: Projects_get summary: Get a Project @@ -1095,13 +1030,13 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: - $ref: '#/components/schemas/Project' - /v1/projects/{id}/usage: + $ref: "#/components/schemas/Project" + "/v1/projects/{id}/usage": get: operationId: Projects_usage summary: Get Project Usage @@ -1112,12 +1047,12 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: - $ref: '#/components/schemas/ProjectUsage' + $ref: "#/components/schemas/ProjectUsage" /v1/search: post: operationId: Search_web @@ -1144,7 +1079,7 @@ paths: required: - query responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -1211,22 +1146,19 @@ paths: - COMPLETED - name: q in: query - description: >- - Query sessions by user metadata. See [Querying Sessions by User - Metadata](/platform/browser/core-features/session-metadata#query-sessions-by-metadata) - for the schema of this query. + description: "Query sessions by user metadata. See [Querying Sessions by User Metadata](/features/sessions#querying-sessions-by-user-metadata) for the schema of this query." required: false schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: type: array items: - $ref: '#/components/schemas/Session' + $ref: "#/components/schemas/Session" post: operationId: Sessions_create summary: Create a Session @@ -1237,16 +1169,10 @@ paths: type: object properties: projectId: - description: >- - The Project ID. Can be found in - [Settings](https://www.browserbase.com/settings). Optional - - if not provided, the project will be inferred from the API - key. + description: "The Project ID. Can be found in [Settings](https://www.browserbase.com/settings). Optional - if not provided, the project will be inferred from the API key." type: string extensionId: - description: >- - The uploaded Extension ID. See [Upload - Extension](/reference/api/upload-an-extension). + description: "The uploaded Extension ID. See [Upload Extension](/reference/api/upload-an-extension)." type: string browserSettings: type: object @@ -1258,16 +1184,12 @@ paths: description: The Context ID. type: string persist: - description: >- - Whether or not to persist the context after - browsing. Defaults to `false`. + description: Whether or not to persist the context after browsing. Defaults to `false`. type: boolean required: - id extensionId: - description: >- - The uploaded Extension ID. See [Upload - Extension](/reference/api/upload-an-extension). + description: "The uploaded Extension ID. See [Upload Extension](/reference/api/upload-an-extension)." type: string viewport: type: object @@ -1279,14 +1201,10 @@ paths: description: The height of the browser. type: integer blockAds: - description: >- - Enable or disable ad blocking in the browser. Defaults - to `false`. + description: Enable or disable ad blocking in the browser. Defaults to `false`. type: boolean solveCaptchas: - description: >- - Enable or disable captcha solving in the browser. - Defaults to `true`. + description: Enable or disable captcha solving in the browser. Defaults to `true`. type: boolean recordSession: description: Enable or disable session recording. Defaults to `true`. @@ -1301,19 +1219,13 @@ paths: description: Verified Browser Mode type: boolean captchaImageSelector: - description: >- - Custom selector for captcha image. See [Custom Captcha - Solving](/features/stealth-mode#custom-captcha-solving) + description: "Custom selector for captcha image. See [Custom Captcha Solving](/features/stealth-mode#custom-captcha-solving)" type: string captchaInputSelector: - description: >- - Custom selector for captcha input. See [Custom Captcha - Solving](/features/stealth-mode#custom-captcha-solving) + description: "Custom selector for captcha input. See [Custom Captcha Solving](/features/stealth-mode#custom-captcha-solving)" type: string os: - description: >- - Operating system for stealth mode. Valid values: - windows, mac, linux, mobile, tablet + description: "Operating system for stealth mode. Valid values: windows, mac, linux, mobile, tablet" type: string enum: - windows @@ -1321,30 +1233,26 @@ paths: - linux - mobile - tablet + ignoreCertificateErrors: + description: Enable or disable ignoring of certificate errors in the browser. Defaults to `true`. + type: boolean timeout: - description: >- - Duration in seconds after which the session will - automatically end. Defaults to the Project's - `defaultTimeout`. + description: Duration in seconds after which the session will automatically end. Defaults to the Project's `defaultTimeout`. type: integer maximum: 21600 minimum: 60 keepAlive: - description: >- - Set to true to keep the session alive even after - disconnections. Available on the Hobby Plan and above. + description: Set to true to keep the session alive even after disconnections. Available on the Hobby Plan and above. type: boolean proxies: - description: >- - Proxy configuration. Can be true for default proxy, or an - array of proxy configurations. + description: "Proxy configuration. Can be true for default proxy, or an array of proxy configurations." anyOf: - type: array items: anyOf: - - $ref: '#/components/schemas/BrowserbaseProxyConfig' - - $ref: '#/components/schemas/ExternalProxyConfig' - - $ref: '#/components/schemas/NoneProxyConfig' + - $ref: "#/components/schemas/BrowserbaseProxyConfig" + - $ref: "#/components/schemas/ExternalProxyConfig" + - $ref: "#/components/schemas/NoneProxyConfig" - type: boolean region: description: The region where the Session should run. @@ -1356,23 +1264,18 @@ paths: - eu-central-1 - ap-southeast-1 userMetadata: - description: >- - Arbitrary user metadata to attach to the session. To learn - more about user metadata, see [User - Metadata](/platform/browser/core-features/session-metadata). + description: "Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata)." type: object additionalProperties: true properties: {} responses: - '201': - description: >- - The request has succeeded and a new resource has been created as a - result. + "201": + description: The request has succeeded and a new resource has been created as a result. content: application/json: schema: allOf: - - $ref: '#/components/schemas/Session' + - $ref: "#/components/schemas/Session" - type: object properties: connectUrl: @@ -1384,9 +1287,7 @@ paths: type: string format: uri signingKey: - description: >- - Signing key to use when connecting to the Session via - HTTP. + description: Signing key to use when connecting to the Session via HTTP. type: string required: - connectUrl @@ -1411,21 +1312,17 @@ paths: body: JSON.stringify({}) }) - lang: Python - source: >- + source: |- import requests - url = "https://api.browserbase.com/v1/sessions" - payload = {} - headers = { + + "X-BB-API-Key": "", "Content-Type": "application/json" } - - response = requests.request("POST", url, json=payload, - headers=headers) - + response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: PHP source: |- @@ -1456,14 +1353,15 @@ paths: - lang: Go source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.browserbase.com/v1/sessions\"\n\n\tpayload := strings.NewReader(\"{}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"X-BB-API-Key\", \"\")\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Java - source: >- - HttpResponse response = - Unirest.post("https://api.browserbase.com/v1/sessions") + source: |- + HttpResponse response = Unirest.post("https://api.browserbase.com/v1/sessions") + + .header("X-BB-API-Key", "") .header("Content-Type", "application/json") .body("{}") .asString(); - /v1/sessions/{id}: + "/v1/sessions/{id}": get: operationId: Sessions_get summary: Get a Session @@ -1474,13 +1372,13 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: allOf: - - $ref: '#/components/schemas/Session' + - $ref: "#/components/schemas/Session" - type: object properties: connectUrl: @@ -1492,9 +1390,7 @@ paths: type: string format: uri signingKey: - description: >- - Signing key to use when connecting to the Session via - HTTP. + description: Signing key to use when connecting to the Session via HTTP. type: string post: operationId: Sessions_update @@ -1513,30 +1409,23 @@ paths: type: object properties: projectId: - description: >- - The Project ID. Can be found in - [Settings](https://www.browserbase.com/settings). Optional - - if not provided, the project will be inferred from the API - key. + description: "The Project ID. Can be found in [Settings](https://www.browserbase.com/settings). Optional - if not provided, the project will be inferred from the API key." type: string status: - description: >- - Set to `REQUEST_RELEASE` to request that the session - complete. Use before session's timeout to avoid additional - charges. + description: Set to `REQUEST_RELEASE` to request that the session complete. Use before session's timeout to avoid additional charges. type: string enum: - REQUEST_RELEASE required: - status responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: - $ref: '#/components/schemas/Session' - /v1/sessions/{id}/debug: + $ref: "#/components/schemas/Session" + "/v1/sessions/{id}/debug": get: operationId: Sessions_getDebug summary: Session Live URLs @@ -1547,13 +1436,13 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: - $ref: '#/components/schemas/SessionLiveUrls' - /v1/sessions/{id}/downloads: + $ref: "#/components/schemas/SessionLiveUrls" + "/v1/sessions/{id}/downloads": get: operationId: Sessions_getDownloads summary: Session Downloads @@ -1564,7 +1453,7 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/zip: @@ -1581,11 +1470,9 @@ paths: schema: type: string responses: - '204': - description: >- - There is no content to send for this request, but the headers may be - useful. - /v1/sessions/{id}/logs: + "204": + description: "There is no content to send for this request, but the headers may be useful." + "/v1/sessions/{id}/logs": get: operationId: Sessions_getLogs summary: Session Logs @@ -1596,28 +1483,18 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: type: array items: - $ref: '#/components/schemas/SessionLog' - /v1/sessions/{id}/recording: + $ref: "#/components/schemas/SessionLog" + "/v1/sessions/{id}/recording": get: operationId: Sessions_getRecording - summary: Session Replay - deprecated: true - description: | - - **Deprecated:** The rrweb-based Session Replay API is being deprecated. If you need to continue using it, please contact [support@browserbase.com](mailto:support@browserbase.com). - - x-mint: - content: | - - **Deprecated:** The rrweb-based Session Replay API is being deprecated. If you need to continue using it, please contact [support@browserbase.com](mailto:support@browserbase.com). - + summary: Session Recording parameters: - name: id in: path @@ -1625,15 +1502,15 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: type: array items: - $ref: '#/components/schemas/SessionReplay' - /v1/sessions/{id}/uploads: + $ref: "#/components/schemas/SessionRecording" + "/v1/sessions/{id}/uploads": post: operationId: Sessions_uploadFile summary: Create Session Uploads @@ -1656,7 +1533,7 @@ paths: required: - file responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -1673,9 +1550,7 @@ components: type: object properties: type: - description: >- - Type of proxy. Always use 'browserbase' for the Browserbase managed - proxy network. + description: Type of proxy. Always use 'browserbase' for the Browserbase managed proxy network. type: string enum: - browserbase @@ -1684,14 +1559,10 @@ components: type: object properties: city: - description: >- - Name of the city. Use spaces for multi-word city names. - Optional. + description: Name of the city. Use spaces for multi-word city names. Optional. type: string state: - description: >- - US state code (2 characters). Must also specify US as the - country. Optional. + description: US state code (2 characters). Must also specify US as the country. Optional. type: string maxLength: 2 minLength: 2 @@ -1703,9 +1574,7 @@ components: required: - country domainPattern: - description: >- - Domain pattern for which this proxy should be used. If omitted, - defaults to all domains. Optional. + description: "Domain pattern for which this proxy should be used. If omitted, defaults to all domains. Optional." type: string required: - type @@ -1763,9 +1632,7 @@ components: description: Server URL for external proxy. Required. type: string domainPattern: - description: >- - Domain pattern for which this proxy should be used. If omitted, - defaults to all domains. Optional. + description: "Domain pattern for which this proxy should be used. If omitted, defaults to all domains. Optional." type: string username: description: Username for external proxy authentication. Optional. @@ -1848,11 +1715,11 @@ components: type: array items: allOf: - - $ref: '#/components/schemas/Function' + - $ref: "#/components/schemas/Function" - type: object properties: createdVersion: - $ref: '#/components/schemas/FunctionVersion' + $ref: "#/components/schemas/FunctionVersion" required: - createdVersion cause: @@ -2011,9 +1878,7 @@ components: enum: - none domainPattern: - description: >- - Domain pattern for which this proxy should be used. If omitted, - defaults to all domains. Optional. + description: "Domain pattern for which this proxy should be used. If omitted, defaults to all domains. Optional." type: string required: - type @@ -2038,9 +1903,7 @@ components: maximum: 21600 minimum: 60 concurrency: - description: >- - The maximum number of sessions that this project can run - concurrently. + description: The maximum number of sessions that this project can run concurrently. type: integer minimum: 1 required: @@ -2095,14 +1958,10 @@ components: - TIMED_OUT - COMPLETED proxyBytes: - description: >- - Bytes used via the - [Proxy](/features/stealth-mode#proxies-and-residential-ips) + description: "Bytes used via the [Proxy](/features/stealth-mode#proxies-and-residential-ips)" type: integer keepAlive: - description: >- - Indicates if the Session was created to be kept alive upon - disconnections + description: Indicates if the Session was created to be kept alive upon disconnections type: boolean contextId: description: Optional. The Context linked to the Session. @@ -2116,10 +1975,7 @@ components: - eu-central-1 - ap-southeast-1 userMetadata: - description: >- - Arbitrary user metadata to attach to the session. To learn more - about user metadata, see [User - Metadata](/platform/browser/core-features/session-metadata). + description: "Arbitrary user metadata to attach to the session. To learn more about user metadata, see [User Metadata](/features/sessions#user-metadata)." type: object additionalProperties: true properties: {} @@ -2229,16 +2085,11 @@ components: - method - pageId - sessionId - SessionReplay: + SessionRecording: type: object - description: >- - Deprecated: rrweb-based session recording data. Contact - support@browserbase.com if you need to use this. properties: data: - description: >- - Deprecated. See [rrweb - documentation](https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/dive-into-event.md). + description: "See [rrweb documentation](https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/dive-into-event.md)." type: object additionalProperties: true properties: {} @@ -2259,7 +2110,7 @@ components: type: apiKey in: header name: X-BB-API-Key - description: Your [Browserbase API Key](https://www.browserbase.com/settings). + description: "Your [Browserbase API Key](https://www.browserbase.com/settings)." tags: [] security: - BrowserbaseAuth: []