RErender
Workflow Flows

Retrieve flow run step

Changed on

Retrieve a single step of a flow run, including its input, result and error. A sequence number can cover more than one step, so pass the stepKey the step listing reported to address one of those.

get/flow-runs/{flowRunId}/steps/{stepSeq}

Request

  • Base URL
    https://api.render.com/v1
  • Auth
    HTTP bearer

Query parameters

stepKeystring

The SDK's key for the step, as stepKey reports it in the step listing. Steps that share a sequence number are told apart by it. Omit it for a step the SDK recorded without one.

Response

Flow run step details

seqinteger required

The step's position in the flow run. Steps are numbered densely in the order the flow started them.

stepKeystring required

The SDK's key for the step.

namestring

For inline steps, the function's name. For detached steps, the task's registered name. Omitted for sleep steps.

type'inline' | 'detached' | 'sleep' required

The kind of step. inline runs a function inside the flow's process and retries in place. detached runs a registered task as its own task run. sleep is a durable sleep.

status'running' | 'succeeded' | 'failed' required

running until the step records an outcome, then succeeded or failed.

startedAtstring date-time required
completedAtstring date-time
wakeAtstring date-time

For sleep steps, when the sleep ends.

childTaskRunIdstring

For detached steps, the ID of the task run the step started.

inputunknown
resultunknown
errorstring

Error message if the step failed.

Example response

{
  "childTaskRunId": "trn-d0hp8fs9c44c73a6f1qg"
}

Changes