API Reference

Overview

Rimuru exposes a comprehensive REST API for programmatic access to the agent ecosystem. The API is available when the web interface is running.

Base URL

http://localhost:3456/api/v1

Authentication

Include your API token in requests:

curl -H "Authorization: Bearer ${RIMURU_API_TOKEN}" \ http://localhost:3456/api/v1/agents

Endpoints

Agents

List Agents

GET /api/v1/agents

Response:

{
  "agents": [
    {
      "id": "raphael",
      "name": "Raphael",
      "type": "core",
      "status": "active",
      "temperature": 0.2,
      "memory_used": "45MB",
      "tasks_completed": 12847
    }
  ]
}

Get Agent Details

GET /api/v1/agents/:id

Spawn Agent

POST /api/v1/agents
{
  "name": "my-agent",
  "type": "specialist",
  "temperature": 0.3,
  "skills": ["code-review", "testing"]
}

Delete Agent

DELETE /api/v1/agents/:id

Workflows

List Workflows

GET /api/v1/workflows

Run Workflow

POST /api/v1/workflows/:id/run
{
  "params": {
    "input_file": "./data.csv"
  },
  "parallel": true
}

Get Workflow Status

GET /api/v1/workflows/:id/status

Memory

Query Memory

GET /api/v1/memory?q=deployment+patterns&limit=10

Store Memory

POST /api/v1/memory
{
  "type": "semantic",
  "key": "deployment-best-practices",
  "value": "Use blue-green deployment for zero-downtime..."
}

MCP Servers

List Servers

GET /api/v1/mcp

Add Server

POST /api/v1/mcp{"name": "my-database", "command": "npx", "args": ["-y", "@mcp/database"], "env": {"DATABASE_URL": "$DATABASE_URL"}}

System

Health Check

GET /api/v1/health

Status

GET /api/v1/status

Rate Limiting

• 100 requests/minute per token
• 1000 requests/minute for pro tokens
• Headers: X-RateLimit-Remaining, X-RateLimit-Reset

Error Codes

SDK Support

# TypeScript
npm install @rimuru/sdk

# Python
pip install rimuru-sdk

# Go
go get github.com/rimuru/sdk-go