Skip to main content

Endpoint

POST http://localhost:8080/api/v1/tasks/{id}/resume

Description

Resumes a task that was previously paused via the pause endpoint. The workflow continues from the last checkpoint and proceeds normally.

Authentication

Required: Yes Include API key in header:
X-API-Key: sk_test_123456

Request

Headers

HeaderRequiredDescription
X-API-KeyYesAPI authentication key
Content-TypeNoapplication/json if body
traceparentNoW3C trace context

Path Parameters

ParameterTypeRequiredDescription
idstringYesTask ID (Temporal workflow ID)

Body Parameters

ParameterTypeRequiredDescription
reasonstringNoOptional resume reason note

Request Body Example

{
  "reason": "User approved continuation"
}

Response

202 Accepted

{
  "success": true,
  "message": "Resume signal sent",
  "task_id": "task-123"
}

404 Not Found

{ "error": "Task not found" }

409 Failed Precondition

Cannot resume task in invalid state:
{ "error": "cannot resume completed task" }
{ "error": "cannot resume failed task" }
{ "error": "cannot resume cancelled task" }
{ "error": "cannot resume timed out task" }
{ "error": "task is not paused" }

401 / 403

{ "error": "Unauthorized" }
or
{ "error": "Forbidden" }

Notes

  • Only has an effect for tasks that are currently paused; calling resume on a non-paused task returns a 409 Failed Precondition error.
  • State validation ensures clear error messages for invalid operations (e.g., resuming completed or already-running tasks).
  • SSE streams emit workflow.resumed when a paused workflow continues.