Invoke an action

POST/invocations

Invoke an action.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Invocation parameters

TypeScript Definitions

Use the request body type in TypeScript.

app_name*string

Name of the application

version*string

Version of the application

Default"latest"

payload?string

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

action_name*string

Name of the action to invoke

async?boolean

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

Defaultfalse

async_timeout_seconds?integer

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

Range10 <= value <= 3600

Default900

Response

application/json

Invocation created successfully

id*string

ID of the invocation

action_name*string

Name of the action invoked

status*string

Status of the invocation

Value in

"queued"
"running"
"succeeded"
"failed"

status_reason?string

Status reason

output?string

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

curl -X POST "https://example.com/invocations" \  -H "Content-Type: application/json" \  -d '{    "app_name": "string",    "version": "latest",    "action_name": "string"  }'

{  "id": "string",  "action_name": "string",  "status": "queued",  "status_reason": "string",  "output": "string"}

{  "id": "string",  "action_name": "string",  "status": "queued",  "status_reason": "string",  "output": "string"}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}