Unix timestamp (seconds since epoch) indicating when this event was created. Use this to build timestamped transcripts or reconstruct the timeline of a conversation.
Turn index; increments when conversation.respond is processed. Groups utterances, tool calls, and speaking-state events for the same turn. See Event ordering and turn tracking.
Function name and serialized arguments from the LLM. Tavus does not execute tools server-side-your app performs the call per your integration.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Tavus","colors":{"primary":"#FA3862","light":"#FA3862","dark":"#FA3862"},"logo":{"light":"https://mintcdn.com/tavus/mlBBb4gkXXhWTLQi/logo/light_logo.png?fit=max\u0026auto=format\u0026n=mlBBb4gkXXhWTLQi\u0026q=85\u0026s=892e020f9d0afc49e64011dcae9d3dd6","dark":"https://mintcdn.com/tavus/mlBBb4gkXXhWTLQi/logo/dark_logo.png?fit=max\u0026auto=format\u0026n=mlBBb4gkXXhWTLQi\u0026q=85\u0026s=1268f09533ab55791e8ef8200d4a669f"},"favicon":{"light":"https://mintcdn.com/tavus/yC-TYEqHye998xbI/favicon_light.png?fit=max\u0026auto=format\u0026n=yC-TYEqHye998xbI\u0026q=85\u0026s=25642e844d8f4aaad82e6cb0d0cf44c3","dark":"https://mintcdn.com/tavus/yC-TYEqHye998xbI/favicon_dark.png?fit=max\u0026auto=format\u0026n=yC-TYEqHye998xbI\u0026q=85\u0026s=42861da3c81323c222cd6182eee43175"},"api":{"openapi":"openapi.yaml"},"navbar":{"links":[{"href":"https://discord.gg/5Y9Er6WNN5","label":"Community"},{"href":"https://status.tavus.io","label":"Status"},{"href":"mailto:support@tavus.io","label":"Get Support"}],"primary":{"type":"button","label":"Get Started","href":"https://maker.tavus.io/auth/sign-up?is_developer=true"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/tavus-io","discord":"https://discord.gg/5Y9Er6WNN5"}},"integrations":{"ga4":{"measurementId":"G-SBQHZWT4FS"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","mcp"],"display":"header"},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tavus","hasAudioNarration":false,"actualSubdomain":"tavus","customDomains":["docs.tavus.io"],"gitSource":{"type":"github","owner":"tavus-engineering","repo":"platform-api-developer-documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae2890b5cd6a3eab9a99c9b","collectionId":"198b9b1f-9e95-41cb-96fe-47aa390a3a41","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2890b5cd6a3eab9a99c9b"},"feedback":{"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae2890b5cd6a3eab9a99c9b","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"CVI","count":137},{"language":"default","tag":"API","count":93},{"language":"default","tag":"Build","count":92},{"language":"default","tag":"Skills","count":27},{"language":"default","tag":"Deploy","count":23},{"language":"default","tag":"Interaction Events","count":21},{"language":"default","tag":"Face","count":20},{"language":"default","tag":"Magic Canvas","count":17},{"language":"default","tag":"Deployments","count":16},{"language":"default","tag":"Tools","count":14}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"sections/event-schemas/conversation-toolcall","slug":"/sections/event-schemas/conversation-toolcall","pageMetadata":{"title":"Tool Call Event","openapi-schema":"tool_call","description":null,"href":"/sections/event-schemas/conversation-toolcall"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Tool Call Event","openapi-schema":"tool_call","description":null,"href":"/sections/event-schemas/conversation-toolcall"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"schemaData":{"description":"#### Outbound: Tavus signals an LLM tool call your client should run.\n\nConfigure tools on the PAL: [LLM tool calling](/sections/conversational-video-interface/pal/llm-tool).\n","type":"object","example":{"title":"Example","value":{"message_type":"conversation","event_type":"conversation.tool_call","seq":310,"conversation_id":"your-conversation-id","inference_id":"550e8400-e29b-41d4-a716-446655440000","turn_idx":5,"properties":{"name":"get_weather","arguments":"{\"location\":\"NYC\"}","tool_call_id":"call_abc123"}}},"properties":{"message_type":{"type":"string","description":"`conversation` for conversation-layer app messages.","example":"conversation","uniqueKey":"message_type","typeLabel":"string"},"event_type":{"type":"string","description":"`conversation.tool_call`.","example":"conversation.tool_call","uniqueKey":"event_type","typeLabel":"string"},"timestamp":{"type":"number","description":"Unix timestamp (seconds since epoch) indicating when this event was created. Use this to build timestamped transcripts or reconstruct the timeline of a conversation.","example":1746000000.123,"uniqueKey":"timestamp","typeLabel":"number"},"seq":{"type":"integer","description":"Monotonic per event; a higher `seq` was emitted later. Use with `turn_idx` as in [Event ordering and turn tracking](/sections/conversational-video-interface/interactions-protocols/overview#event-ordering-and-turn-tracking).","example":42,"uniqueKey":"seq","typeLabel":"integer"},"conversation_id":{"type":"string","description":"The unique identifier for the conversation.","example":"c123456","uniqueKey":"conversation_id","typeLabel":"string"},"inference_id":{"type":"string","description":"This is a unique identifier for a given utterance. In this case, it will be the user utterance that triggered the tool call.","example":"83294d9f-8306-491b-a284-791f56c8383f","uniqueKey":"inference_id","typeLabel":"string"},"turn_idx":{"type":"integer","description":"Turn index; increments when `conversation.respond` is processed. Groups utterances, tool calls, and speaking-state events for the same turn. See [Event ordering and turn tracking](/sections/conversational-video-interface/interactions-protocols/overview#event-ordering-and-turn-tracking).","example":3,"uniqueKey":"turn_idx","typeLabel":"integer"},"properties":{"type":"object","description":"Function name and serialized arguments from the LLM. Tavus does not execute tools server-side-your app performs the call per your integration.","properties":{"name":{"type":"string","description":"Function / tool name.","example":"get_weather","isRequired":true,"uniqueKey":"properties.name","typeLabel":"string"},"arguments":{"type":"string","description":"Serialized tool arguments (typically a JSON string from the LLM).","example":"{\"location\":\"NYC\"}","isRequired":true,"uniqueKey":"properties.arguments","typeLabel":"string"},"tool_call_id":{"type":"string","description":"Correlation id for the tool call; omitted when empty.","example":"call_abc123","uniqueKey":"properties.tool_call_id","typeLabel":"string"}},"required":["name","arguments"],"uniqueKey":"properties","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"originalFileLocation":"openapi.yaml"},"subdomain":"tavus","siteName":"Tavus","title":"Tool Call Event - Tavus","contextualStarterQuestions":[{"_id":"6ae289203e81024a3c3f29f9","deploymentId":"65baa7516ce8cd46ab1aa877","questionText":"What data does it contain?","status":"active","generatedBy":"contextual","path":"sections/event-schemas/conversation-toolcall","createdAt":"2026-10-28T23:45:36.194Z","updatedAt":"2026-10-28T23:45:36.194Z","__v":0},{"_id":"6ae289203e81024a3c3f29f8","deploymentId":"65baa7516ce8cd46ab1aa877","questionText":"How do I handle tool calls?","status":"active","generatedBy":"contextual","path":"sections/event-schemas/conversation-toolcall","createdAt":"2026-10-28T23:45:36.194Z","updatedAt":"2026-10-28T23:45:36.194Z","__v":0},{"_id":"6ae289203e81024a3c3f29f7","deploymentId":"65baa7516ce8cd46ab1aa877","questionText":"What is a tool call event?","status":"active","generatedBy":"contextual","path":"sections/event-schemas/conversation-toolcall","createdAt":"2026-10-28T23:45:36.194Z","updatedAt":"2026-10-28T23:45:36.194Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T23:45:31.434Z","originalFileLocation":"sections/event-schemas/conversation-toolcall.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Tavus\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tavus/Gv5r0opZCeHlefXw/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/tavus/Gv5r0opZCeHlefXw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tavus/Gv5r0opZCeHlefXw/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tavus/Gv5r0opZCeHlefXw/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tavus/Gv5r0opZCeHlefXw/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tavus/Gv5r0opZCeHlefXw/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tavus/Gv5r0opZCeHlefXw/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tavus/Gv5r0opZCeHlefXw/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tavus/Gv5r0opZCeHlefXw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Tool Call Event - Tavus\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tavus\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tavus.io/sections/event-schemas/conversation-toolcall\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tavus.mintlify.app/_mintlify/api/og/v2?division=Interaction+Events\u0026amp;title=Tool+Call+Event\u0026amp;theme=91cafe4cc1af35a0828d7f58\u0026amp;signature=e3316304b80ad3f6ce0b7b1ea61b2d77ceb8eb97c68e57b6e7d183bf88d5459e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Tool Call Event - Tavus\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tavus.mintlify.app/_mintlify/api/og/v2?division=Interaction+Events\u0026amp;title=Tool+Call+Event\u0026amp;theme=91cafe4cc1af35a0828d7f58\u0026amp;signature=e3316304b80ad3f6ce0b7b1ea61b2d77ceb8eb97c68e57b6e7d183bf88d5459e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/tavus/Gv5r0opZCeHlefXw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tavus\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FA3862\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tavus.io/sections/event-schemas/conversation-toolcall\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/sections/event-schemas/conversation-toolcall.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tavus.io/#organization\",\"name\":\"Tavus\",\"url\":\"https://docs.tavus.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tavus/mlBBb4gkXXhWTLQi/logo/light_logo.png?fit=max\u0026auto=format\u0026n=mlBBb4gkXXhWTLQi\u0026q=85\u0026s=892e020f9d0afc49e64011dcae9d3dd6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tavus.io#website\",\"name\":\"Tavus\",\"url\":\"https://docs.tavus.io\",\"publisher\":{\"@id\":\"https://docs.tavus.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tavus.io/sections/event-schemas/conversation-toolcall#webpage\",\"url\":\"https://docs.tavus.io/sections/event-schemas/conversation-toolcall\",\"name\":\"Tool Call Event\",\"dateModified\":\"2026-10-28T23:45:31.434Z\",\"isPartOf\":{\"@id\":\"https://docs.tavus.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tavus.io/sections/event-schemas/conversation-toolcall#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tavus.io/sections/event-schemas/conversation-toolcall#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Build\",\"item\":\"https://docs.tavus.io/sections/conversational-video-interface/quickstart/cvi-quickstart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Interaction Events\",\"item\":\"https://docs.tavus.io/sections/conversational-video-interface/interactions-protocols/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Tool Call Event\",\"item\":\"https://docs.tavus.io/sections/event-schemas/conversation-toolcall\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tavus.io/sections/event-schemas/conversation-toolcall#apireference\",\"headline\":\"Tool Call Event\",\"name\":\"Tool Call Event\",\"url\":\"https://docs.tavus.io/sections/event-schemas/conversation-toolcall\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tavus.io/sections/event-schemas/conversation-toolcall#webpage\"},\"dateModified\":\"2026-10-28T23:45:31.434Z\",\"publisher\":{\"@id\":\"https://docs.tavus.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tavus.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tavus\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Tavus","nav":{"global":null,"tabs":[{"tab":"CVI","groups":[{"group":"Getting Started","icon":"rocket","pages":[{"title":"Introduction","mode":"wide","href":"/sections/introduction"},{"title":"Agents \u0026 Automation","href":"/sections/agents-and-automation"},{"title":"What Is a PAL?","sidebarTitle":"What Is a PAL?","href":"/sections/conversational-video-interface/pal/what-is-a-pal"},{"title":"What Is CVI?","sidebarTitle":"What Is CVI?","href":"/sections/conversational-video-interface/overview-cvi"},{"group":"Sample Use Cases","pages":[{"title":"Sales Development Representative","href":"/sections/conversational-video-interface/conversation/usecases/sales-development-representative"},{"title":"AI Interviewer","href":"/sections/conversational-video-interface/conversation/usecases/ai-interviewer"},{"title":"Customer Service Agent","href":"/sections/conversational-video-interface/conversation/usecases/customer-service"},{"title":"Medical Intake","href":"/sections/conversational-video-interface/conversation/usecases/medical-intake"}]},{"title":"Models","href":"/sections/models"}]},{"group":"Guides","icon":"book-open","pages":[{"title":"PAL Strategies","href":"/sections/onboarding-guide/pal-strategies"},{"title":"Tavus Tool Calling","href":"/sections/onboarding-guide/tool-calling-examples"},{"title":"Reducing Join Latency","href":"/sections/onboarding-guide/latency-optimization"},{"title":"Prompting Guide","href":"/sections/onboarding-guide/prompting-guide"},{"title":"Objectives Prompting Guide","href":"/sections/onboarding-guide/objectives"},{"title":"EU AI Act Compliance","sidebarTitle":"EU AI Act","href":"/sections/onboarding-guide/eu-ai-act"}]},{"group":"Build","icon":"hammer","pages":[{"title":"API Conversation Quickstart","sidebarTitle":"API Conversation Quickstart","href":"/sections/conversational-video-interface/quickstart/cvi-quickstart"},{"group":"MCP \u0026 CLI","pages":[{"title":"Overview","href":"/sections/agent-tools/overview"},{"group":"MCP","pages":[{"title":"MCP Server","href":"/sections/agent-tools/mcp-server"},{"title":"MCP Tools Reference","href":"/sections/agent-tools/mcp-tools-reference"}]},{"title":"CLI","href":"/sections/agent-tools/cli"},{"title":"Agentic PAL Building \u0026 Testing","href":"/sections/agent-tools/pal-build-and-verify"}]},{"title":"Pipeline Modes","href":"/sections/conversational-video-interface/quickstart/pipeline-modes"},{"group":"PAL","pages":[{"title":"Overview","sidebarTitle":"PAL Overview","href":"/sections/conversational-video-interface/pal/overview"},{"title":"Stock PALs","mode":"wide","href":"/sections/conversational-video-interface/pal/stock-pals"},{"title":"PAL Editing Lifecycle","sidebarTitle":"Editing Lifecycle","href":"/sections/conversational-video-interface/pal/editing-lifecycle"},{"title":"Objectives","href":"/sections/conversational-video-interface/pal/objectives"},{"title":"Guardrails","href":"/sections/conversational-video-interface/guardrails"},{"title":"Knowledge Base","href":"/sections/conversational-video-interface/knowledge-base"},{"title":"Memories","href":"/sections/conversational-video-interface/memories"}]},{"group":"Face","pages":[{"title":"Overview","href":"/sections/faces/overview"},{"group":"Creating a Face","pages":[{"title":"Video to Face","sidebarTitle":"Video to Face","href":"/sections/faces/video-to-face-quickstart"},{"title":"Image to Face","sidebarTitle":"Image to Face","href":"/sections/faces/image-to-face-quickstart"},{"title":"Phoenix-4.5 Preview and Status","sidebarTitle":"4.5 Preview and Status","href":"/sections/faces/phoenix-45-preview-and-status"},{"title":"Voices for Image-Based Faces","sidebarTitle":"Voices for Image Faces","href":"/sections/faces/voices-for-image-based-faces"},{"group":"Model and Training Path","pages":[{"title":"Choose a Model and Training Path","href":"/sections/faces/which-training-path"},{"title":"Phoenix-4.5 Image Requirements","sidebarTitle":"Phoenix-4.5 Image","href":"/sections/faces/phoenix-45-image-requirements"},{"title":"Phoenix-4.5 Video Requirements","sidebarTitle":"Phoenix-4.5 Video","href":"/sections/faces/phoenix-45-video-requirements"},{"title":"Phoenix-4 Image Requirements","sidebarTitle":"Phoenix-4 Image","href":"/sections/faces/phoenix-4-image-requirements"},{"title":"Phoenix-4 Video Requirements","sidebarTitle":"Phoenix-4 Video","href":"/sections/faces/phoenix-4-video-requirements"},{"title":"Phoenix-3 Video Requirements (Legacy)","sidebarTitle":"Phoenix-3 Video (Legacy)","href":"/sections/faces/phoenix-3-video-requirements"}]}]},{"title":"Emotion Control with Phoenix-4 and Phoenix-4.5","sidebarTitle":"Emotion Control","href":"/sections/conversational-video-interface/quickstart/emotional-expression"},{"group":"Stock Faces","root":{"title":"Stock Faces","href":"/sections/faces/stock-faces"},"pages":[{"title":"Stock Face Model Map","href":"/sections/faces/stock-face-model-map"}]},{"title":"Face FAQs","href":"/sections/faces/face-faqs"}]},{"title":"Voices","href":"/sections/conversational-video-interface/voices"},{"group":"Pipeline Layers","pages":[{"group":"Text-to-Speech","pages":[{"title":"Text-to-Speech (TTS)","href":"/sections/conversational-video-interface/pal/tts"},{"title":"Language Support","href":"/sections/conversational-video-interface/language-support"},{"title":"Pronunciation Dictionaries","sidebarTitle":"Pronunciation Dictionaries","href":"/sections/conversational-video-interface/pal/pronunciation-dictionaries"}]},{"group":"Conversational Flow and STT","pages":[{"title":"Conversational Flow","sidebarTitle":"Conversational Flow","href":"/sections/conversational-video-interface/pal/conversational-flow"},{"title":"Speech-to-Text (STT)","sidebarTitle":"Speech-to-Text (STT)","href":"/sections/conversational-video-interface/pal/stt"}]},{"title":"Large Language Model (LLM)","href":"/sections/conversational-video-interface/pal/llm"},{"title":"Perception","sidebarTitle":"Perception","href":"/sections/conversational-video-interface/pal/perception"},{"title":"Screen Share","href":"/sections/conversational-video-interface/pal/screen-share"}]},{"group":"Skills","pages":[{"title":"Overview","href":"/sections/conversational-video-interface/skills/overview"},{"title":"Presentation","href":"/sections/conversational-video-interface/skills/presentation"},{"group":"Magic Canvas","pages":[{"title":"Magic Canvas Overview","sidebarTitle":"Overview","href":"/sections/conversational-video-interface/magic-canvas/overview"},{"title":"Magic Canvas Quickstart","sidebarTitle":"Quickstart","href":"/sections/conversational-video-interface/magic-canvas/quickstart"},{"group":"Components","pages":[{"title":"Canvas Components","sidebarTitle":"Components Overview","href":"/sections/conversational-video-interface/magic-canvas/components"},{"title":"Component: question","sidebarTitle":"question","href":"/sections/conversational-video-interface/magic-canvas/components/question"},{"title":"Component: input","sidebarTitle":"input","href":"/sections/conversational-video-interface/magic-canvas/components/input"},{"title":"Component: calendar","sidebarTitle":"calendar","href":"/sections/conversational-video-interface/magic-canvas/components/calendar"},{"title":"Component: scheduling_embed","sidebarTitle":"scheduling_embed","href":"/sections/conversational-video-interface/magic-canvas/components/scheduling-embed"},{"title":"Component: text","sidebarTitle":"text","href":"/sections/conversational-video-interface/magic-canvas/components/text"},{"title":"Component: image","sidebarTitle":"image","href":"/sections/conversational-video-interface/magic-canvas/components/image"},{"title":"Component: chart","sidebarTitle":"chart","href":"/sections/conversational-video-interface/magic-canvas/components/chart"},{"title":"Component: alert","sidebarTitle":"alert","href":"/sections/conversational-video-interface/magic-canvas/components/alert"}]},{"group":"API","pages":[{"title":"PAL Canvas Configuration","sidebarTitle":"Canvas Configuration","href":"/sections/conversational-video-interface/magic-canvas/api/configuration"},{"title":"Canvas Interactions","sidebarTitle":"Canvas Interactions","href":"/sections/conversational-video-interface/magic-canvas/api/interactions"}]},{"group":"Integrations","pages":[{"title":"Integration: Tavus-Hosted Embed and Widget","sidebarTitle":"Hosted Embed \u0026 Widget","href":"/sections/conversational-video-interface/magic-canvas/integrations/hosted"},{"title":"Integration: @tavus/cvi-ui MagicCanvas","sidebarTitle":"React SDK (@tavus/cvi-ui)","href":"/sections/conversational-video-interface/magic-canvas/integrations/cvi-ui-sdk"}]}]},{"title":"Internet Search","href":"/sections/conversational-video-interface/skills/internet-search"},{"title":"Browser Use","href":"/sections/conversational-video-interface/skills/browser-use"}]},{"group":"Tools","pages":[{"title":"Overview","href":"/sections/conversational-video-interface/pal/tools"},{"title":"Tool Calling for LLM","href":"/sections/conversational-video-interface/pal/llm-tool"},{"title":"Tool Calling for Perception","href":"/sections/conversational-video-interface/pal/perception-tool"},{"title":"Post-Call Actions","href":"/sections/conversational-video-interface/pal/post-call-tool"},{"title":"Tool Delivery","href":"/sections/conversational-video-interface/pal/llm-tool-delivery"},{"title":"Tool Authentication","href":"/sections/conversational-video-interface/pal/llm-tool-auth"}]},{"group":"Connectors","pages":[{"title":"MCP Connectors","href":"/sections/conversational-video-interface/pal/mcp-connectors"}]},{"group":"Conversation / Sessions","pages":[{"title":"Overview","href":"/sections/conversational-video-interface/conversation/overview"},{"title":"Conversation Recordings","href":"/sections/conversational-video-interface/quickstart/conversation-recordings"},{"group":"Customizations","pages":[{"title":"Audio-Only Conversation","href":"/sections/conversational-video-interface/conversation/customizations/audio-only"},{"title":"Call Duration and Timeout","href":"/sections/conversational-video-interface/conversation/customizations/call-duration-and-timeout"},{"title":"Closed Captions","href":"/sections/conversational-video-interface/conversation/customizations/closed-captions"},{"title":"Background Customizations","href":"/sections/conversational-video-interface/conversation/customizations/background-customizations"},{"title":"Private Rooms","href":"/sections/conversational-video-interface/conversation/customizations/private-rooms"},{"title":"Participant Limits","href":"/sections/conversational-video-interface/conversation/customizations/participant-limits"}]}]},{"group":"Interaction Events","pages":[{"title":"Interaction Events","sidebarTitle":"Overview","href":"/sections/conversational-video-interface/interactions-protocols/overview"},{"title":"Echo Interaction","href":"/sections/event-schemas/conversation-echo"},{"title":"Text Respond Interaction","href":"/sections/event-schemas/conversation-respond"},{"title":"Sensitivity Interaction","href":"/sections/event-schemas/conversation-sensitivity"},{"title":"Set Emotion Interaction","href":"/sections/event-schemas/conversation-set-emotion"},{"title":"Interrupt Interaction","href":"/sections/event-schemas/conversation-interrupt"},{"title":"Overwrite Conversational Context Interaction","href":"/sections/event-schemas/conversation-overwrite-context"},{"title":"Append Conversational Context Interaction","href":"/sections/event-schemas/conversation-append-context"},{"title":"Utterance Event","href":"/sections/event-schemas/conversation-utterance"},{"title":"Utterance Streaming Event","description":null,"href":"/sections/event-schemas/conversation-utterance-streaming"},{"title":"Tool Call Event","href":"/sections/event-schemas/conversation-toolcall"},{"title":"Tool Call Result","description":"Return a tool's result to the conversation by sending a conversation.tool_result event.","href":"/sections/event-schemas/conversation-tool-result"},{"title":"Started/Stopped Speaking Event","href":"/sections/event-schemas/conversation-started-stopped-speaking"},{"title":"Joined/Left Event","href":"/sections/event-schemas/conversation-joined-left"},{"title":"Perception Tool Call Event","href":"/sections/event-schemas/conversation-perception-tool-call"},{"title":"Perception Analysis Event","href":"/sections/event-schemas/conversation-perception-analysis"},{"title":"Agent Start Event","href":"/sections/event-schemas/conversation-agent-start"},{"title":"Agent Update Event","href":"/sections/event-schemas/conversation-agent-update"},{"title":"Agent Stop Event","href":"/sections/event-schemas/conversation-agent-stop"},{"title":"Canvas Interaction Event","href":"/sections/event-schemas/canvas-interaction"},{"title":"Wake/Sleep Phrase Detected Event","href":"/sections/event-schemas/system-wake-sleep-phrase-detected"}]}]},{"group":"Deploy","icon":"rocket","pages":[{"title":"CVI App Quickstart","sidebarTitle":"CVI App Quickstart","href":"/sections/conversational-video-interface/quickstart/build-first-app"},{"title":"CVI App: AI Prompt","sidebarTitle":"CVI App: AI Prompt","href":"/sections/conversational-video-interface/quickstart/ai-prompt-cvi-quickstart"},{"group":"Deployments","pages":[{"title":"Deployments Overview","href":"/sections/deployments/overview"},{"title":"Examples","href":"/sections/deployments/examples"},{"title":"Build with a coding agent","sidebarTitle":"Coding agents","href":"/sections/deployments/coding-agents"},{"title":"App builders and website builders","sidebarTitle":"App \u0026 website builders","href":"/sections/deployments/app-builders"},{"title":"Widget","href":"/sections/deployments/widget"},{"title":"Embed","href":"/sections/deployments/embed"},{"title":"Landing Page","href":"/sections/deployments/landing-page"},{"title":"Host Communication","href":"/sections/deployments/host-communication"}]},{"group":"Web","pages":[{"title":"Embed Conversational Video Interface","href":"/sections/integrations/embedding-cvi"},{"title":"Customize Conversation UI","href":"/sections/conversational-video-interface/quickstart/customize-conversation-ui"},{"group":"React Component Library","pages":[{"title":"Overview","href":"/sections/conversational-video-interface/component-library/overview"},{"title":"Blocks","href":"/sections/conversational-video-interface/component-library/blocks"},{"title":"Components","href":"/sections/conversational-video-interface/component-library/components"},{"title":"Hooks","href":"/sections/conversational-video-interface/component-library/hooks"},{"title":"Server","href":"/sections/conversational-video-interface/component-library/server"}]}]},{"title":"Mobile","href":"/sections/conversational-video-interface/mobile"},{"title":"Google Meet / Zoom / Teams","sidebarTitle":"Google Meet / Zoom / Teams","href":"/sections/conversational-video-interface/pal/meetings"},{"group":"Third-Party Integrations","pages":[{"title":"LiveKit Agent","href":"/sections/integrations/livekit"},{"title":"Pipecat","href":"/sections/integrations/pipecat"},{"title":"Agora","href":"/sections/integrations/agora"},{"title":"Speech-to-Speech","href":"/sections/integrations/speech-to-speech"}]}]},{"group":"Debug","icon":"bug","pages":[{"title":"Webhooks and Callbacks","href":"/sections/webhooks-and-callbacks"},{"title":"Errors and Status Details","href":"/sections/errors-and-status-details"},{"title":"Troubleshooting","href":"/sections/troubleshooting"},{"title":"FAQs","href":"/sections/conversational-video-interface/faq"}]},{"group":"Teams \u0026 SSO","icon":"users","pages":[{"title":"Teams","href":"/sections/teams/overview"},{"title":"Single Sign-On (SSO)","href":"/sections/teams/sso"}]},{"group":"Resources","icon":"bookmark","pages":[{"title":"Example Projects","url":"https://github.com/Tavus-Engineering/tavus-examples","href":"/sections/example-projects"}]}]},{"tab":"API","pages":[{"title":"API","href":"/api-reference/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/sections/changelog/changelog"}]},{"tab":"Other Products","pages":[{"title":"Other Products","href":"/sections/video/overview"}]},{"tab":"Enablement Docs","hidden":true,"pages":[{"title":"Enablement Docs","href":"/sections/enablement-docs"}]}]},"title":"Tool Call Event - Tavus","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}