Runners Quickstart

curl -X POST http://localhost:8002/gateway/admin/runners/ \
  -H "Content-Type: application/json" \
  -H "X-CM-API-Key: cm_sk_your_key_here" \
  -d '{
    "provider_type": "fake",
    "tool_profile": "locked",
    "ttl_seconds": 3600
  }'

{
  "runner_id": "runner_abc123def456",
  "state": "ready",
  "provider_type": "fake",
  "tool_profile": "locked",
  "ttl_seconds": 3600
}

curl -X POST http://localhost:8002/gateway/admin/runners/runner_abc123def456/start \
  -H "X-CM-API-Key: cm_sk_your_key_here"

curl -X POST "http://localhost:8002/gateway/admin/runners/runner_abc123def456/exec?session_id=sess_xyz" \
  -H "Content-Type: application/json" \
  -H "X-CM-API-Key: cm_sk_your_key_here" \
  -d '{
    "argv": ["echo", "Hello from the sandbox!"],
    "timeout_seconds": 30
  }'

curl "http://localhost:8002/gateway/admin/runners/runner_abc123def456/events?limit=20" \
  -H "X-CM-API-Key: cm_sk_your_key_here"

# Stop the session
curl -X POST "http://localhost:8002/gateway/admin/runners/runner_abc123def456/stop?session_id=sess_xyz" \
  -H "X-CM-API-Key: cm_sk_your_key_here"
 
# Terminate the runner
curl -X POST http://localhost:8002/gateway/admin/runners/runner_abc123def456/terminate \
  -H "X-CM-API-Key: cm_sk_your_key_here"

from curate_me import CurateMe
 
client = CurateMe(api_key="cm_sk_your_key_here")
gw = client.gateway
 
# Create and start
runner = gw.runners.create(provider_type="fake", tool_profile="locked")
session = gw.runners.start_session(runner["runner_id"])
 
# Execute commands
result = gw.runners.exec_command(
    runner["runner_id"],
    session["session_id"],
    argv=["echo", "Hello!"],
)
print(result["stdout"])  # "fake output"
 
# View events
events = gw.runners.get_events(runner["runner_id"])
for event in events["events"]:
    print(f"  {event['event_type']} at {event['timestamp']}")
 
# Clean up
gw.runners.stop_session(runner["runner_id"], session["session_id"])
gw.runners.terminate(runner["runner_id"])

import { CurateMe } from '@curate-me/sdk';
 
const client = new CurateMe({ apiKey: 'cm_sk_your_key_here' });
 
// Create and start
const runner = await client.runners.create({ tool_profile: 'locked' });
const session = await client.runners.startSession(runner.runner_id);
 
// Execute commands
const result = await client.runners.execCommand(
  runner.runner_id,
  session.session_id,
  ['echo', 'Hello!'],
);
console.log(result.stdout);
 
// View events
const events = await client.runners.getEvents(runner.runner_id);
events.events.forEach((e) => console.log(`  ${e.event_type}`));
 
// Clean up
await client.runners.stopSession(runner.runner_id, session.session_id);
await client.runners.terminate(runner.runner_id);

# Create a runner
curate runners create --provider fake --profile locked
 
# Start a session
curate runners start runner_abc123
 
# Execute a command
curate runners exec runner_abc123 sess_xyz echo "Hello!"
 
# View events
curate runners events runner_abc123
 
# Stream live output
curate runners stream runner_abc123
 
# Terminate
curate runners terminate runner_abc123 --yes