Sign in

v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-31135175384.2 KB
Invocations

Invoke an action

Invoke an action.

post/invocations

Request body

app_namestring required

Name of the application

versionstring required

Version of the application

payloadstring

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

action_namestring required

Name of the action to invoke

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.

Example request

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

Response

Invocation created successfully

idstring required

ID of the invocation

action_namestring required

Name of the action invoked

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

Status of the invocation

status_reasonstring

Status reason

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.

Example response

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