Skip to main content
POST
App Execute Action

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: 'Authorization: Bearer {token}'

Query Parameters

genai_app
string
required

The name of the GenAI app.

app_type
string
default:mcp

The type of the app ('mcp' or 'agent').

Body

application/json

Input payload for triggering a MCP action. Contains the user's input and operation ID.

app_name
string
required

The identifier of the App to invoke.

user_input
string
required

The natural language input describing the desired action.

context
Context · object | null

Contextual parameters for the action, including operationId and any required inputs.

response_format
string | null
default:raw

Response format: 'raw' (default) or 'formatted_md'.

response_projection
string | null

JMESPath expression for response projection/transformation. Examples: '{name: name, email: email}' for field selection, 'items[?price > 100]' for filtering, 'items[*].name' for extracting arrays. Full JMESPath syntax supported.

customer_execution_context
Customer Execution Context · object | null

Customer-specific context data for correlation and tracking in customer execution mode

client_source
string | null

The MCP client that initiated this interaction (e.g., Cursor, Claude, VS Code, ChatGPT). Used for analytics.

template_id
string | null

Template id for UI rendering. If not provided, uses default template for the operation.

request_ui_template
boolean | null
default:false

When True, response is enriched with template_id and template_data for UI tools (e.g. run_action_ui). Set only for *_ui tool invocations.

Response

Successful Response

Response model for a MCP action. Contains the message or result returned by the MCP action.

message
any
required

The response message or result from the MCP action