Deploy Your First Agent

Documentation Index

Fetch the complete documentation index at: https://docs.orpheus.run/llms.txt

Use this file to discover all available pages before exploring further.

​

Prerequisites

• Orpheus installed (Installation Guide)
• Daemon running (orpheus status shows healthy)

​

Step 1: Create Agent Directory

mkdir my-agent && cd my-agent

​

Step 2: Create agent.yaml

name: my-agent
runtime: python3
module: agent.py
entrypoint: handler

memory: 512
timeout: 60

scaling:
  min_workers: 1
  max_workers: 5

• name: Unique identifier for your agent
• runtime: python3 or nodejs20
• entrypoint: Function that handles requests
• min_workers: Keep this many workers always ready

​

Step 3: Create Your Handler

def handler(input_data):
    query = input_data.get('query', '')

    # Your agent logic here
    result = process(query)

    return {
        'result': result,
        'status': 'success'
    }

def process(query):
    return f"Processed: {query}"

​

Step 4: Deploy

orpheus deploy .

1. Agent packaged and sent to daemon
2. Workspace created at ~/.orpheus/workspaces/my-agent/
3. Worker pool started with min_workers
4. Agent ready to receive requests

​

Step 5: Verify

# Check it's deployed
orpheus list

# Check worker status
orpheus stats my-agent

​

Step 6: Run Your Agent

orpheus run my-agent '{"query": "hello world"}'

{
  "result": "Processed: hello world",
  "status": "success"
}

​

Updating Your Agent

orpheus deploy .

​

Removing an Agent

orpheus undeploy my-agent

​

Next Steps