Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kernel Invocations API

Invoke actions and stream or query invocation status and events.

Kernel Invocations API is one of 22 APIs that Kernel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invocations. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 19 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.onkernel.com.

7 operations 4 paths 19 schemas 1 DELETE4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.onkernel.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kernel Invocations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Invocations 7

Invoke actions and stream or query invocation status and events.

POST
/invocations
Invoke an action
postInvocations body → 200202400404429500529
GET
/invocations
List invocations
getInvocations 9 params → 200400401500
GET
/invocations/{id}
Get invocation details
getInvocationsById 1 param → 200401404500
PATCH
/invocations/{id}
Update invocation
patchInvocationsById 1 param body → 200400404500
GET
/invocations/{id}/browsers
List browsers for an invocation
getInvocationsBrowsersById 1 param → 200400401404500
DELETE
/invocations/{id}/browsers
Delete browser sessions for an invocation
deleteInvocationsBrowsersById 1 param → 204400404500
GET
/invocations/{id}/events
Stream invocation events via SSE
getInvocationsEventsById 2 params → 200400401404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Browser (22 properties), Invocation (10 properties), BrowserTelemetryCategoriesConfig (9 properties), InvokeResponse (5 properties). Each schema is shown below with its type and property counts.

InvocationEvent
Union type representing any invocation event.
BrowserTelemetryCategoriesConfig
object
Per-category telemetry capture settings layered onto the default set. The operational signals (control, connection, system, captcha) are on by default and are…
9 properties
Browser
object
22 properties 7 required
InvokeResponse
object
5 properties 3 required
LogEvent
object
A log entry from the application.
3 properties 3 required
InvocationStateEvent
object
An event representing the current state of an invocation.
3 properties 3 required
Profile
object
Browser profile metadata.
5 properties 2 required
BrowserUsage
object
Session usage metrics.
1 property 1 required
ErrorDetail
object
2 properties
BrowserViewport
object
Initial browser window size in pixels with optional refresh rate. If omitted, image defaults apply (1920x1080@25). For GPU images, the default is 1920x1080@60.…
3 properties 2 required
Error
object
4 properties 2 required
BrowserTelemetryConfig
object
Active telemetry configuration for a browser session.
1 property
ErrorEvent
object
An error event from the application.
3 properties 3 required
Invocation
object
10 properties 6 required
InvocationUpdateRequest
object
Request body for updating an invocation.
2 properties 1 required
Tags
object
User-defined key-value tags.
BrowserPoolRef
object
Browser pool this session was acquired from, if any.
2 properties 1 required
BrowserTelemetryCategoryConfig
object
Per-category telemetry configuration.
1 property
SSEHeartbeatEvent
object
Heartbeat event sent periodically to keep SSE connection alive.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kernel-invocations-api-openapi.yml Raw ↑

Other APIs Kernel publishes across the network.

Kernel API Keys API
Kernel Apps API
Kernel Audit Logs API
Kernel Browser Computer Controls API
Kernel Browser Filesystem API
Kernel Browser Logs API
Kernel Browser Playwright API
Kernel Browser Pools API
Kernel Browser Processes API
Kernel Browser Replays API
Kernel Browser Telemetry API
Kernel Browsers API