Skip to main content
GET
/
api
/
v1
/
background-jobs
/
{workflowId}
/
progress
Get background job progress
curl --request GET \
  --url http://localhost:3001/api/v1/background-jobs/{workflowId}/progress \
  --header 'x-api-key: <api-key>'
{
  "currentStep": "<string>",
  "completedSteps": 123,
  "totalSteps": 123,
  "isComplete": true,
  "isFailed": true,
  "error": "<string>",
  "resultData": {}
}

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Path Parameters

workflowId
string
required
Minimum string length: 1

Response

Default Response

currentStep
string
required
completedSteps
number
required
totalSteps
number
required
isComplete
boolean
required
isFailed
boolean
required
error
string
resultData
object