Output video

​

Causes the bot to output a video in the meeting.

Path Parameters
  • object_id
    Type: string
    required

    Bot ID

Headers
  • Authorization
    Type: string
    required

    API key for authentication

  • Content-Type
    Type: string
    required

    Should always be application/json

Body·
required
application/json
  • url
    Type: string
    min length:  
    1    Format: uri
    required

    URL of the video to output. Must be a valid URL to an mp4 file and start with https://.

  • loop
    Type: boolean

    Whether to loop the video. Defaults to false.

  • mute_video
    Type: boolean

    Whether to mute the video's audio track. Main purpose is to play a video as the bot's webcam while keeping the bot's microphone muted. Defaults to false.

Responses
  • 200

    Video request created successfully

  • 400

    Invalid input

  • 404

    Bot not found

Request Example for post/api/v1/bots/{object_id}/output_video
curl https://app.attendee.dev/api/v1/bots/bot_xxxxxxxxxxx/output_video \
  --request POST \
  --header 'Authorization: Token YOUR_API_KEY_HERE' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com/video.mp4",
  "loop": true
}'
No Body

Video request created successfully