api.md

Shared Types

fromkernel.typesimport (
AppAction,
BrowserExtension,
BrowserProfile,
BrowserViewport,
ErrorDetail,
ErrorEvent,
ErrorModel,
HeartbeatEvent,
LogEvent,
)

Deployments

Types:

fromkernel.typesimport (
DeploymentStateEvent,
DeploymentCreateResponse,
DeploymentRetrieveResponse,
DeploymentListResponse,
DeploymentFollowResponse,
)

Methods:

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

Apps

Types:

fromkernel.typesimportAppListResponse

Methods:

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

Invocations

Types:

fromkernel.typesimport (
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:

fromkernel.typesimport (
BrowserMemory,
BrowserMemoryRequest,
BrowserNetworkConfig,
BrowserPoolRef,
BrowserProxy,
BrowserProxyConfig,
BrowserProxyMode,
BrowserUsage,
Profile,
Tags,
BrowserCreateResponse,
BrowserRetrieveResponse,
BrowserUpdateResponse,
BrowserListResponse,
BrowserCurlResponse,
)

Methods:

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

Telemetry

Types:

fromkernel.types.browsersimport (
BrowserAPICallEvent,
BrowserCallStack,
BrowserCaptchaSolveResultEvent,
BrowserCdpConnectEvent,
BrowserCdpDisconnectEvent,
BrowserConsoleErrorEvent,
BrowserConsoleLogEvent,
BrowserEventContext,
BrowserEventSource,
BrowserHTTPHeaders,
BrowserInteractionClickEvent,
BrowserInteractionKeyEvent,
BrowserInteractionScrollSettledEvent,
BrowserLiveViewConnectEvent,
BrowserLiveViewDisconnectEvent,
BrowserMonitorDisconnectedEvent,
BrowserMonitorInitFailedEvent,
BrowserMonitorReconnectFailedEvent,
BrowserMonitorReconnectedEvent,
BrowserMonitorScreenshotEvent,
BrowserNetworkIdleEvent,
BrowserNetworkLoadingFailedEvent,
BrowserNetworkRequestEvent,
BrowserNetworkResponseEvent,
BrowserPageDomContentLoadedEvent,
BrowserPageLayoutSettledEvent,
BrowserPageLayoutShiftEvent,
BrowserPageLcpEvent,
BrowserPageLoadEvent,
BrowserPageNavigationEvent,
BrowserPageNavigationSettledEvent,
BrowserPageTabOpenedEvent,
BrowserProxyErrorEvent,
BrowserServiceCrashedEvent,
BrowserSystemOomKillEvent,
BrowserTelemetryCategoriesConfig,
BrowserTelemetryCategoryConfig,
BrowserTelemetryConfig,
BrowserTelemetryEvent,
BrowserTelemetryExportConfig,
BrowserTelemetryOtlpExportConfig,
TelemetryEventsResponse,
TelemetryStreamResponse,
)

Methods:

• client.browsers.telemetry.events(id, **params) -> SyncOffsetPagination[TelemetryEventsResponse]
• client.browsers.telemetry.stream(id, **params) -> TelemetryStreamResponse

Replays

Types:

fromkernel.types.browsersimportReplayListResponse, 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:

fromkernel.types.browsersimportFFileInfoResponse, 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:

fromkernel.types.browsers.fsimportWatchEventsResponse, 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:

fromkernel.types.browsersimport (
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:

fromkernel.types.browsersimport (
ComputerGetMousePositionResponse,
ComputerReadClipboardResponse,
ComputerSetCursorVisibilityResponse,
)

Methods:

• client.browsers.computer.batch(id, **params) -> None
• 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.get_mouse_position(id) -> ComputerGetMousePositionResponse
• client.browsers.computer.move_mouse(id, **params) -> None
• client.browsers.computer.press_key(id, **params) -> None
• client.browsers.computer.read_clipboard(id) -> ComputerReadClipboardResponse
• client.browsers.computer.scroll(id, **params) -> None
• client.browsers.computer.set_cursor_visibility(id, **params) -> ComputerSetCursorVisibilityResponse
• client.browsers.computer.type_text(id, **params) -> None
• client.browsers.computer.write_clipboard(id, **params) -> None

Playwright

Types:

fromkernel.types.browsersimportPlaywrightExecuteResponse

Methods:

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

Profiles

Methods:

• client.profiles.create(**params) -> Profile
• client.profiles.retrieve(id_or_name) -> Profile
• client.profiles.update(id_or_name, **params) -> Profile
• client.profiles.list(**params) -> SyncOffsetPagination[Profile]
• client.profiles.delete(id_or_name) -> None
• client.profiles.download(id_or_name, **params) -> BinaryAPIResponse

Auth

Context

Types:

fromkernel.types.authimportAuthContext

Methods:

• client.auth.context.retrieve() -> AuthContext

Connections

Types:

fromkernel.types.authimport (
LoginResponse,
ManagedAuth,
ManagedAuthBrowserConfig,
ManagedAuthCreateRequest,
ManagedAuthTimelineEvent,
ManagedAuthUpdateRequest,
SubmitFieldsRequest,
SubmitFieldsResponse,
ConnectionFollowResponse,
)

Methods:

• client.auth.connections.create(**params) -> ManagedAuth
• client.auth.connections.retrieve(id) -> ManagedAuth
• client.auth.connections.update(id, **params) -> ManagedAuth
• client.auth.connections.list(**params) -> SyncOffsetPagination[ManagedAuth]
• client.auth.connections.delete(id) -> None
• client.auth.connections.follow(id) -> ConnectionFollowResponse
• client.auth.connections.login(id, **params) -> LoginResponse
• client.auth.connections.submit(id, **params) -> SubmitFieldsResponse
• client.auth.connections.timeline(id, **params) -> SyncOffsetPagination[ManagedAuthTimelineEvent]

Telemetry

Destinations

Types:

fromkernel.types.telemetryimportOtlpDestination

Methods:

• client.telemetry.destinations.create(**params) -> OtlpDestination
• client.telemetry.destinations.retrieve(id_or_name) -> OtlpDestination
• client.telemetry.destinations.update(id_or_name, **params) -> OtlpDestination
• client.telemetry.destinations.list(**params) -> SyncOffsetPagination[OtlpDestination]
• client.telemetry.destinations.delete(id_or_name) -> None

Proxies

Types:

fromkernel.typesimport (
ProxyCreateResponse,
ProxyRetrieveResponse,
ProxyUpdateResponse,
ProxyListResponse,
ProxyCheckResponse,
)

Methods:

• client.proxies.create(**params) -> ProxyCreateResponse
• client.proxies.retrieve(id) -> ProxyRetrieveResponse
• client.proxies.update(id, **params) -> ProxyUpdateResponse
• client.proxies.list(**params) -> SyncOffsetPagination[ProxyListResponse]
• client.proxies.delete(id) -> None
• client.proxies.check(id, **params) -> ProxyCheckResponse

Extensions

Types:

fromkernel.typesimportExtensionListResponse, ExtensionGetResponse, ExtensionUploadResponse

Methods:

• client.extensions.list(**params) -> SyncOffsetPagination[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.get(id_or_name) -> ExtensionGetResponse
• client.extensions.upload(**params) -> ExtensionUploadResponse

BrowserPools

Types:

fromkernel.typesimportBrowserPool, 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(**params) -> SyncOffsetPagination[BrowserPool]
• 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

Credentials

Types:

fromkernel.typesimport (
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

Projects

Types:

fromkernel.typesimportCreateProjectRequest, Project, UpdateProjectRequest

Methods:

• client.projects.create(**params) -> Project
• client.projects.retrieve(id_or_name) -> Project
• client.projects.update(id_or_name, **params) -> Project
• client.projects.list(**params) -> SyncOffsetPagination[Project]
• client.projects.delete(id_or_name) -> None

Limits

Types:

fromkernel.types.projectsimportProjectLimits, UpdateProjectLimitsRequest

Methods:

• client.projects.limits.retrieve(id_or_name) -> ProjectLimits
• client.projects.limits.update(id_or_name, **params) -> ProjectLimits

Organization

Entitlements

Types:

fromkernel.types.organizationimportOrgEntitlements

Methods:

• client.organization.entitlements.retrieve() -> OrgEntitlements

Limits

Types:

fromkernel.types.organizationimportOrgLimits, UpdateOrgLimitsRequest

Methods:

• client.organization.limits.retrieve() -> OrgLimits
• client.organization.limits.update(**params) -> OrgLimits

AuditLogs

Types:

fromkernel.typesimportAuditLogEntry

Methods:

• client.audit_logs.list(**params) -> SyncPageTokenPagination[AuditLogEntry]
• client.audit_logs.export_chunk(**params) -> BinaryAPIResponse

ExportDestinations

Types:

fromkernel.types.audit_logsimport (
AuditLogExportDestination,
AuditLogExportDestinationTestResult,
CreateAuditLogExportDestinationRequest,
UpdateAuditLogExportDestinationRequest,
)

Methods:

• client.audit_logs.export_destinations.create(**params) -> AuditLogExportDestination
• client.audit_logs.export_destinations.retrieve(id) -> AuditLogExportDestination
• client.audit_logs.export_destinations.update(id, **params) -> AuditLogExportDestination
• client.audit_logs.export_destinations.list(**params) -> SyncOffsetPagination[AuditLogExportDestination]
• client.audit_logs.export_destinations.delete(id) -> None
• client.audit_logs.export_destinations.test(id) -> AuditLogExportDestinationTestResult

APIKeys

Types:

fromkernel.typesimportAPIKey, CreatedAPIKey

Methods:

• client.api_keys.create(**params) -> CreatedAPIKey
• client.api_keys.retrieve(id, **params) -> APIKey
• client.api_keys.update(id, **params) -> APIKey
• client.api_keys.list(**params) -> SyncOffsetPagination[APIKey]
• client.api_keys.delete(id) -> None
• client.api_keys.rotate(id, **params) -> CreatedAPIKey

CredentialProviders

Types:

fromkernel.typesimport (
CreateCredentialProviderRequest,
CredentialProvider,
CredentialProviderItem,
CredentialProviderTestResult,
UpdateCredentialProviderRequest,
CredentialProviderListItemsResponse,
)

Methods:

• client.credential_providers.create(**params) -> CredentialProvider
• client.credential_providers.retrieve(id) -> CredentialProvider
• client.credential_providers.update(id, **params) -> CredentialProvider
• client.credential_providers.list(**params) -> SyncOffsetPagination[CredentialProvider]
• client.credential_providers.delete(id) -> None
• client.credential_providers.list_items(id) -> CredentialProviderListItemsResponse
• client.credential_providers.test(id) -> CredentialProviderTestResult