Update the voice agent settings for a bot

​

Updates the voice agent settings for a bot.

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·

application/json
  • screenshare_url
    Type: string

    Behaves the same as url, but the video will be displayed through screenshare instead of the bot's webcam. Currently, you cannot provide both url and screenshare_url. Set to "" to turn off.

  • url
    Type: string

    URL of a website containing a voice agent that gets the user's responses from the microphone. The bot will load this website and stream its video and audio to the meeting. The audio from the meeting will be sent to website via the microphone. See https://docs.attendee.dev/guides/voiceagents for further details. The video will be displayed through the bot's webcam. To display the video through screenshare, use the screenshare_url parameter instead. Set to "" to turn off.

Responses

  • 200

    Voice agent settings updated successfully

  • 400

    Invalid input

  • 404

    Bot not found

Request Example for patch/api/v1/bots/{object_id}/voice_agent_settings
curl https://app.attendee.dev/api/v1/bots/bot_xxxxxxxxxxx/voice_agent_settings \
  --request PATCH \
  --header 'Authorization: Token YOUR_API_KEY_HERE' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "",
  "screenshare_url": ""
}'
No Body

Voice agent settings updated successfully