SIP PBX icon

SIP PBX

AI → Invoke AI Tool

AI-generated

Summary

Invoke a configured AI tool with specified parameters and return its response.

Inputs

  • ref (required) — Stable user‑defined public name for this trigger group; used in runtime state, outputs, and trigger takeover rules.
  • aiToolDescription (required) — Natural‑language description of what this function does; shown to the AI model to decide when to call it.
  • aiFlowParams (required) — Static or expression‑based values from the current workflow context; passed to the AI trigger as a flowParams object.
  • aiToolParams (required) — Arguments the AI model is allowed to fill in when it calls this function; passed to the AI trigger as a toolParams object.

Output shape

JSON object containing the AI tool's response payload

May include optional fields depending on the tool; errors are propagated as execution failures.

Examples

Example 1: Execute a text generation request using a public AI tool named 'text_generation'

Set AI Tool Ref to text_generation, provide a Function Description like 'Generate a short story', and optionally add Flow Parameters such as 'max_tokens=150'.

Example 2: Call an image‑analysis AI tool to classify an uploaded image

Assign AI Tool Ref as 'image_classifier', write a Function Description 'Identify objects in the image', and define Function Parameters with a required String 'image_url' and a Boolean 'return_metadata'.

Links

Discussion