Send Typing Indicator
AI-generatedOverview
This node operation sends a typing indicator to a specified conversation in the Lerty AI system. It allows users to show or stop the typing indicator for an agent within a conversation, which can enhance the interactivity and user experience in chat applications by signaling when an agent is typing.
Use Case Examples
- In a customer support chatbot, use this operation to show the typing indicator when the AI agent is preparing a response.
- In a messaging app integrated with Lerty, send a typing indicator to inform users that the agent is actively responding.
Properties
| Name | Meaning |
|---|---|
| Agent | The ID of the Lerty AI agent to send the typing indicator from. It can be selected from a list or specified by ID. |
| Conversation ID | The ID of the conversation to which the typing indicator will be sent. |
| Typing | Boolean flag indicating whether to show (true) or stop (false) the typing indicator. |
| Additional Fields | Optional additional parameters such as metadata key-value pairs and request timeout in milliseconds. |
Output
JSON
conversation_id- The ID of the conversation where the typing indicator was sent.agent_id- The ID of the agent sending the typing indicator.typing- Boolean indicating whether the typing indicator is active (true) or stopped (false)._originalTriggerData- The original input data JSON object that triggered this operation, included for reference.
Dependencies
- Lerty API credentials including base URL and API token for authentication.
Troubleshooting
- Ensure the conversation ID is provided and does not contain unevaluated expressions (e.g., '{{' or '}}').
- Verify that the agent ID is valid and the API credentials are correctly configured.
- If the response webhook URL is missing in the input data, the node falls back to the agent webhook endpoint automatically.
- Common errors include validation errors (HTTP 422) if the conversation ID or other parameters are invalid, which will be reported with detailed messages.