Appearance
Fresh 🌱
Stream deployment events via SSE ​
Establishes a Server-Sent Events (SSE) stream that delivers real-time logs and status updates for a deployment. The stream terminates automatically once the deployment reaches a terminal state.
OpenAPI ​
yaml
openapi: 3.1.0
info:
title: Kernel API
description: Developer tools and cloud infrastructure for AI agents to use web browsers
version: 0.1.0
servers:
- url: https://api.onkernel.com
description: API Server
security:
- bearerAuth: []
tags:
- name: Browsers
description: Create and manage browser sessions.
- name: Browser Replays
description: Record and manage browser session video replays.
- name: Profiles
description: Create, list, retrieve, and delete browser profiles.
- name: Browser Filesystem
description: Read, write, and manage files on the browser instance.
- name: Browser Computer Controls
description: Control mouse, keyboard, and screen on the browser instance.
- name: Browser Playwright
description: Execute Playwright code against the browser instance.
- name: Browser Processes
description: Execute and manage processes on the browser instance.
- name: Browser Logs
description: Stream logs from the browser instance.
- name: Extensions
description: Create, list, retrieve, and delete browser extensions.
- name: Proxies
description: Create and manage proxy configurations for routing browser traffic.
- name: Browser Pools
description: Create and manage browser pools for acquiring and releasing browsers.
- name: Managed Auth
description: >-
Create and manage auth connections for automated credential capture and
login.
- name: Credentials
description: Create and manage credentials for authentication.
- name: Credential Providers
description: Configure external credential providers like 1Password.
- name: Apps
description: List applications and versions.
- name: Deployments
description: Create and manage app deployments and stream deployment events.
- name: Invocations
description: Invoke actions and stream or query invocation status and events.
- name: Projects
description: Create and manage projects for resource isolation within an organization.
paths:
/deployments/{id}/events:
get:
tags:
- Deployments
summary: Stream deployment events via SSE
description: >
Establishes a Server-Sent Events (SSE) stream that delivers real-time
logs and
status updates for a deployment. The stream terminates automatically
once the deployment reaches a terminal state.
operationId: getDeploymentsEventsById
parameters:
- name: id
in: path
required: true
description: The deployment ID to follow.
schema:
type: string
- name: since
in: query
required: false
description: >-
Show logs since the given time (RFC timestamps or durations like
5m).
schema:
type: string
example: '2025-06-20T12:00:00Z'
responses:
'200':
description: SSE stream of deployment state updates and logs.
headers:
X-SSE-Content-Type:
description: Media type of SSE data events (always application/json).
schema:
type: string
const: application/json
content:
text/event-stream:
schema:
$ref: '#/components/schemas/DeploymentEvent'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
security:
- bearerAuth: []
x-codeSamples:
- lang: JavaScript
source: |-
import Kernel from '@onkernel/sdk';
const client = new Kernel({
apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
});
const response = await client.deployments.follow('id');
console.log(response);
- lang: Python
source: |-
import os
from kernel import Kernel
client = Kernel(
api_key=os.environ.get("KERNEL_API_KEY"), # This is the default and can be omitted
)
for deployment in client.deployments.follow(
id="id",
):
print(deployment)
- lang: Go
source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/kernel/kernel-go-sdk\"\n\t\"github.com/kernel/kernel-go-sdk/option\"\n)\n\nfunc main() {\n\tclient := kernel.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tstream := client.Deployments.FollowStreaming(\n\t\tcontext.TODO(),\n\t\t\"id\",\n\t\tkernel.DeploymentFollowParams{},\n\t)\n\tfor stream.Next() {\n\t\tfmt.Printf(\"%+v\\n\", stream.Current())\n\t}\n\terr := stream.Err()\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n"
components:
schemas:
DeploymentEvent:
oneOf:
- $ref: '#/components/schemas/LogEvent'
- $ref: '#/components/schemas/DeploymentStateEvent'
- $ref: '#/components/schemas/AppVersionSummaryEvent'
- $ref: '#/components/schemas/ErrorEvent'
- $ref: '#/components/schemas/SSEHeartbeatEvent'
discriminator:
propertyName: event
mapping:
log:
$ref: '#/components/schemas/LogEvent'
deployment_state:
$ref: '#/components/schemas/DeploymentStateEvent'
app_version_summary:
$ref: '#/components/schemas/AppVersionSummary'
error: '#/components/schemas/InternalError'
sse_heartbeat:
$ref: '#/components/schemas/SSEHeartbeatEvent'
description: Union type representing any deployment event.
LogEvent:
type: object
description: A log entry from the application.
required:
- event
- message
- timestamp
properties:
event:
type: string
const: log
description: Event type identifier (always "log").
timestamp:
type: string
format: date-time
description: Time the log entry was produced.
message:
type: string
description: Log message text.
DeploymentStateEvent:
type: object
description: An event representing the current state of a deployment.
required:
- event
- deployment
- timestamp
properties:
event:
type: string
const: deployment_state
description: Event type identifier (always "deployment_state").
deployment:
$ref: '#/components/schemas/Deployment'
timestamp:
type: string
format: date-time
description: Time the state was reported.
AppVersionSummaryEvent:
type: object
description: Summary of an application version.
required:
- event
- timestamp
- id
- app_name
- version
- region
- actions
properties:
event:
type: string
const: app_version_summary
description: Event type identifier (always "app_version_summary").
timestamp:
type: string
format: date-time
description: Time the state was reported.
id:
type: string
description: Unique identifier for the app version
example: rr33xuugxj9h0bkf1rdt2bet
app_name:
type: string
description: Name of the application
example: my-app
version:
type: string
description: Version label for the application
example: 1.0.0
region:
type: string
description: Deployment region code
example: aws.us-east-1a
const: aws.us-east-1a
actions:
type: array
description: List of actions available on the app
items:
$ref: '#/components/schemas/AppAction'
env_vars:
type: object
description: Environment variables configured for this app version
additionalProperties:
type: string
ErrorEvent:
type: object
description: An error event from the application.
required:
- event
- timestamp
- error
properties:
event:
type: string
const: error
description: Event type identifier (always "error").
timestamp:
type: string
format: date-time
description: Time the error occurred.
error:
$ref: '#/components/schemas/Error'
SSEHeartbeatEvent:
type: object
description: Heartbeat event sent periodically to keep SSE connection alive.
required:
- event
- timestamp
properties:
event:
type: string
const: sse_heartbeat
description: Event type identifier (always "sse_heartbeat").
timestamp:
type: string
format: date-time
description: Time the heartbeat was sent.
AppVersionSummary:
type: object
description: Summary of an application version.
properties:
id:
type: string
description: Unique identifier for the app version
example: rr33xuugxj9h0bkf1rdt2bet
app_name:
type: string
description: Name of the application
example: my-app
version:
type: string
description: Version label for the application
example: 1.0.0
region:
type: string
description: Deployment region code
example: aws.us-east-1a
const: aws.us-east-1a
deployment:
type: string
description: Deployment ID
actions:
type: array
description: List of actions available on the app
items:
$ref: '#/components/schemas/AppAction'
env_vars:
type: object
description: Environment variables configured for this app version
additionalProperties:
type: string
required:
- id
- app_name
- version
- region
- deployment
- actions
- env_vars
Error:
type: object
required:
- code
- message
properties:
code:
type: string
description: Application-specific error code (machine-readable)
example: bad_request
message:
type: string
description: Human-readable error description for debugging
example: 'Missing required field: app_name'
details:
type: array
description: Additional error details (for multiple errors)
items:
$ref: '#/components/schemas/ErrorDetail'
inner_error:
$ref: '#/components/schemas/ErrorDetail'
Deployment:
type: object
description: Deployment record information.
properties:
id:
type: string
description: Unique identifier for the deployment
example: rr33xuugxj9h0bkf1rdt2bet
status:
type: string
description: Current status of the deployment
enum:
- queued
- in_progress
- running
- failed
- stopped
example: queued
status_reason:
type: string
description: Status reason
example: Deployment in progress
region:
type: string
description: Deployment region code
example: aws.us-east-1a
const: aws.us-east-1a
entrypoint_rel_path:
type: string
description: Relative path to the application entrypoint
example: src/app.py
env_vars:
type: object
description: Environment variables configured for this deployment
additionalProperties:
type: string
created_at:
type: string
format: date-time
description: Timestamp when the deployment was created
updated_at:
type: string
format: date-time
nullable: true
description: Timestamp when the deployment was last updated
required:
- id
- status
- region
- created_at
AppAction:
type: object
description: An action available on the app
required:
- name
properties:
name:
type: string
description: Name of the action
example: analyze
input_schema:
type: object
nullable: true
description: >-
JSON Schema (draft-07) describing the expected input payload. Null
if schema could not be automatically generated.
additionalProperties: true
output_schema:
type: object
nullable: true
description: >-
JSON Schema (draft-07) describing the expected output payload. Null
if schema could not be automatically generated.
additionalProperties: true
ErrorDetail:
type: object
properties:
code:
type: string
description: Lower-level error code providing more specific detail
example: invalid_input
message:
type: string
description: Further detail about the error
example: Provided version string is not semver compliant
responses:
BadRequest:
description: Bad Request - invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Unauthorized - missing or invalid authorization token
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
InternalError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer