Back to API Documentation

Orchestrator API

AI agent orchestration and workflow automation

Version
1.0.0
Base URL
ws://hyperion:9999/orchestrator
Endpoints
10

Endpoints

POST/api/v1/workflows/execute

Execute a workflow with specified agents and tasks

Request Body

{
  "workflowId": "auth-implementation-workflow",
  "agents": [
    {
      "id": "507f1f77bcf86cd799439011",
      "role": "developer",
      "capabilities": ["backend", "auth"]
    }
  ],
  "context": {
    "requirements": "JWT authentication with refresh tokens",
    "timeline": "3 days"
  }
}

Response

{
  "executionId": "exec_507f1f77bcf86cd799439020",
  "workflowId": "auth-implementation-workflow",
  "status": "running",
  "assignedAgents": ["507f1f77bcf86cd799439011"],
  "estimatedCompletion": "2025-01-11T17:00:00Z",
  "startedAt": "2025-01-08T19:00:00Z"
}
GET/api/v1/workflows/{workflowId}/status

Get current status of a workflow execution

Response

{
  "executionId": "exec_507f1f77bcf86cd799439020",
  "workflowId": "auth-implementation-workflow",
  "status": "running",
  "progress": {
    "totalSteps": 8,
    "completedSteps": 3,
    "currentStep": "implement-jwt-logic"
  },
  "agents": [
    {
      "id": "507f1f77bcf86cd799439011",
      "status": "working",
      "currentTask": "Write JWT authentication middleware"
    }
  ],
  "startedAt": "2025-01-08T19:00:00Z",
  "lastUpdated": "2025-01-08T21:30:00Z"
}
PUT/api/v1/workflows/{executionId}/pause

Pause a running workflow execution

Response

{
  "executionId": "exec_507f1f77bcf86cd799439020",
  "status": "paused",
  "pausedAt": "2025-01-08T22:00:00Z",
  "reason": "Manual pause requested"
}