GET /api/v1/tasks/{id}/control-state

​

Endpoint

GET http://localhost:8080/api/v1/tasks/{id}/control-state

​

Description

• Building UIs that show Pause / Resume button states
• Polling from backend services to coordinate other systems

​

Authentication

X-API-Key: sk_test_123456

​

Request

​

Headers

​

Path Parameters

​

Response

​

200 OK

{
  "is_paused": true,
  "is_cancelled": false,
  "paused_at": "2025-10-29T06:00:01Z",
  "pause_reason": "User requested pause",
  "paused_by": "user-123",
  "cancel_reason": "",
  "cancelled_by": ""
}

• paused_at is an empty string when the workflow has never been paused.
• is_cancelled reflects logical cancel state from control signals, not just Temporal termination.

​

404 Not Found

{ "error": "Task not found" }

​

401 / 403

{ "error": "Unauthorized" }

{ "error": "Forbidden" }