Invoking - Kernel

Via API

You can invoke your app by making a POST request to Kernel’s API or via the CLI. Both support passing a payload. For automations and agents that take longer than 100 seconds, use async invocations.

Synchronous invocations time out after 100 seconds.

import Kernel from '@onkernel/sdk';

const kernel = new Kernel();

const invocation = await kernel.invocations.create({
  action_name: 'analyze',
  app_name: 'my-app',
  version: '1.0.0',
});

console.log(invocation.id);

from kernel import Kernel

kernel = Kernel()
invocation = kernel.invocations.create(
    action_name="analyze",
    app_name="my-app",
    version="1.0.0",
)
print(invocation.id)

package main

import (
	"context"
	"fmt"

	"github.com/kernel/kernel-go-sdk"
)

func main() {
	ctx := context.Background()
	client := kernel.NewClient()

	invocation, err := client.Invocations.New(ctx, kernel.InvocationNewParams{
		ActionName: "analyze",
		AppName:    "my-app",
		Version:    "1.0.0",
	})
	if err != nil {
		panic(err)
	}

	fmt.Println(invocation.ID)
}

Asynchronous invocations

For long running jobs, use asynchronous invocations to trigger Kernel actions without waiting for the result. You can then stream real-time status updates for the result.

Asynchronous invocations time out after 15 minutes by default but can be configured to last up to 1 hour by setting the optional async_timeout_seconds parameter during invocation.

import Kernel from '@onkernel/sdk';

const kernel = new Kernel();

const invocation = await kernel.invocations.create({
  async: true,
  action_name: 'analyze',
  app_name: 'my-app',
  version: '1.0.0',
});

console.log(invocation.id);

from kernel import Kernel

kernel = Kernel()
invocation = kernel.invocations.create(
    action_name="analyze",
    app_name="my-app",
    version="1.0.0",
    async_=True,
)
print(invocation.id)

package main

import (
	"context"
	"fmt"

	"github.com/kernel/kernel-go-sdk"
)

func main() {
	ctx := context.Background()
	client := kernel.NewClient()

	invocation, err := client.Invocations.New(ctx, kernel.InvocationNewParams{
		Async:      kernel.Bool(true),
		ActionName: "analyze",
		AppName:    "my-app",
		Version:    "1.0.0",
	})
	if err != nil {
		panic(err)
	}

	fmt.Println(invocation.ID)
}

Via CLI

Invoke an app action immediately via the CLI:

kernel invoke <app_name> <action_name>

Payload parameter

--payload allows you to invoke the action with specified parameters. This enables your action to receive and handle dynamic inputs at runtime. For example:

Payloads are stringified JSON and have a maximum size of 4.5 MB.

kernel invoke <app_name> <action_name>
    --payload '{"tshirt_size": "small", "color": "black", "shipping_address": "2 Mint Plz, San Francisco CA 94103"}'

See here to learn how to access the payload in your action method.

Return values

If your action specifies a return value, the invocation returns its value once it completes. (The Kernel CLI uses asynchronous invocations under the hood)

​Via API

​Asynchronous invocations

​Via CLI

​Payload parameter

​Return values

Via API

Asynchronous invocations

Via CLI

Payload parameter

Return values