reference.md

Reference

client.getAuthStates() -> Scrapybara.AuthStateResponse[]

🔌 Usage

await client.getAuthStates();

⚙️ Parameters

requestOptions: ScrapybaraClient.RequestOptions

Instance

client.instance.screenshot(instanceId) -> Scrapybara.InstanceScreenshotResponse

🔌 Usage

await client.instance.screenshot("instance_id");

⚙️ Parameters

instanceId: string

requestOptions: Instance.RequestOptions

client.instance.getStreamUrl(instanceId) -> Scrapybara.InstanceGetStreamUrlResponse

🔌 Usage

await client.instance.getStreamUrl("instance_id");

⚙️ Parameters

instanceId: string

requestOptions: Instance.RequestOptions

client.instance.computer(instanceId, { ...params }) -> Scrapybara.ComputerResponse

🔌 Usage

await client.instance.computer("instance_id", {
    action: "move_mouse",
    coordinates: [1],
});

⚙️ Parameters

instanceId: string

request: Scrapybara.Request

requestOptions: Instance.RequestOptions

client.instance.bash(instanceId, { ...params }) -> Scrapybara.BashResponse

🔌 Usage

await client.instance.bash("instance_id");

⚙️ Parameters

instanceId: string

request: Scrapybara.BashRequest

requestOptions: Instance.RequestOptions

client.instance.edit(instanceId, { ...params }) -> Scrapybara.EditResponse

🔌 Usage

await client.instance.edit("instance_id", {
    command: "view",
    path: "path",
});

⚙️ Parameters

instanceId: string

request: Scrapybara.EditRequest

requestOptions: Instance.RequestOptions

client.instance.file(instanceId, { ...params }) -> Scrapybara.FileResponse

🔌 Usage

await client.instance.file("instance_id", {
    command: "command",
});

⚙️ Parameters

instanceId: string

request: Scrapybara.FileRequest

requestOptions: Instance.RequestOptions

client.instance.upload(file, instanceId, { ...params }) -> Scrapybara.UploadResponse

📝 Description

Upload a file to the instance.

🔌 Usage

await client.instance.upload(fs.createReadStream("/path/to/your/file"), "instance_id", {
    path: "path",
});

⚙️ Parameters

file: File | fs.ReadStream | Blob

instanceId: string

request: Scrapybara.BodyUploadV1InstanceInstanceIdUploadPost

requestOptions: Instance.RequestOptions

client.instance.stop(instanceId) -> Scrapybara.StopInstanceResponse

🔌 Usage

await client.instance.stop("instance_id");

⚙️ Parameters

instanceId: string

requestOptions: Instance.RequestOptions

client.instance.pause(instanceId) -> Scrapybara.StopInstanceResponse

🔌 Usage

await client.instance.pause("instance_id");

⚙️ Parameters

instanceId: string

requestOptions: Instance.RequestOptions

client.instance.resume(instanceId, { ...params }) -> Scrapybara.GetInstanceResponse

🔌 Usage

await client.instance.resume("instance_id");

⚙️ Parameters

instanceId: string

request: Scrapybara.InstanceResumeRequest

requestOptions: Instance.RequestOptions

Browser

client.browser.start(instanceId) -> Scrapybara.StartBrowserResponse

🔌 Usage

await client.browser.start("instance_id");

⚙️ Parameters

instanceId: string

requestOptions: Browser.RequestOptions

client.browser.getCdpUrl(instanceId) -> Scrapybara.BrowserGetCdpUrlResponse

🔌 Usage

await client.browser.getCdpUrl("instance_id");

⚙️ Parameters

instanceId: string

requestOptions: Browser.RequestOptions

client.browser.getCurrentUrl(instanceId) -> Scrapybara.BrowserGetCurrentUrlResponse

🔌 Usage

await client.browser.getCurrentUrl("instance_id");

⚙️ Parameters

instanceId: string

requestOptions: Browser.RequestOptions

client.browser.saveAuth(instanceId, { ...params }) -> Scrapybara.SaveBrowserAuthResponse

🔌 Usage

await client.browser.saveAuth("instance_id");

⚙️ Parameters

instanceId: string

request: Scrapybara.BrowserSaveAuthRequest

requestOptions: Browser.RequestOptions

client.browser.modifyAuth(instanceId, { ...params }) -> Scrapybara.ModifyBrowserAuthResponse

🔌 Usage

await client.browser.modifyAuth("instance_id", {
    authStateId: "auth_state_id",
});

⚙️ Parameters

instanceId: string

request: Scrapybara.BrowserModifyAuthRequest

requestOptions: Browser.RequestOptions

client.browser.authenticate(instanceId, { ...params }) -> Scrapybara.BrowserAuthenticateResponse

🔌 Usage

await client.browser.authenticate("instance_id", {
    authStateId: "auth_state_id",
});

⚙️ Parameters

instanceId: string

request: Scrapybara.BrowserAuthenticateRequest

requestOptions: Browser.RequestOptions

client.browser.stop(instanceId) -> Scrapybara.StopBrowserResponse

🔌 Usage

await client.browser.stop("instance_id");

⚙️ Parameters

instanceId: string

requestOptions: Browser.RequestOptions

Code

client.code.execute(instanceId, { ...params }) -> unknown

🔌 Usage

await client.code.execute("instance_id", {
    code: "code",
});

⚙️ Parameters

instanceId: string

request: Scrapybara.CodeExecuteRequest

requestOptions: Code.RequestOptions

Notebook

client.notebook.listKernels(instanceId) -> Scrapybara.KernelInfo[]

🔌 Usage

await client.notebook.listKernels("instance_id");

⚙️ Parameters

instanceId: string

requestOptions: Notebook.RequestOptions

client.notebook.create(instanceId, { ...params }) -> Scrapybara.Notebook

🔌 Usage

await client.notebook.create("instance_id", {
    name: "name",
});

⚙️ Parameters

instanceId: string

request: Scrapybara.CreateNotebookRequest

requestOptions: Notebook.RequestOptions

client.notebook.get(instanceId, notebookId) -> Scrapybara.Notebook

🔌 Usage

await client.notebook.get("instance_id", "notebook_id");

⚙️ Parameters

instanceId: string

notebookId: string

requestOptions: Notebook.RequestOptions

client.notebook.delete(instanceId, notebookId) -> Record

🔌 Usage

await client.notebook.delete("instance_id", "notebook_id");

⚙️ Parameters

instanceId: string

notebookId: string

requestOptions: Notebook.RequestOptions

client.notebook.addCell(instanceId, notebookId, { ...params }) -> Scrapybara.NotebookCell

🔌 Usage

await client.notebook.addCell("instance_id", "notebook_id", {
    type: "code",
    content: "content",
});

⚙️ Parameters

instanceId: string

notebookId: string

request: Scrapybara.AddCellRequest

requestOptions: Notebook.RequestOptions

client.notebook.executeCell(instanceId, notebookId, cellId, { ...params }) -> Scrapybara.NotebookCell

🔌 Usage

await client.notebook.executeCell("instance_id", "notebook_id", "cell_id", {});

⚙️ Parameters

instanceId: string

notebookId: string

cellId: string

request: Scrapybara.ExecuteCellRequest

requestOptions: Notebook.RequestOptions

client.notebook.execute(instanceId, notebookId, { ...params }) -> Scrapybara.NotebookCell[]

🔌 Usage

await client.notebook.execute("instance_id", "notebook_id", {});

⚙️ Parameters

instanceId: string

notebookId: string

request: Scrapybara.ExecuteCellRequest

requestOptions: Notebook.RequestOptions

Env

client.env.get(instanceId) -> Scrapybara.EnvGetResponse

🔌 Usage

await client.env.get("instance_id");

⚙️ Parameters

instanceId: string

requestOptions: Env.RequestOptions

client.env.set(instanceId, { ...params }) -> Scrapybara.EnvResponse

🔌 Usage

await client.env.set("instance_id", {
    variables: {
        key: "value",
    },
});

⚙️ Parameters

instanceId: string

request: Scrapybara.EnvSetRequest

requestOptions: Env.RequestOptions

client.env.delete(instanceId, { ...params }) -> Scrapybara.EnvResponse

🔌 Usage

await client.env.delete("instance_id", {
    keys: ["keys"],
});

⚙️ Parameters

instanceId: string

request: Scrapybara.EnvDeleteRequest

requestOptions: Env.RequestOptions