Appearance
Fresh 🌱
List invocations ​
List invocations. Optionally filter by application name, action name, status, deployment ID, or start time.
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:
/invocations:
get:
tags:
- Invocations
summary: List invocations
description: >-
List invocations. Optionally filter by application name, action name,
status, deployment ID, or start time.
operationId: getInvocations
parameters:
- name: app_name
in: query
required: false
description: Filter results by application name.
schema:
type: string
- name: version
in: query
required: false
description: Filter results by application version.
schema:
type: string
- name: action_name
in: query
required: false
description: Filter results by action name.
schema:
type: string
- name: deployment_id
in: query
required: false
description: Filter results by deployment ID.
schema:
type: string
- name: status
in: query
required: false
description: Filter results by invocation status.
schema:
type: string
enum:
- queued
- running
- succeeded
- failed
- name: since
in: query
required: false
description: >-
Show invocations that have started since the given time (RFC
timestamps or durations like 5m).
schema:
type: string
example: '2025-06-20T12:00:00Z'
- name: limit
in: query
required: false
description: Limit the number of invocations to return.
schema:
type: integer
minimum: 1
maximum: 100
default: 20
- name: offset
in: query
required: false
description: Offset the number of invocations to return.
schema:
type: integer
minimum: 0
default: 0
responses:
'200':
description: A list of invocations.
headers:
X-Limit:
description: The limit of invocations returned.
schema:
type: integer
X-Offset:
description: The offset of invocations returned.
schema:
type: integer
X-Next-Offset:
description: Next offset to use for pagination.
schema:
type: integer
nullable: true
X-Has-More:
description: Whether there are more invocations to fetch.
schema:
type: boolean
default: false
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Invocation'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'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
});
// Automatically fetches more pages as needed.
for await (const invocationListResponse of
client.invocations.list()) {
console.log(invocationListResponse.id);
}
- 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
)
page = client.invocations.list()
page = page.items[0]
print(page.id)
- 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\tpage, err := client.Invocations.List(context.TODO(), kernel.InvocationListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n"
components:
schemas:
Invocation:
type: object
properties:
id:
type: string
description: ID of the invocation
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
action_name:
type: string
description: Name of the action invoked
example: analyze
payload:
type: string
description: >-
Payload provided to the invocation. This is a string that can be
parsed as JSON.
example: '{"data":"example input"}'
output:
type: string
description: >-
Output produced by the action, rendered as a JSON string. This could
be: string, number, boolean, array, object, or null.
example: '{"result":"success","data":"processed input"}'
started_at:
type: string
format: date-time
description: RFC 3339 Nanoseconds timestamp when the invocation started
example: 2024-05-19T15:30:00.000000000Z07:00
finished_at:
type: string
format: date-time
nullable: true
description: >-
RFC 3339 Nanoseconds timestamp when the invocation finished (null if
still running)
example: 2024-05-19T15:30:05.000000000Z07:00
status:
type: string
description: Status of the invocation
enum:
- queued
- running
- succeeded
- failed
example: succeeded
status_reason:
type: string
description: Status reason
example: Invocation completed successfully
required:
- id
- app_name
- version
- action_name
- started_at
- status
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'
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'
InternalError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer