> ## Documentation Index > Fetch the complete documentation index at: https://tbd-6fc993ce-hypeship-changelog-august-13.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # 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 https://api.onkernel.com/spec.json get /deployments/{id}/events openapi: 3.1.0 info: description: Developer tools and cloud infrastructure for AI agents to use web browsers title: Kernel API version: 0.1.0 servers: - description: API Server url: https://api.onkernel.com security: - bearerAuth: [] tags: - description: Create and manage browser sessions. name: Browsers - description: Control mouse, keyboard, and screen on the browser instance. name: Browser Computer Controls - description: Execute Playwright code against the browser instance. name: Browser Playwright - description: Read, write, and manage files on the browser instance. name: Browser Filesystem - description: Execute and manage processes on the browser instance. name: Browser Processes - description: Record and manage browser session video replays. name: Browser Replays - description: Stream logs from the browser instance. name: Browser Logs - description: Stream live telemetry events from a browser session. name: Browser Telemetry - description: Create, list, retrieve, and delete browser profiles. name: Profiles - description: Create and manage proxy configurations for routing browser traffic. name: Proxies - description: Create, list, retrieve, and delete browser extensions. name: Extensions - description: Create and manage browser pools for acquiring and releasing browsers. name: Browser Pools - description: Inspect the identity and authorization context for the current request. name: Authentication - description: >- Create and manage auth connections for automated credential capture and login. name: Managed Auth - description: Create and manage credentials for authentication. name: Credentials - description: Configure external credential providers like 1Password. name: Credential Providers - description: List applications and versions. name: Apps - description: Create and manage app deployments and stream deployment events. name: Deployments - description: Invoke actions and stream or query invocation status and events. name: Invocations - description: Read and manage organization-level limits. name: Organization - description: | Create and manage projects for resource isolation within an organization. When projects are disabled for the organization, project operations return `404` with code `projects_disabled`. name: Projects - description: Create and manage API keys for organization and project-scoped access. name: API Keys - description: Read audit log records for the authenticated organization. name: Audit Logs - description: Resolve browser and proxy recommendations for bot-protected sites. name: Site Configs 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: - description: The deployment ID to follow. in: path name: id required: true schema: type: string - description: >- Show logs since the given time (RFC timestamps or durations like 5m). in: query name: since required: false schema: example: '2025-06-20T12:00:00Z' type: string responses: '200': content: text/event-stream: schema: $ref: '#/components/schemas/DeploymentEvent' 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: const: application/json type: string '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' security: - bearerAuth: [] components: schemas: DeploymentEvent: description: Union type representing any deployment event. discriminator: mapping: app_version_summary: $ref: '#/components/schemas/AppVersionSummary' deployment_state: $ref: '#/components/schemas/DeploymentStateEvent' error: '#/components/schemas/InternalError' log: $ref: '#/components/schemas/LogEvent' sse_heartbeat: $ref: '#/components/schemas/SSEHeartbeatEvent' propertyName: event oneOf: - $ref: '#/components/schemas/LogEvent' - $ref: '#/components/schemas/DeploymentStateEvent' - $ref: '#/components/schemas/AppVersionSummaryEvent' - $ref: '#/components/schemas/ErrorEvent' - $ref: '#/components/schemas/SSEHeartbeatEvent' AppVersionSummary: description: Summary of an application version. properties: actions: description: List of actions available on the app items: $ref: '#/components/schemas/AppAction' type: array app_name: description: Name of the application example: my-app type: string deployment: description: Deployment ID type: string env_vars: additionalProperties: type: string description: >- Environment variables configured for this app version. Values are redacted for API key, OAuth, and managed-auth callers, which receive every key with an empty string value. Only dashboard sessions receive the actual values. type: object id: description: Unique identifier for the app version example: rr33xuugxj9h0bkf1rdt2bet type: string region: const: aws.us-east-1a description: Deployment region code example: aws.us-east-1a type: string version: description: Version label for the application example: 1.0.0 type: string required: - id - app_name - version - region - deployment - actions - env_vars type: object DeploymentStateEvent: description: An event representing the current state of a deployment. properties: deployment: $ref: '#/components/schemas/Deployment' event: const: deployment_state description: Event type identifier (always "deployment_state"). type: string timestamp: description: Time the state was reported. format: date-time type: string required: - event - deployment - timestamp type: object LogEvent: description: A log entry from the application. properties: event: const: log description: Event type identifier (always "log"). type: string message: description: Log message text. type: string timestamp: description: Time the log entry was produced. format: date-time type: string required: - event - message - timestamp type: object SSEHeartbeatEvent: description: Heartbeat event sent periodically to keep SSE connection alive. properties: event: const: sse_heartbeat description: Event type identifier (always "sse_heartbeat"). type: string timestamp: description: Time the heartbeat was sent. format: date-time type: string required: - event - timestamp type: object AppVersionSummaryEvent: description: Summary of an application version. properties: actions: description: List of actions available on the app items: $ref: '#/components/schemas/AppAction' type: array app_name: description: Name of the application example: my-app type: string env_vars: additionalProperties: type: string description: >- Environment variables configured for this app version. Not currently populated on streamed app_version_summary events. type: object event: const: app_version_summary description: Event type identifier (always "app_version_summary"). type: string id: description: Unique identifier for the app version example: rr33xuugxj9h0bkf1rdt2bet type: string region: const: aws.us-east-1a description: Deployment region code example: aws.us-east-1a type: string timestamp: description: Time the state was reported. format: date-time type: string version: description: Version label for the application example: 1.0.0 type: string required: - event - timestamp - id - app_name - version - region - actions type: object ErrorEvent: description: An error event from the application. properties: error: $ref: '#/components/schemas/Error' event: const: error description: Event type identifier (always "error"). type: string timestamp: description: Time the error occurred. format: date-time type: string required: - event - timestamp - error type: object Error: properties: code: description: Application-specific error code (machine-readable) example: bad_request type: string details: description: Additional error details (for multiple errors) items: $ref: '#/components/schemas/ErrorDetail' type: array inner_error: $ref: '#/components/schemas/ErrorDetail' message: description: Human-readable error description for debugging example: 'Missing required field: app_name' type: string required: - code - message type: object AppAction: description: An action available on the app properties: input_schema: additionalProperties: true description: >- JSON Schema (draft-07) describing the expected input payload. Null if schema could not be automatically generated. nullable: true type: object name: description: Name of the action example: analyze type: string output_schema: additionalProperties: true description: >- JSON Schema (draft-07) describing the expected output payload. Null if schema could not be automatically generated. nullable: true type: object required: - name type: object Deployment: description: Deployment record information. properties: created_at: description: Timestamp when the deployment was created format: date-time type: string entrypoint_rel_path: description: Relative path to the application entrypoint example: src/app.py type: string env_vars: additionalProperties: type: string description: >- Environment variables configured for this deployment. Values are redacted for API key, OAuth, and managed-auth callers, which receive every key with an empty string value. Only dashboard sessions receive the actual values. type: object id: description: Unique identifier for the deployment example: rr33xuugxj9h0bkf1rdt2bet type: string region: const: aws.us-east-1a description: Deployment region code example: aws.us-east-1a type: string source_checksum: description: >- Hex-encoded SHA-256 checksum of the source archive. For file uploads, this hashes the uploaded archive; for GitHub-sourced deployments, this hashes the GitHub archive downloaded by the API. Omitted for deployments created before this field was recorded. example: 3f4d0ea1bd2c5c1a1a1f0e9d8c7b6a5948372615049382716a5b4c3d2e1f0a9b type: string source_path: description: >- For GitHub-sourced deployments, the subpath within the repository that was used as the deploy root. Omitted when the repo root was used or for file uploads. example: apps/api type: string source_ref: description: >- For GitHub-sourced deployments, the git ref as requested at deploy time (branch, tag, or commit SHA — not resolved to a commit). Omitted for file uploads. example: main type: string source_type: description: >- Origin of the deployed source code. This is read-only response provenance; `file` indicates an uploaded archive and `github` indicates a repository fetched by the API. enum: - file - github example: github type: string x-go-type-name: DeploymentSourceOrigin source_url: description: >- For GitHub-sourced deployments, the repository URL that was fetched. Omitted for file uploads. example: https://github.com/org/repo type: string status: description: Current status of the deployment enum: - queued - in_progress - running - failed - stopped example: queued type: string status_reason: description: Status reason example: Deployment in progress type: string updated_at: description: Timestamp when the deployment was last updated format: date-time nullable: true type: string required: - id - status - region - created_at type: object ErrorDetail: properties: code: description: Lower-level error code providing more specific detail example: invalid_input type: string message: description: Further detail about the error example: Provided version string is not semver compliant type: string type: object responses: BadRequest: content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad Request – invalid input Unauthorized: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized – missing or invalid authorization token NotFound: content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource not found InternalError: content: application/json: schema: $ref: '#/components/schemas/Error' description: Internal Server Error securitySchemes: bearerAuth: scheme: bearer type: http ````