Invoke an action

Invoke an action.

POST /invocations

Invoke an action

cURL

curl --request POST \
  --url https://api.onkernel.com/invocations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action_name": "analyze",
  "app_name": "my-app",
  "version": "1.0.0",
  "async": true,
  "async_timeout_seconds": 600,
  "payload": "{\"data\":\"example input\"}"
}
'

200

{
  "action_name": "analyze",
  "id": "rr33xuugxj9h0bkf1rdt2bet",
  "status": "queued",
  "output": "{\"result\":\"success\",\"data\":\"processed 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.

Body

application/json

Invocation parameters

action_name · string · required

Name of the action to invoke

Example:

"analyze"

app_name · string · required

Name of the application

Example:

"my-app"

version · string · default: latest · required

Version of the application

Example:

"1.0.0"

async · boolean · default: false

If true, invoke asynchronously. When set, the API responds 202 Accepted with status "queued".

Example:

true

async_timeout_seconds · integer · default: 900

Timeout in seconds for async invocations (min 10, max 3600). Only applies when async is true.

Required range: 10 <= x <= 3600

Example:

600

payload · string

Input data for the action, sent as a JSON string.

Example:

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

Response

200

application/json

Invocation created successfully

action_name · string · required

Name of the action invoked

Example:

"analyze"

id · string · required

ID of the invocation

Example:

"rr33xuugxj9h0bkf1rdt2bet"

status · enum<string> · required

Status of the invocation

Available options: queued, running, succeeded, failed

Example:

"queued"

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

status_reason · string

A nonempty, customer-safe summary of the recorded failure output, always present when status is failed and omitted otherwise. 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. Human-readable text, not a stable identifier for retry logic.

Minimum string length: 1

Example:

"Invocation timed out after 900 seconds."