KEkernel
Invocations

Update invocation

Update an invocation's status or output. This can be used to cancel an invocation by setting the status to "failed".

patch/invocations/{id}

Request

  • Base URL
    https://api.onkernel.com
  • URL
    https://api.onkernel.com/invocations/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Invocation ID

Request body

outputstring

Updated output of the invocation rendered as JSON string.

status'succeeded' | 'failed' required

New status for the invocation.

Response

Invocation updated successfully

action_namestring required

Name of the action invoked

app_namestring required

Name of the application

finished_atstring date-time nullable

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

idstring required

ID of the invocation

outputstring

The action result or detailed failure output. Often a JSON-encoded value, but failures may contain plain text. May contain sensitive application data.

payloadstring

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

started_atstring date-time required

RFC 3339 Nanoseconds timestamp when the invocation started

status'queued' | 'running' | 'succeeded' | 'failed' required

Status of the invocation

status_reasonstring

A nonempty, customer-safe summary of the recorded failure output, always present when status is failed and omitted otherwise, including in the first failed invocation_state event. Recognized messages receive a specific summary; other failures receive a generic summary. Message matching does not establish whether the failure originated in the platform or action code. Does not include raw action output or internal error details. Available for historical invocations as well. Human-readable text, not a stable identifier for retry logic.

versionstring required

Version label for the application

Example response

{
  "action_name": "analyze",
  "app_name": "my-app",
  "finished_at": "2024-05-19T15:30:05.000000000Z07:00",
  "id": "rr33xuugxj9h0bkf1rdt2bet",
  "output": "{\"result\":\"success\",\"data\":\"processed input\"}",
  "payload": "{\"data\":\"example input\"}",
  "started_at": "2024-05-19T15:30:00.000000000Z07:00",
  "status": "succeeded",
  "status_reason": "Invocation timed out after 900 seconds.",
  "version": "1.0.0"
}

Changes

No recorded changes to this operation across all 123 revisions of this API.