Chat With Agent
Send a text message to an agent and get a response.
This endpoint allows REST API-based interactions with agents, useful for:
- Web chat interfaces
- API integrations
- Testing agent behavior
- Non-voice applications
Example:
Response:
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Request to chat with an agent via text.
User's message/query
1 - 2000Existing conversation ID to continue
Additional context for this query
Number of knowledge chunks to retrieve
1 <= x <= 20Response
Successful Response
Response from agent chat.
Agent's text response
Conversation ID for follow-up messages
Trace ID for debugging
Execution time in milliseconds
Version information (kb, policy, tools)
Tool output payload if applicable
Tool that was executed
Outcome classification