TAtavus
Conversations

List Canvas Interactions

Returns every Canvas interaction recorded for a conversation, oldest first. Uses the same field shape as the canvas.interaction webhook's properties object. Zero Data Retention (ZDR) conversations record no interactions, so data is an empty list.

Readable during and after the conversation. Call from your backend with your API key - not from the browser.

See Canvas interactions.

get/v2/conversations/{conversation_id}/canvas/interactions

Request

  • Base URL
    https://tavusapi.com
  • URL
    https://tavusapi.com/v2/conversations/{conversation_id}/canvas/interactions
  • Auth
    API key in header x-api-key

Response

Interaction history returned

Example response

{
  "data": [
    {
      "conversation_id": "c123456",
      "interaction_id": "ci_call_8f2d41_submit_5e0b7c2a",
      "tool_call_id": "call_8f2d41",
      "component": "canvas.question",
      "component_version": "v1",
      "type": "submit",
      "value": {
        "selected_option_ids": [
          "opt_2"
        ],
        "skipped": false
      },
      "metadata": {
        "client": "kiosk-web"
      },
      "created_at": "2026-06-09T21:14:03.518923"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.