api.md

Shared

Types:

• AppAction
• ErrorDetail
• ErrorEvent
• ErrorModel
• HeartbeatEvent
• LogEvent

Deployments

Types:

• DeploymentStateEvent
• DeploymentCreateResponse
• DeploymentRetrieveResponse
• DeploymentListResponse
• DeploymentFollowResponse

Methods:

• client.deployments.create({ ...params }) -> DeploymentCreateResponse
• client.deployments.retrieve(id) -> DeploymentRetrieveResponse
• client.deployments.list({ ...params }) -> DeploymentListResponsesOffsetPagination
• client.deployments.follow(id, { ...params }) -> DeploymentFollowResponse

Apps

Types:

• AppListResponse

Methods:

• client.apps.list({ ...params }) -> AppListResponse

Invocations

Types:

• InvocationStateEvent
• InvocationCreateResponse
• InvocationRetrieveResponse
• InvocationUpdateResponse
• InvocationListResponse
• InvocationFollowResponse

Methods:

• client.invocations.create({ ...params }) -> InvocationCreateResponse
• client.invocations.retrieve(id) -> InvocationRetrieveResponse
• client.invocations.update(id, { ...params }) -> InvocationUpdateResponse
• client.invocations.list({ ...params }) -> InvocationListResponsesOffsetPagination
• client.invocations.deleteBrowsers(id) -> void
• client.invocations.follow(id, { ...params }) -> InvocationFollowResponse

Browsers

Types:

• BrowserPersistence
• Profile
• BrowserCreateResponse
• BrowserRetrieveResponse
• BrowserListResponse

Methods:

• client.browsers.create({ ...params }) -> BrowserCreateResponse
• client.browsers.retrieve(id) -> BrowserRetrieveResponse
• client.browsers.list() -> BrowserListResponse
• client.browsers.delete({ ...params }) -> void
• client.browsers.deleteByID(id) -> void
• client.browsers.loadExtensions(id, { ...params }) -> void

Replays

Types:

• ReplayListResponse
• ReplayStartResponse

Methods:

• client.browsers.replays.list(id) -> ReplayListResponse
• client.browsers.replays.download(replayID, { ...params }) -> Response
• client.browsers.replays.start(id, { ...params }) -> ReplayStartResponse
• client.browsers.replays.stop(replayID, { ...params }) -> void

Fs

Types:

• FFileInfoResponse
• FListFilesResponse

Methods:

• client.browsers.fs.createDirectory(id, { ...params }) -> void
• client.browsers.fs.deleteDirectory(id, { ...params }) -> void
• client.browsers.fs.deleteFile(id, { ...params }) -> void
• client.browsers.fs.downloadDirZip(id, { ...params }) -> Response
• client.browsers.fs.fileInfo(id, { ...params }) -> FFileInfoResponse
• client.browsers.fs.listFiles(id, { ...params }) -> FListFilesResponse
• client.browsers.fs.move(id, { ...params }) -> void
• client.browsers.fs.readFile(id, { ...params }) -> Response
• client.browsers.fs.setFilePermissions(id, { ...params }) -> void
• client.browsers.fs.upload(id, { ...params }) -> void
• client.browsers.fs.uploadZip(id, { ...params }) -> void
• client.browsers.fs.writeFile(id, contents, { ...params }) -> void

Watch

Types:

• WatchEventsResponse
• WatchStartResponse

Methods:

• client.browsers.fs.watch.events(watchID, { ...params }) -> WatchEventsResponse
• client.browsers.fs.watch.start(id, { ...params }) -> WatchStartResponse
• client.browsers.fs.watch.stop(watchID, { ...params }) -> void

Process

Types:

• ProcessExecResponse
• ProcessKillResponse
• ProcessSpawnResponse
• ProcessStatusResponse
• ProcessStdinResponse
• ProcessStdoutStreamResponse

Methods:

• client.browsers.process.exec(id, { ...params }) -> ProcessExecResponse
• client.browsers.process.kill(processID, { ...params }) -> ProcessKillResponse
• client.browsers.process.spawn(id, { ...params }) -> ProcessSpawnResponse
• client.browsers.process.status(processID, { ...params }) -> ProcessStatusResponse
• client.browsers.process.stdin(processID, { ...params }) -> ProcessStdinResponse
• client.browsers.process.stdoutStream(processID, { ...params }) -> ProcessStdoutStreamResponse

Logs

Methods:

• client.browsers.logs.stream(id, { ...params }) -> LogEvent

Computer

Methods:

• client.browsers.computer.captureScreenshot(id, { ...params }) -> Response
• client.browsers.computer.clickMouse(id, { ...params }) -> void
• client.browsers.computer.dragMouse(id, { ...params }) -> void
• client.browsers.computer.moveMouse(id, { ...params }) -> void
• client.browsers.computer.pressKey(id, { ...params }) -> void
• client.browsers.computer.scroll(id, { ...params }) -> void
• client.browsers.computer.typeText(id, { ...params }) -> void

Playwright

Types:

• PlaywrightExecuteResponse

Methods:

• client.browsers.playwright.execute(id, { ...params }) -> PlaywrightExecuteResponse

Profiles

Types:

• ProfileListResponse

Methods:

• client.profiles.create({ ...params }) -> Profile
• client.profiles.retrieve(idOrName) -> Profile
• client.profiles.list() -> ProfileListResponse
• client.profiles.delete(idOrName) -> void
• client.profiles.download(idOrName) -> Response

Proxies

Types:

• ProxyCreateResponse
• ProxyRetrieveResponse
• ProxyListResponse

Methods:

• client.proxies.create({ ...params }) -> ProxyCreateResponse
• client.proxies.retrieve(id) -> ProxyRetrieveResponse
• client.proxies.list() -> ProxyListResponse
• client.proxies.delete(id) -> void

Extensions

Types:

• ExtensionListResponse
• ExtensionUploadResponse

Methods:

• client.extensions.list() -> ExtensionListResponse
• client.extensions.delete(idOrName) -> void
• client.extensions.download(idOrName) -> Response
• client.extensions.downloadFromChromeStore({ ...params }) -> Response
• client.extensions.upload({ ...params }) -> ExtensionUploadResponse