diff --git a/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContext.g.cs b/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContext.g.cs index 21574d8..f1ce646 100644 --- a/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContext.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContext.g.cs @@ -87,6 +87,8 @@ namespace Browserbase typeof(global::Browserbase.JsonConverters.AnyOfJsonConverter), + typeof(global::Browserbase.JsonConverters.AnyOfJsonConverter), + typeof(global::Browserbase.JsonConverters.AllOfJsonConverter), typeof(global::Browserbase.JsonConverters.AllOfJsonConverter), @@ -179,6 +181,7 @@ namespace Browserbase [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.DownloadsGetResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.FetchCreateResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.Dictionary))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.AnyOf), TypeInfoPropertyName = "AnyOfStringObject2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.FetchCreateResponse2))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.FetchCreateResponse3))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Browserbase.FetchCreateResponse4))] diff --git a/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContextTypes.g.cs b/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContextTypes.g.cs index d10f6ee..1d1be06 100644 --- a/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContextTypes.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.JsonSerializerContextTypes.g.cs @@ -360,139 +360,143 @@ public sealed partial class JsonSerializerContextTypes /// /// /// - public global::Browserbase.FetchCreateResponse2? Type83 { get; set; } + public global::Browserbase.AnyOf? Type83 { get; set; } /// /// /// - public global::Browserbase.FetchCreateResponse3? Type84 { get; set; } + public global::Browserbase.FetchCreateResponse2? Type84 { get; set; } /// /// /// - public global::Browserbase.FetchCreateResponse4? Type85 { get; set; } + public global::Browserbase.FetchCreateResponse3? Type85 { get; set; } /// /// /// - public global::Browserbase.FetchCreateResponse5? Type86 { get; set; } + public global::Browserbase.FetchCreateResponse4? Type86 { get; set; } /// /// /// - public global::Browserbase.FunctionsListResponse? Type87 { get; set; } + public global::Browserbase.FetchCreateResponse5? Type87 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type88 { get; set; } + public global::Browserbase.FunctionsListResponse? Type88 { get; set; } /// /// /// - public global::Browserbase.FunctionBuildsListResponse? Type89 { get; set; } + public global::System.Collections.Generic.IList? Type89 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type90 { get; set; } + public global::Browserbase.FunctionBuildsListResponse? Type90 { get; set; } /// /// /// - public global::Browserbase.FunctionBuildsGetLogsResponse? Type91 { get; set; } + public global::System.Collections.Generic.IList? Type91 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type92 { get; set; } + public global::Browserbase.FunctionBuildsGetLogsResponse? Type92 { get; set; } /// /// /// - public global::Browserbase.AllOf? Type93 { get; set; } + public global::System.Collections.Generic.IList? Type93 { get; set; } /// /// /// - public global::Browserbase.InvocationsGetResponse2? Type94 { get; set; } + public global::Browserbase.AllOf? Type94 { get; set; } /// /// /// - public global::Browserbase.InvocationsGetResponseCause? Type95 { get; set; } + public global::Browserbase.InvocationsGetResponse2? Type95 { get; set; } /// /// /// - public global::Browserbase.InvocationsGetResponseCauseCode? Type96 { get; set; } + public global::Browserbase.InvocationsGetResponseCause? Type96 { get; set; } /// /// /// - public global::Browserbase.InvocationsGetLogsResponse? Type97 { get; set; } + public global::Browserbase.InvocationsGetResponseCauseCode? Type97 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type98 { get; set; } + public global::Browserbase.InvocationsGetLogsResponse? Type98 { get; set; } /// /// /// - public global::Browserbase.FunctionVersionsListInvocationsResponse? Type99 { get; set; } + public global::System.Collections.Generic.IList? Type99 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type100 { get; set; } + public global::Browserbase.FunctionVersionsListInvocationsResponse? Type100 { get; set; } /// /// /// - public global::Browserbase.FunctionsListVersionsResponse? Type101 { get; set; } + public global::System.Collections.Generic.IList? Type101 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type102 { get; set; } + public global::Browserbase.FunctionsListVersionsResponse? Type102 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type103 { get; set; } + public global::System.Collections.Generic.IList? Type103 { get; set; } /// /// /// - public global::Browserbase.SearchWebResponse? Type104 { get; set; } + public global::System.Collections.Generic.IList? Type104 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type105 { get; set; } + public global::Browserbase.SearchWebResponse? Type105 { get; set; } /// /// /// - public global::Browserbase.SearchWebResponseResult? Type106 { get; set; } + public global::System.Collections.Generic.IList? Type106 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type107 { get; set; } + public global::Browserbase.SearchWebResponseResult? Type107 { get; set; } /// /// /// - public global::Browserbase.AllOf? Type108 { get; set; } + public global::System.Collections.Generic.IList? Type108 { get; set; } /// /// /// - public global::Browserbase.SessionsCreateResponse2? Type109 { get; set; } + public global::Browserbase.AllOf? Type109 { get; set; } /// /// /// - public global::Browserbase.AllOf? Type110 { get; set; } + public global::Browserbase.SessionsCreateResponse2? Type110 { get; set; } /// /// /// - public global::Browserbase.SessionsGetResponse2? Type111 { get; set; } + public global::Browserbase.AllOf? Type111 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type112 { get; set; } + public global::Browserbase.SessionsGetResponse2? Type112 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type113 { get; set; } + public global::System.Collections.Generic.IList? Type113 { get; set; } /// /// /// - public global::Browserbase.SessionsGetReplayResponse? Type114 { get; set; } + public global::System.Collections.Generic.IList? Type114 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type115 { get; set; } + public global::Browserbase.SessionsGetReplayResponse? Type115 { get; set; } /// /// /// - public global::Browserbase.SessionsUploadFileResponse? Type116 { get; set; } + public global::System.Collections.Generic.IList? Type116 { get; set; } + /// + /// + /// + public global::Browserbase.SessionsUploadFileResponse? Type117 { get; set; } /// /// diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponse.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponse.g.cs index 2303794..176e52d 100644 --- a/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponse.g.cs +++ b/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponse.g.cs @@ -30,11 +30,12 @@ public sealed partial class FetchCreateResponse public required global::System.Collections.Generic.Dictionary Headers { get; set; } /// - /// The response body content + /// The response body content. A string for `raw` and `markdown` formats; a structured object for `json` format (the schema-extracted result). /// [global::System.Text.Json.Serialization.JsonPropertyName("content")] + [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Browserbase.JsonConverters.AnyOfJsonConverter))] [global::System.Text.Json.Serialization.JsonRequired] - public required string Content { get; set; } + public required global::Browserbase.AnyOf Content { get; set; } /// /// The MIME type of the response @@ -69,7 +70,7 @@ public sealed partial class FetchCreateResponse /// Response headers as key-value pairs /// /// - /// The response body content + /// The response body content. A string for `raw` and `markdown` formats; a structured object for `json` format (the schema-extracted result). /// /// /// The MIME type of the response @@ -84,14 +85,14 @@ public FetchCreateResponse( string id, int statusCode, global::System.Collections.Generic.Dictionary headers, - string content, + global::Browserbase.AnyOf content, string contentType, string encoding) { this.Id = id ?? throw new global::System.ArgumentNullException(nameof(id)); this.StatusCode = statusCode; this.Headers = headers ?? throw new global::System.ArgumentNullException(nameof(headers)); - this.Content = content ?? throw new global::System.ArgumentNullException(nameof(content)); + this.Content = content; this.ContentType = contentType ?? throw new global::System.ArgumentNullException(nameof(contentType)); this.Encoding = encoding ?? throw new global::System.ArgumentNullException(nameof(encoding)); } diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent.Json.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent.Json.g.cs new file mode 100644 index 0000000..ecc2fd2 --- /dev/null +++ b/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent.Json.g.cs @@ -0,0 +1,92 @@ +#nullable enable + +namespace Browserbase +{ + public sealed partial class FetchCreateResponseContent + { + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerContext. + /// + public string ToJson( + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Serialize( + this, + this.GetType(), + jsonSerializerContext); + } + + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [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 string ToJson( + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + return global::System.Text.Json.JsonSerializer.Serialize( + this, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerContext. + /// + public static global::Browserbase.FetchCreateResponseContent? FromJson( + string json, + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + typeof(global::Browserbase.FetchCreateResponseContent), + jsonSerializerContext) as global::Browserbase.FetchCreateResponseContent; + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [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.FetchCreateResponseContent? FromJson( + string json, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerContext. + /// + 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.FetchCreateResponseContent), + jsonSerializerContext).ConfigureAwait(false)) as global::Browserbase.FetchCreateResponseContent; + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [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( + global::System.IO.Stream jsonStream, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + return global::System.Text.Json.JsonSerializer.DeserializeAsync( + jsonStream, + jsonSerializerOptions); + } + } +} diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent.g.cs new file mode 100644 index 0000000..8ef4db3 --- /dev/null +++ b/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent.g.cs @@ -0,0 +1,19 @@ + +#nullable enable + +namespace Browserbase +{ + /// + /// + /// + public sealed partial class FetchCreateResponseContent + { + + /// + /// Additional properties that are not explicitly defined in the schema + /// + [global::System.Text.Json.Serialization.JsonExtensionData] + public global::System.Collections.Generic.IDictionary AdditionalProperties { get; set; } = new global::System.Collections.Generic.Dictionary(); + + } +} \ No newline at end of file diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent2.Json.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent2.Json.g.cs new file mode 100644 index 0000000..b1421bb --- /dev/null +++ b/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent2.Json.g.cs @@ -0,0 +1,92 @@ +#nullable enable + +namespace Browserbase +{ + public sealed partial class FetchCreateResponseContent2 + { + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerContext. + /// + public string ToJson( + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Serialize( + this, + this.GetType(), + jsonSerializerContext); + } + + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [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 string ToJson( + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + return global::System.Text.Json.JsonSerializer.Serialize( + this, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerContext. + /// + public static global::Browserbase.FetchCreateResponseContent2? FromJson( + string json, + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + typeof(global::Browserbase.FetchCreateResponseContent2), + jsonSerializerContext) as global::Browserbase.FetchCreateResponseContent2; + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [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.FetchCreateResponseContent2? FromJson( + string json, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerContext. + /// + 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.FetchCreateResponseContent2), + jsonSerializerContext).ConfigureAwait(false)) as global::Browserbase.FetchCreateResponseContent2; + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [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( + global::System.IO.Stream jsonStream, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + return global::System.Text.Json.JsonSerializer.DeserializeAsync( + jsonStream, + jsonSerializerOptions); + } + } +} diff --git a/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent2.g.cs b/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent2.g.cs new file mode 100644 index 0000000..3abca47 --- /dev/null +++ b/src/libs/Browserbase/Generated/Browserbase.Models.FetchCreateResponseContent2.g.cs @@ -0,0 +1,19 @@ + +#nullable enable + +namespace Browserbase +{ + /// + /// + /// + public sealed partial class FetchCreateResponseContent2 + { + + /// + /// Additional properties that are not explicitly defined in the schema + /// + [global::System.Text.Json.Serialization.JsonExtensionData] + public global::System.Collections.Generic.IDictionary AdditionalProperties { get; set; } = new global::System.Collections.Generic.Dictionary(); + + } +} \ No newline at end of file diff --git a/src/libs/Browserbase/openapi.yaml b/src/libs/Browserbase/openapi.yaml index 9a0360c..74e553f 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: @@ -439,8 +415,11 @@ paths: additionalProperties: type: string content: - description: The response body content - type: string + anyOf: + - type: string + - type: object + additionalProperties: {} + description: The response body content. A string for `raw` and `markdown` formats; a structured object for `json` format (the schema-extracted result). contentType: description: The MIME type of the response type: string @@ -454,7 +433,7 @@ paths: - content - contentType - encoding - '400': + "400": description: Invalid request body. content: application/json: @@ -477,7 +456,7 @@ paths: - statusCode - error - message - '429': + "429": description: Concurrent fetch request limit exceeded. content: application/json: @@ -500,10 +479,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 +503,7 @@ paths: - error - message - id - '504': + "504": description: The fetch request timed out. content: application/json: @@ -571,7 +548,7 @@ paths: maximum: 100 minimum: 1 responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -581,7 +558,7 @@ paths: data: type: array items: - $ref: '#/components/schemas/Function' + $ref: "#/components/schemas/Function" total: type: integer minimum: 0 @@ -614,7 +591,7 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -624,14 +601,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 +620,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 +638,7 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -671,14 +648,14 @@ paths: logs: type: array items: - $ref: '#/components/schemas/FunctionBuildLog' + $ref: "#/components/schemas/FunctionBuildLog" total: type: integer minimum: 0 required: - logs - total - /v1/functions/invocations/{id}: + "/v1/functions/invocations/{id}": get: operationId: Invocations_get summary: Get an Invocation @@ -690,13 +667,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: @@ -713,7 +690,7 @@ paths: minLength: 1 required: - code - /v1/functions/invocations/{id}/logs: + "/v1/functions/invocations/{id}/logs": get: operationId: Invocations_getLogs summary: Get Invocation Logs @@ -725,7 +702,7 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -735,14 +712,14 @@ paths: logs: type: array items: - $ref: '#/components/schemas/InvocationLog' + $ref: "#/components/schemas/InvocationLog" total: type: integer minimum: 0 required: - logs - total - /v1/functions/versions/{id}: + "/v1/functions/versions/{id}": get: operationId: FunctionVersions_get summary: Get a Function Version @@ -754,13 +731,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 @@ -792,7 +769,7 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -802,14 +779,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 @@ -821,13 +798,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 @@ -853,9 +830,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 @@ -867,16 +842,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 @@ -888,24 +859,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 @@ -914,21 +877,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 @@ -937,7 +892,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: @@ -945,21 +900,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 @@ -968,73 +915,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: [] ignoreCertificateErrors: - description: >- - Enable or disable ignoring of certificate errors in - the browser. Defaults to `true`. + 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](/features/sessions#user-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). + 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 @@ -1061,7 +992,7 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -1071,7 +1002,7 @@ paths: results: type: array items: - $ref: '#/components/schemas/FunctionVersion' + $ref: "#/components/schemas/FunctionVersion" total: type: integer minimum: 0 @@ -1083,15 +1014,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 @@ -1102,13 +1033,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 @@ -1119,12 +1050,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 @@ -1151,7 +1082,7 @@ paths: required: - query responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -1218,22 +1149,19 @@ paths: - COMPLETED - name: q in: 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. + 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 @@ -1244,16 +1172,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 @@ -1265,16 +1187,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 @@ -1286,14 +1204,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`. @@ -1308,19 +1222,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 @@ -1329,34 +1237,25 @@ paths: - mobile - tablet ignoreCertificateErrors: - description: >- - Enable or disable ignoring of certificate errors in the - browser. Defaults to `true`. + 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. @@ -1368,23 +1267,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](/features/sessions#user-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: @@ -1396,9 +1290,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 @@ -1423,23 +1315,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: |- @@ -1470,16 +1356,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 @@ -1490,13 +1375,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: @@ -1508,9 +1393,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 @@ -1529,30 +1412,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 @@ -1563,13 +1439,13 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: - $ref: '#/components/schemas/SessionLiveUrls' - /v1/sessions/{id}/logs: + $ref: "#/components/schemas/SessionLiveUrls" + "/v1/sessions/{id}/logs": get: operationId: Sessions_getLogs summary: Session Logs @@ -1580,15 +1456,15 @@ 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 Recording @@ -1599,21 +1475,19 @@ paths: schema: type: string responses: - '200': + "200": description: The request has succeeded. content: application/json: schema: type: array items: - $ref: '#/components/schemas/SessionRecording' - /v1/sessions/{id}/replays: + $ref: "#/components/schemas/SessionRecording" + "/v1/sessions/{id}/replays": get: operationId: Sessions_getReplay summary: Get Session Replay - description: >- - Returns page metadata for a session replay, including timing information - and the URL of each page's HLS playlist. + description: "Returns page metadata for a session replay, including timing information and the URL of each page's HLS playlist." parameters: - name: id in: path @@ -1623,7 +1497,7 @@ paths: type: string format: uuid responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -1633,19 +1507,17 @@ paths: pages: type: array items: - $ref: '#/components/schemas/ReplayPage' + $ref: "#/components/schemas/ReplayPage" pageCount: type: integer required: - pages - pageCount - /v1/sessions/{id}/replays/{pageId}: + "/v1/sessions/{id}/replays/{pageId}": get: operationId: Sessions_getReplayPage summary: Get Replay Page - description: >- - Returns an HLS VOD media playlist (.m3u8) for a specific page of a - session replay. + description: Returns an HLS VOD media playlist (.m3u8) for a specific page of a session replay. parameters: - name: id in: path @@ -1662,13 +1534,13 @@ paths: maxLength: 3 pattern: ^\d+$ responses: - '200': + "200": description: The request has succeeded. content: application/vnd.apple.mpegurl: schema: type: string - /v1/sessions/{id}/uploads: + "/v1/sessions/{id}/uploads": post: operationId: Sessions_uploadFile summary: Create Session Uploads @@ -1691,7 +1563,7 @@ paths: required: - file responses: - '200': + "200": description: The request has succeeded. content: application/json: @@ -1708,9 +1580,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 @@ -1719,14 +1589,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 @@ -1738,9 +1604,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 @@ -1798,9 +1662,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. @@ -1883,11 +1745,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: @@ -2046,9 +1908,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 @@ -2073,9 +1933,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: @@ -2146,14 +2004,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. @@ -2167,10 +2021,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](/features/sessions#user-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: {} @@ -2284,9 +2135,7 @@ components: type: object properties: data: - description: >- - 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: {} @@ -2307,7 +2156,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: []