Sign in
latestOpenAPI 3.1.02026-08-22154287463.4 KB

858365328f92

Invocations

Invoke an action

Invoke an action.

post/invocations

Request body

action_namestring required

Name of the action to invoke

app_namestring required

Name of the application

asyncboolean

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

async_timeout_secondsinteger

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

payloadstring

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

versionstring required

Version of the application

Example request

{
  "action_name": "analyze",
  "app_name": "my-app",
  "async": true,
  "async_timeout_seconds": 600,
  "payload": "{\"data\":\"example input\"}",
  "version": "1.0.0"
}

Response

Invocation created successfully

action_namestring required

Name of the action invoked

idstring required

ID of the invocation

outputstring

The return value of the action that was invoked, rendered as a JSON string. This could be: string, number, boolean, array, object, or null.

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

Status of the invocation

status_reasonstring

Status reason

Example response

{
  "action_name": "analyze",
  "id": "rr33xuugxj9h0bkf1rdt2bet",
  "output": "{\"result\":\"success\",\"data\":\"processed input\"}",
  "status": "queued",
  "status_reason": "Invocation queued for execution"
}