Skip to main content

Show Video Embed

Overview​

Enable your AI agent to display videos inline in the chat. The action renders an embedded player from popular platforms and can either use a fixed URL you provide or a URL the AI selects dynamically during the conversation.

Prerequisites​

Before setting up the Show Video Embed action, ensure you have:

  • ✅ A clear idea of which video platforms you intend to support
  • ✅ (Optional) A specific video URL if you want to hard‑code one

Step 1: Create Show Video Embed Action​

Access Agent Actions​

  1. Go to AI Agent Actions in your dashboard
  2. Click the Agent Action button to create a new action
AI Agent actions screen
  1. Select Show Video Embed from the list
Show Video Embed

Configure System Tool​

  1. Enable the action (toggle ON)
  2. Action Description: Describe when and how the agent should use this action (e.g., "Use to show relevant product demo videos when a user asks for a demo").
Show Video Embed
  1. Use Knowledge Base (toggle): When enabled, the AI agent will reference your uploaded knowledge base documents when generating responses for this action. This allows the agent to provide more accurate and contextual introductions to the videos based on your documentation. Keep it disabled if you want the agent to generate responses based solely on the action's prompt and conversation context.
Use Knowledge Base Toggle

Video Embed Configuration​

  1. Video Platform: Choose the platform where your video is hosted. Supported platforms include:
    • YouTube
    • Vimeo
    • Dailymotion
    • Loom
    • Wistia
    • Vidyard
    • Facebook
    • Instagram
    • TikTok
    • X (Twitter)
    • Twitch
    • Streamable

Note: Different platforms support different player options. Some platforms (like Instagram, TikTok, and X) use native embeds with limited customization.

Video Platform Selection

  1. Video URL Source: Choose how the video URL will be provided:

    • URL provided by AI Agent at conversation time: The AI agent will dynamically select and provide the video URL based on the conversation context
    • Use a specific video URL: You provide a fixed URL that will always be used when this action is triggered. If you choose this option, paste the video URL in the field that appears below.
Video URL from AI AgentVideo URL from Configuration

  1. Video Dimensions: Configure the size of the embedded video player:

    • Width (px): Set the width in pixels (200-1200)
    • Height (px): Set the height in pixels (150-800)
    • Aspect Ratio: Select a preset ratio or custom:
      • 16:9 (Widescreen) - Standard for most videos
      • 4:3 (Standard TV) - Traditional format
      • 1:1 (Square) - Social media format
      • 9:16 (Portrait/Mobile) - Vertical videos
      • Custom - Manually set width and height

    When you select a preset aspect ratio, the height automatically adjusts based on the width to maintain the correct proportions.

Video Dimensions Configuration
  1. Player Options: Customize the video player behavior.

Note: Available options depend on the selected platform. Some platforms may have options disabled if they don't support that feature.

  • Autoplay: Start playing the video automatically when displayed
  • Loop Video: Restart the video automatically when it finishes
  • Show Controls: Display video player controls (play, pause, volume, etc.)
  • Muted: Start the video with sound muted

Player Support by Platform:

  • Full support (all options): YouTube, Vimeo, Wistia, Vidyard
  • No Loop support: Dailymotion, Loom
  • Limited options: Facebook (Autoplay only), Twitch (Autoplay + Muted)
  • Native embed (no custom options): Instagram, TikTok, X (Twitter), Streamable
Player Options Configuration
  1. Response Message Prompt (Optional): Provide instructions for what the AI agent should say before showing the video. This helps the agent generate an appropriate introductory message that explains the video content and encourages the user to watch it. Leave empty to use the default prompt, which will generate a generic video introduction.
Response Message Prompt

Note: If you selected "URL provided by AI Agent at conversation time" in step 8, you'll see an informational message below this field stating: "The video URL will be provided by the AI agent during the conversation based on the user's request." This confirms that the AI will dynamically select the video URL at runtime.

AI Agent URL Confirmation
  1. Save Configuration: Once you've configured all the settings above, make sure the Enable toggle at the top right is ON (green), then click the Save button at the bottom of the configuration panel to save your settings.
Save Configuration

  1. Enable and Activate: After saving the configuration, make sure to:

    • Toggle the Enable switch at the top right to ON (green)
    • Click the Save button at the bottom to activate the action

    The action will only be available to your AI agent once it's enabled and saved. You can disable it at any time by toggling the Enable switch to OFF.

Enable and Save Action

Show Video Embede Preview​

When enabled, the agent will call this action to embed and display a video inline in the conversation. If you selected "URL provided by AI Agent," it will choose an appropriate video link at runtime; otherwise, it will use your fixed URL.

Enable and Save Action

Best Practices​

  • Keep the video relevant to the user's question to maintain flow
  • Prefer 16:9 for general content; use 9:16 for mobile/vertical content
  • Use a concise Response Message Prompt to introduce the video
  • Avoid autoplay with sound; consider Muted or disabled autoplay for UX