LearningSuite icon

LearningSuite

Interact with LearningSuite API (powered by agentur-systeme.de)

Actions100

AI → Agent Chat

AI-generated

Summary

Send a message to a specified AI agent within the LearningSuite environment to engage in a chat conversation, optionally continuing an existing chat or starting a new one.

Inputs

  • AI Agent Name or ID (required) — Select the AI agent to chat with from a list or specify its ID. Use "concierge" as a shortcut for the global AI Concierge agent.
  • User Name or ID (required) — Select the user ID of the member sending the message from a list or specify it directly.
  • Message (required) — Enter the message text to send to the AI agent.
  • Chat ID — Optionally specify the chat or conversation ID to continue an existing chat. Leave empty to start a new chat.
  • Include Chat History — Choose whether to include the full chat history in the response; defaults to false, returning only the latest AI agent message.
  • End Chat — Indicate whether to end the chat after sending this message. If true, the agent will not generate a reply, useful for concluding form interactions.
  • Metadata — Provide any metadata from a previous agent response as a JSON object to include in the next request.
  • Profile Context — Optionally supply profile context as a JSON object when interacting with custom fields or forms; leave empty ({}) if not used.

Output shape

A JSON response containing the AI agent's reply message and related chat data.

The response includes either the full chat history or just the latest agent response depending on the 'Include Chat History' setting. If 'End Chat' is true, no agent response is returned.

Examples

Example 1: Start a new chat with a named AI agent

Specify AI agent and user IDs, provide a message, leave Chat ID empty, and disable End Chat.

Example 2: Continue an existing chat showing full history

Set the existing Chat ID, provide the message, set Include Chat History to true.

Example 3: End a chat without agent response

Provide necessary IDs and message, and set End Chat to true to terminate the conversation after sending.

Links

Discussion