Appearance
Fresh 🌱
Invoke an action ​
Invoke an action.
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:
post:
tags:
- Invocations
summary: Invoke an action
description: Invoke an action.
operationId: postInvocations
requestBody:
description: Invocation parameters
required: true
content:
application/json:
schema:
type: object
properties:
app_name:
type: string
description: Name of the application
example: my-app
version:
type: string
description: Version of the application
example: 1.0.0
default: latest
payload:
type: string
description: Input data for the action, sent as a JSON string.
example: '{"data":"example input"}'
action_name:
type: string
description: Name of the action to invoke
example: analyze
async:
type: boolean
description: >-
If true, invoke asynchronously. When set, the API responds
202 Accepted with status "queued".
example: true
default: false
async_timeout_seconds:
type: integer
description: >-
Timeout in seconds for async invocations (min 10, max 3600).
Only applies when async is true.
example: 600
default: 900
minimum: 10
maximum: 3600
required:
- app_name
- version
- action_name
responses:
'200':
description: Invocation created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/InvokeResponse'
'202':
description: Invocation queued successfully (asynchronous invocation)
content:
application/json:
schema:
$ref: '#/components/schemas/InvokeResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'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 invocation = await client.invocations.create({
action_name: 'analyze',
app_name: 'my-app',
version: '1.0.0',
});
console.log(invocation.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
)
invocation = client.invocations.create(
action_name="analyze",
app_name="my-app",
version="1.0.0",
)
print(invocation.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\tinvocation, err := client.Invocations.New(context.TODO(), kernel.InvocationNewParams{\n\t\tActionName: \"analyze\",\n\t\tAppName: \"my-app\",\n\t\tVersion: \"1.0.0\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", invocation.ID)\n}\n"
components:
schemas:
InvokeResponse:
type: object
properties:
id:
type: string
description: ID of the invocation
example: rr33xuugxj9h0bkf1rdt2bet
action_name:
type: string
description: Name of the action invoked
example: analyze
status:
type: string
description: Status of the invocation
enum:
- queued
- running
- succeeded
- failed
example: queued
status_reason:
type: string
description: Status reason
example: Invocation queued for execution
output:
type: string
description: >-
The return value of the action that was invoked, rendered as a JSON
string. This could be: string, number, boolean, array, object, or
null.
example: '{"result":"success","data":"processed input"}'
required:
- id
- action_name
- 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'
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
TooManyRequests:
description: Too Many Requests - rate limit exceeded
headers:
Retry-After:
description: Seconds to wait before retrying
schema:
type: integer
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