// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { type Agent } from './_shims/index'; import * as Core from './core'; import * as Errors from './error'; import * as Uploads from './uploads'; import * as API from './resources/index'; import { Context, ContextCreateParams, ContextCreateResponse, ContextUpdateResponse, Contexts, } from './resources/contexts'; import { Extension, ExtensionCreateParams, Extensions } from './resources/extensions'; import { FetchAPI, FetchAPICreateParams, FetchAPICreateResponse } from './resources/fetch-api'; import { Project, ProjectListResponse, ProjectUsage, Projects } from './resources/projects'; import { Search, SearchWebParams, SearchWebResponse } from './resources/search'; import { Session, SessionCreateParams, SessionCreateResponse, SessionListParams, SessionListResponse, SessionLiveURLs, SessionRetrieveResponse, SessionUpdateParams, Sessions, } from './resources/sessions/sessions'; export interface ClientOptions { /** * Your [Browserbase API Key](https://www.browserbase.com/settings). */ apiKey?: string | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['BROWSERBASE_BASE_URL']. */ baseURL?: string | null | undefined; /** * The maximum amount of time (in milliseconds) that the client should wait for a response * from the server before timing out a single request. * * Note that request timeouts are retried by default, so in a worst-case scenario you may wait * much longer than this timeout before the promise succeeds or fails. * * @unit milliseconds */ timeout?: number | undefined; /** * An HTTP agent used to manage HTTP(S) connections. * * If not provided, an agent will be constructed by default in the Node.js environment, * otherwise no agent is used. */ httpAgent?: Agent | undefined; /** * Specify a custom `fetch` function implementation. * * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is * defined globally. */ fetch?: Core.Fetch | undefined; /** * The maximum number of times that the client will retry a request in case of a * temporary failure, like a network error or a 5XX error from the server. * * @default 2 */ maxRetries?: number | undefined; /** * Default headers to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * header to `undefined` or `null` in request options. */ defaultHeaders?: Core.Headers | undefined; /** * Default query parameters to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * param to `undefined` in request options. */ defaultQuery?: Core.DefaultQuery | undefined; } /** * API Client for interfacing with the Browserbase API. */ export class Browserbase extends Core.APIClient { apiKey: string; private _options: ClientOptions; /** * API Client for interfacing with the Browserbase API. * * @param {string | undefined} [opts.apiKey=process.env['BROWSERBASE_API_KEY'] ?? undefined] * @param {string} [opts.baseURL=process.env['BROWSERBASE_BASE_URL'] ?? https://api.browserbase.com] - Override the default base URL for the API. * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out. * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections. * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation. * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request. * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API. */ constructor({ baseURL = Core.readEnv('BROWSERBASE_BASE_URL'), apiKey = Core.readEnv('BROWSERBASE_API_KEY'), ...opts }: ClientOptions = {}) { if (apiKey === undefined) { throw new Errors.BrowserbaseError( "The BROWSERBASE_API_KEY environment variable is missing or empty; either provide it, or instantiate the Browserbase client with an apiKey option, like new Browserbase({ apiKey: 'My API Key' }).", ); } const options: ClientOptions = { apiKey, ...opts, baseURL: baseURL || `https://api.browserbase.com`, }; super({ baseURL: options.baseURL!, baseURLOverridden: baseURL ? baseURL !== 'https://api.browserbase.com' : false, timeout: options.timeout ?? 60000 /* 1 minute */, httpAgent: options.httpAgent, maxRetries: options.maxRetries, fetch: options.fetch, }); this._options = options; this.apiKey = apiKey; } contexts: API.Contexts = new API.Contexts(this); extensions: API.Extensions = new API.Extensions(this); fetchAPI: API.FetchAPI = new API.FetchAPI(this); projects: API.Projects = new API.Projects(this); search: API.Search = new API.Search(this); sessions: API.Sessions = new API.Sessions(this); /** * Check whether the base URL is set to its default. */ #baseURLOverridden(): boolean { return this.baseURL !== 'https://api.browserbase.com'; } protected override defaultQuery(): Core.DefaultQuery | undefined { return this._options.defaultQuery; } protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers { return { ...super.defaultHeaders(opts), ...this._options.defaultHeaders, }; } protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers { return { 'X-BB-API-Key': this.apiKey }; } static Browserbase = this; static DEFAULT_TIMEOUT = 60000; // 1 minute static BrowserbaseError = Errors.BrowserbaseError; static APIError = Errors.APIError; static APIConnectionError = Errors.APIConnectionError; static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError; static APIUserAbortError = Errors.APIUserAbortError; static NotFoundError = Errors.NotFoundError; static ConflictError = Errors.ConflictError; static RateLimitError = Errors.RateLimitError; static BadRequestError = Errors.BadRequestError; static AuthenticationError = Errors.AuthenticationError; static InternalServerError = Errors.InternalServerError; static PermissionDeniedError = Errors.PermissionDeniedError; static UnprocessableEntityError = Errors.UnprocessableEntityError; static toFile = Uploads.toFile; static fileFromPath = Uploads.fileFromPath; } Browserbase.Contexts = Contexts; Browserbase.Extensions = Extensions; Browserbase.FetchAPI = FetchAPI; Browserbase.Projects = Projects; Browserbase.Search = Search; Browserbase.Sessions = Sessions; export declare namespace Browserbase { export type RequestOptions = Core.RequestOptions; export { Contexts as Contexts, type Context as Context, type ContextCreateResponse as ContextCreateResponse, type ContextUpdateResponse as ContextUpdateResponse, type ContextCreateParams as ContextCreateParams, }; export { Extensions as Extensions, type Extension as Extension, type ExtensionCreateParams as ExtensionCreateParams, }; export { FetchAPI as FetchAPI, type FetchAPICreateResponse as FetchAPICreateResponse, type FetchAPICreateParams as FetchAPICreateParams, }; export { Projects as Projects, type Project as Project, type ProjectUsage as ProjectUsage, type ProjectListResponse as ProjectListResponse, }; export { Search as Search, type SearchWebResponse as SearchWebResponse, type SearchWebParams as SearchWebParams, }; export { Sessions as Sessions, type Session as Session, type SessionLiveURLs as SessionLiveURLs, type SessionCreateResponse as SessionCreateResponse, type SessionRetrieveResponse as SessionRetrieveResponse, type SessionListResponse as SessionListResponse, type SessionCreateParams as SessionCreateParams, type SessionUpdateParams as SessionUpdateParams, type SessionListParams as SessionListParams, }; } export { toFile, fileFromPath } from './uploads'; export { BrowserbaseError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from './error'; export default Browserbase;