Submit Tool Result

Submit the result of a client-side tool execution.

When the agent calls a client-side tool, the widget executes it and sends the result back here. This sends the result as a follow-up message so the agent can see what happened and respond accordingly.

post/api/chat/tool-result

Request body

product_idstring required

conversation_idstring required

tool_call_idstring required

tool_namestring required

resultobject required

identity_tokenstring nullable

modelstring nullable

user_timezonestring nullable

user_local_timestring nullable

consent_approvedboolean nullable

tool_argumentsobject nullable

agent_modestring nullable

subdomainstring nullable

languagestring nullable

Response

Successful Response

{"stackTrail":"paths:/api/chat/tool-result:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 3 revisions of this API.