POST
/
computers
/
{id}
/
stream
/
stop
Stop Stream
curl --request POST \
  --url https://www.orgo.ai/api/computers/{id}/stream/stop \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Stream stopped successfully"
}

Description

Stop an active stream on the computer. This gracefully terminates the streaming process and releases resources.

Usage Example

# Stop the active stream
result = computer.stop_stream()

if result['success']:
    print("Stream stopped successfully")

Response Format

{
  "success": true,
  "message": "Stream stopped successfully"
}

Error Handling

If no stream is active, the endpoint will return an appropriate message:
{
  "success": false,
  "error": "No active stream to stop"
}

Best Practices

  1. Always stop streams when done to free resources
  2. Check stream status before stopping if unsure
  3. Handle cases where stream might have already terminated

Example Workflow

# Complete streaming workflow
try:
    # Start streaming
    computer.start_stream("my-connection")
    
    # Perform your automation
    computer.type("Running automated demo...")
    computer.bash("python my_script.py")
    
    # Always stop the stream
    computer.stop_stream()
    
except Exception as e:
    # Ensure stream is stopped even on error
    computer.stop_stream()
    raise e

Authorizations

Authorization
string
header
required

API key authentication using Bearer token

Path Parameters

id
string
required

Computer/Project name (e.g., computer-abc123)

Response

200
application/json

Stream stopped successfully

The response is of type object.