Actions2
- Agent Actions
- Document Actions
Agent → Invoke
AI-generatedSummary
Invoke a ShopfloorGPT agent synchronously with a prompt and return its response and references. Optionally specify a response language, save the interaction to history, continue an existing session, or scope the agent to machines or files.
Inputs
- agentId (required) — Required UUID of the agent to invoke.
- prompt (required) — Required user prompt to send to the agent.
- additionalFields — Optional collection of response language, conversation history, session, and context settings.
- additionalFields.language — Optional BCP-47 response language code, such as en or de. Defaults to en when omitted or empty.
- additionalFields.saveToHistory — Enable to request persistence of the interaction to conversation history and a sessionId in the response. Sent only when true.
- additionalFields.sessionId — Optional session ID to continue an existing conversation. Sent when nonempty.
- additionalFields.contextInfo — Optional JSON context to scope the agent to machines or files, for example {"machineNames":["CNC-001"],"files":null}. JSON strings are parsed before sending; the literal string {} is omitted.
Output shape
One JSON item per input item containing response, agentId, references, and sessionId from the API response.
Field contents and availability depend on the API; the node does not supply defaults for missing response fields. With Continue On Fail enabled, a failed item returns {"error":"message"}; otherwise the error stops execution.