Name: Serveka
Author: Serveka

DocsAPI ReferenceShow screen content

POST/api/v1/bots/{bot_id}/screen

Makes the bot load and display a URL on its virtual screen — effectively screen sharing a web page or document. Other participants see the content via the bot's camera feed. Requires `voice_agent_enabled: true` and bot status `active`.

Path Parameters

bot_idstringrequirede.g. "550e8400-e29b-41d4-a716-446655440000"

Bot UUID.

Headers

X-API-Keystringrequired

Your workspace API key.

Content-Typestringrequired

Must be `application/json`.

Request Body

application/json

urlstringrequired

URL to display on the bot's screen. Must be publicly accessible.

Example: "https://example.com/presentation.pdf"

Responses

202Screen share command sent.

404Bot not found or not currently active.

Try it live

API Configurationglobal · all endpoints

Base URL

API Key

POSThttps://api.serveka.com/api/v1/bots/550e8400-e29b-41d4-a716-446655440000/screen

Path Parameters

bot_id

Request Body

curl -X POST 'https://api.serveka.com/api/v1/bots/550e8400-e29b-41d4-a716-446655440000/screen' \
  -H "Content-Type: application/json"\
  -d '{
  "url": "https://example.com/presentation.pdf"
}'