api.md

Shared Types

from kernel.types import (
    AppAction,
    BrowserExtension,
    BrowserProfile,
    BrowserViewport,
    ErrorDetail,
    ErrorEvent,
    ErrorModel,
    HeartbeatEvent,
    LogEvent,
)

Deployments

Types:

from kernel.types import (
    DeploymentStateEvent,
    DeploymentCreateResponse,
    DeploymentRetrieveResponse,
    DeploymentListResponse,
    DeploymentFollowResponse,
)

Methods:

• client.deployments.create(**params) -> DeploymentCreateResponse
• client.deployments.retrieve(id) -> DeploymentRetrieveResponse
• client.deployments.list(**params) -> SyncOffsetPagination[DeploymentListResponse]
• client.deployments.follow(id, **params) -> DeploymentFollowResponse

Apps

Types:

from kernel.types import AppListResponse

Methods:

• client.apps.list(**params) -> SyncOffsetPagination[AppListResponse]

Invocations

Types:

from kernel.types import (
    InvocationStateEvent,
    InvocationCreateResponse,
    InvocationRetrieveResponse,
    InvocationUpdateResponse,
    InvocationListResponse,
    InvocationFollowResponse,
    InvocationListBrowsersResponse,
)

Methods:

• client.invocations.create(**params) -> InvocationCreateResponse
• client.invocations.retrieve(id) -> InvocationRetrieveResponse
• client.invocations.update(id, **params) -> InvocationUpdateResponse
• client.invocations.list(**params) -> SyncOffsetPagination[InvocationListResponse]
• client.invocations.delete_browsers(id) -> None
• client.invocations.follow(id, **params) -> InvocationFollowResponse
• client.invocations.list_browsers(id) -> InvocationListBrowsersResponse

Browsers

Types:

from kernel.types import (
    BrowserPersistence,
    Profile,
    BrowserCreateResponse,
    BrowserRetrieveResponse,
    BrowserUpdateResponse,
    BrowserListResponse,
)

Methods:

• client.browsers.create(**params) -> BrowserCreateResponse
• client.browsers.retrieve(id, **params) -> BrowserRetrieveResponse
• client.browsers.update(id, **params) -> BrowserUpdateResponse
• client.browsers.list(**params) -> SyncOffsetPagination[BrowserListResponse]
• client.browsers.delete(**params) -> None
• client.browsers.delete_by_id(id) -> None
• client.browsers.load_extensions(id, **params) -> None

Replays

Types:

from kernel.types.browsers import ReplayListResponse, ReplayStartResponse

Methods:

• client.browsers.replays.list(id) -> ReplayListResponse
• client.browsers.replays.download(replay_id, *, id) -> BinaryAPIResponse
• client.browsers.replays.start(id, **params) -> ReplayStartResponse
• client.browsers.replays.stop(replay_id, *, id) -> None

Fs

Types:

from kernel.types.browsers import FFileInfoResponse, FListFilesResponse

Methods:

• client.browsers.fs.create_directory(id, **params) -> None
• client.browsers.fs.delete_directory(id, **params) -> None
• client.browsers.fs.delete_file(id, **params) -> None
• client.browsers.fs.download_dir_zip(id, **params) -> BinaryAPIResponse
• client.browsers.fs.file_info(id, **params) -> FFileInfoResponse
• client.browsers.fs.list_files(id, **params) -> FListFilesResponse
• client.browsers.fs.move(id, **params) -> None
• client.browsers.fs.read_file(id, **params) -> BinaryAPIResponse
• client.browsers.fs.set_file_permissions(id, **params) -> None
• client.browsers.fs.upload(id, **params) -> None
• client.browsers.fs.upload_zip(id, **params) -> None
• client.browsers.fs.write_file(id, contents, **params) -> None

Watch

Types:

from kernel.types.browsers.fs import WatchEventsResponse, WatchStartResponse

Methods:

• client.browsers.fs.watch.events(watch_id, *, id) -> WatchEventsResponse
• client.browsers.fs.watch.start(id, **params) -> WatchStartResponse
• client.browsers.fs.watch.stop(watch_id, *, id) -> None

Process

Types:

from kernel.types.browsers import (
    ProcessExecResponse,
    ProcessKillResponse,
    ProcessResizeResponse,
    ProcessSpawnResponse,
    ProcessStatusResponse,
    ProcessStdinResponse,
    ProcessStdoutStreamResponse,
)

Methods:

• client.browsers.process.exec(id, **params) -> ProcessExecResponse
• client.browsers.process.kill(process_id, *, id, **params) -> ProcessKillResponse
• client.browsers.process.resize(process_id, *, id, **params) -> ProcessResizeResponse
• client.browsers.process.spawn(id, **params) -> ProcessSpawnResponse
• client.browsers.process.status(process_id, *, id) -> ProcessStatusResponse
• client.browsers.process.stdin(process_id, *, id, **params) -> ProcessStdinResponse
• client.browsers.process.stdout_stream(process_id, *, id) -> ProcessStdoutStreamResponse

Logs

Methods:

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

Computer

Types:

from kernel.types.browsers import ComputerSetCursorVisibilityResponse

Methods:

• client.browsers.computer.capture_screenshot(id, **params) -> BinaryAPIResponse
• client.browsers.computer.click_mouse(id, **params) -> None
• client.browsers.computer.drag_mouse(id, **params) -> None
• client.browsers.computer.move_mouse(id, **params) -> None
• client.browsers.computer.press_key(id, **params) -> None
• client.browsers.computer.scroll(id, **params) -> None
• client.browsers.computer.set_cursor_visibility(id, **params) -> ComputerSetCursorVisibilityResponse
• client.browsers.computer.type_text(id, **params) -> None

Playwright

Types:

from kernel.types.browsers import PlaywrightExecuteResponse

Methods:

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

Profiles

Types:

from kernel.types import ProfileListResponse

Methods:

• client.profiles.create(**params) -> Profile
• client.profiles.retrieve(id_or_name) -> Profile
• client.profiles.list() -> ProfileListResponse
• client.profiles.delete(id_or_name) -> None
• client.profiles.download(id_or_name) -> BinaryAPIResponse

Proxies

Types:

from kernel.types import (
    ProxyCreateResponse,
    ProxyRetrieveResponse,
    ProxyListResponse,
    ProxyCheckResponse,
)

Methods:

• client.proxies.create(**params) -> ProxyCreateResponse
• client.proxies.retrieve(id) -> ProxyRetrieveResponse
• client.proxies.list() -> ProxyListResponse
• client.proxies.delete(id) -> None
• client.proxies.check(id) -> ProxyCheckResponse

Extensions

Types:

from kernel.types import ExtensionListResponse, ExtensionUploadResponse

Methods:

• client.extensions.list() -> ExtensionListResponse
• client.extensions.delete(id_or_name) -> None
• client.extensions.download(id_or_name) -> BinaryAPIResponse
• client.extensions.download_from_chrome_store(**params) -> BinaryAPIResponse
• client.extensions.upload(**params) -> ExtensionUploadResponse

BrowserPools

Types:

from kernel.types import BrowserPool, BrowserPoolListResponse, BrowserPoolAcquireResponse

Methods:

• client.browser_pools.create(**params) -> BrowserPool
• client.browser_pools.retrieve(id_or_name) -> BrowserPool
• client.browser_pools.update(id_or_name, **params) -> BrowserPool
• client.browser_pools.list() -> BrowserPoolListResponse
• client.browser_pools.delete(id_or_name, **params) -> None
• client.browser_pools.acquire(id_or_name, **params) -> BrowserPoolAcquireResponse
• client.browser_pools.flush(id_or_name) -> None
• client.browser_pools.release(id_or_name, **params) -> None

Agents

Auth

Types:

from kernel.types.agents import (
    AgentAuthInvocationResponse,
    AgentAuthSubmitResponse,
    AuthAgent,
    AuthAgentCreateRequest,
    AuthAgentInvocationCreateRequest,
    AuthAgentInvocationCreateResponse,
    DiscoveredField,
)

Methods:

• client.agents.auth.create(**params) -> AuthAgent
• client.agents.auth.retrieve(id) -> AuthAgent
• client.agents.auth.list(**params) -> SyncOffsetPagination[AuthAgent]
• client.agents.auth.delete(id) -> None

Invocations

Types:

from kernel.types.agents.auth import InvocationExchangeResponse

Methods:

• client.agents.auth.invocations.create(**params) -> AuthAgentInvocationCreateResponse
• client.agents.auth.invocations.retrieve(invocation_id) -> AgentAuthInvocationResponse
• client.agents.auth.invocations.exchange(invocation_id, **params) -> InvocationExchangeResponse
• client.agents.auth.invocations.submit(invocation_id, **params) -> AgentAuthSubmitResponse

Credentials

Types:

from kernel.types import (
    CreateCredentialRequest,
    Credential,
    UpdateCredentialRequest,
    CredentialTotpCodeResponse,
)

Methods:

• client.credentials.create(**params) -> Credential
• client.credentials.retrieve(id_or_name) -> Credential
• client.credentials.update(id_or_name, **params) -> Credential
• client.credentials.list(**params) -> SyncOffsetPagination[Credential]
• client.credentials.delete(id_or_name) -> None
• client.credentials.totp_code(id_or_name) -> CredentialTotpCodeResponse

CredentialProviders

Types:

from kernel.types import (
    CreateCredentialProviderRequest,
    CredentialProvider,
    CredentialProviderTestResult,
    UpdateCredentialProviderRequest,
    CredentialProviderListResponse,
)

Methods:

• client.credential_providers.create(**params) -> CredentialProvider
• client.credential_providers.retrieve(id) -> CredentialProvider
• client.credential_providers.update(id, **params) -> CredentialProvider
• client.credential_providers.list() -> CredentialProviderListResponse
• client.credential_providers.delete(id) -> None
• client.credential_providers.test(id) -> CredentialProviderTestResult