Skip to main content
POST
/
computers
/
{id}
/
stream
/
start
Start Stream
curl --request POST \
  --url https://www.orgo.ai/api/computers/{id}/stream/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_name": "<string>"
}
'
{
  "success": true,
  "status": "<string>",
  "pid": 123
}

​
Description

Start streaming the computer’s display to an RTMP server. This allows you to spectate your agent’s computer in real-time through platforms like Twitch, YouTube Live, or custom RTMP servers.

​
Prerequisites

Before using this endpoint, you must:
  1. Configure an RTMP connection in your account settings
  2. Provide the connection name when starting the stream

​
Usage Example

# Start streaming to a configured connection
result = computer.start_stream("my-twitch-1")

# The computer's display is now being streamed
# Do your automation/demo
computer.type("Hello viewers!")
computer.bash("ls -la")

# Stop streaming when done
computer.stop_stream()

​
Connection Configuration

RTMP connections are configured in your account settings with:
  • A unique name (used in this API call)
  • RTMP server URL
  • Stream key (encrypted and stored securely)
  • Optional settings (bitrate, resolution, etc.)

​
Response

The response includes information about the streaming process: 
{
  "success": true,
  "status": "streaming",
  "pid": 12345,
  "start_time": "2024-01-20T10:30:00Z"
}

​
Common Use Cases

  • Live demonstrations of AI agents
  • Recording automation workflows
  • Debugging and monitoring agent behavior
  • Creating content for tutorials or showcases

Authorizations

​
Authorization
string
header
required

API key authentication. Format: sk_live_...

Path Parameters

​
id
string
required

Body

application/json
​
connection_name
string
required

Response

200 - application/json

Stream started

​
success
boolean
​
status
string
​
pid
integer