PATCH
/
invocations
/
{id}
JavaScript
import Kernel from '@onkernel/sdk';

const client = new Kernel({
  apiKey: 'My API Key',
});

const invocation = await client.invocations.update('id', { status: 'succeeded' });

console.log(invocation.id);
{
  "id": "rr33xuugxj9h0bkf1rdt2bet",
  "app_name": "my-app",
  "action_name": "analyze",
  "payload": "{\"data\":\"example input\"}",
  "output": "{\"result\":\"success\",\"data\":\"processed input\"}",
  "started_at": "2024-05-19T15:30:00.000000000Z07:00",
  "finished_at": "2024-05-19T15:30:05.000000000Z07:00",
  "status": "succeeded",
  "status_reason": "Invocation completed successfully"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Invocation ID

Body

application/json

Request body for updating an invocation.

​
status
enum<string>
required

New status for the invocation.

Available options:
succeeded,
failed
​
output
string

Updated output of the invocation rendered as JSON string.

Response

Invocation updated successfully

​
id
string
required

ID of the invocation

Example:

"rr33xuugxj9h0bkf1rdt2bet"

​
app_name
string
required

Name of the application

Example:

"my-app"

​
action_name
string
required

Name of the action invoked

Example:

"analyze"

​
started_at
string<date-time>
required

RFC 3339 Nanoseconds timestamp when the invocation started

Example:

"2024-05-19T15:30:00.000000000Z07:00"

​
status
enum<string>
required

Status of the invocation

Available options:
queued,
running,
succeeded,
failed
Example:

"succeeded"

​
payload
string

Payload provided to the invocation. This is a string that can be parsed as JSON.

Example:

"{\"data\":\"example input\"}"

​
output
string

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\"}"

​
finished_at
string<date-time> | null

RFC 3339 Nanoseconds timestamp when the invocation finished (null if still running)

Example:

"2024-05-19T15:30:05.000000000Z07:00"

​
status_reason
string

Status reason

Example:

"Invocation completed successfully"