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}

Update invocation

cURL

curl --request PATCH \
  --url https://api.onkernel.com/invocations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "output": "<string>"
}
'

200

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

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

200

application/json

Invocation updated successfully

action_name · string · required

Name of the action invoked

Example:

"analyze"

app_name · string · required

Name of the application

Example:

"my-app"

id · string · required

ID of the invocation

Example:

"rr33xuugxj9h0bkf1rdt2bet"

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"

version · string · required

Version label for the application

Example:

"1.0.0"

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"

output · string

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

Example:

"{\"result\":\"success\",\"data\":\"processed input\"}"

payload · string

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

Example:

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

status_reason · string

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.

Minimum string length: 1

Example:

"Invocation timed out after 900 seconds."