Skip to main content
POST
/
api
/
v1
/
bots
/
{object_id}
/
output_image
Output Image
curl --request POST \
  --url https://api.example.com/api/v1/bots/{object_id}/output_image \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "data": "<string>"
}
'
Causes the bot to display an image through its video feed in the meeting.

​
Authentication

Requires API key authentication via the Authorization header.

​
Path Parameters

​
object_id
string
required
Bot ID (e.g., bot_xxxxxxxxxxx)

​
Request Body

​
type
string
required
Image content type. Currently only image/png is supported.
​
data
string
required
Base64 encoded image data in PNG format

​
Response

Returns a 200 status code when the image request is successfully created.

​
Example Request

curl -X POST https://app.attendee.dev/api/v1/bots/bot_weIAju4OXNZkDTpZ/output_image \
  -H "Authorization: Token YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "image/png",
    "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="
  }'

​
Example Response

{
  "status": "success"
}

​
Error Responses

​
400 Bad Request

Returned when:
  • Invalid image data or format
  • Missing required fields
  • Bot is not in a valid state to output images

​
404 Not Found

Returned when the bot ID does not exist.
The image will be displayed through the bot’s video feed. The example above shows a base64-encoded red pixel in PNG format.

Build docs developers (and LLMs) love

Get started for freeTalk to us