Interaction Create
Create an interaction.
This endpoint allows you to create an interaction with the specified data.
Parameters:
- data: Input data for the interaction.
- api_key: API key for authentication.
Returns:
- List of action results.
Raises:
- HTTPException(401): If the provided API key is invalid.
Authorizations
JWT Authorization header using the Bearer scheme. Example: 'Authorization: Bearer {token}'
Body
Name of the API.
User input data.
Additional context parameters that may include relevant info for the LLM
Control the response format available option are raw / formatted_html / formatted_md / formatted_text
Controls how the request is executed: dry_run_execution (returns request without sending), mock_execution (returns mock response from OpenAPI spec), apigene_execution (Apigene handles execution with stored credentials), customer_execution (request is forwarded to customer's webhook where the customer is responsible for executing it with their own credentials)
dry_run_execution, mock_execution, apigene_execution, customer_execution Customer-specific context data for correlation and tracking in customer execution mode
Overide the default model that will be used for executing this interaction
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.
Response
Successful Response
Name of the action.
The status code of the response.
Content of the request to relevant service.
Content of the response.
Addtional context information that is passed to the action
Customer execution context (with sensitive auth_info removed)
JMESPath expression used to filter/transform the response
