WorkflowSteps

Get the status of a workflow step

Changed on
get/v2/consumer/workflows/{workflowId}/steps/{stepName}

Request

  • The document declares no server URL.
  • Auth: none required

Path parameters

workflowIdstring required
stepNamestring required

Response

OK

$typestring required
namestring required

The name of the workflow step. Used to allow steps to refer to one another.

priority'high' | 'normal' | 'low' | 'idle' required
timeoutstring date-span nullable
retriesinteger nullable
status'unassigned' | 'preparing' | 'scheduled' | 'processing' | 'succeeded' | 'failed' | 'expired' | 'canceled' required
startedAtstring date-time nullable
completedAtstring date-time nullable
metadataobject required
estimatedProgressRatenumber double nullable

Estimated progress of this step, or null when there is no estimate (including once the step reaches a final status).

Changes

  • 48103e81ab94Revision changes
    • info

      added liveTextToSpeech promptModeration mapping keys to the response discriminator for the response status

  • e3d4f2c08853Revision changes
    • warning

      added the new idle enum value to the // response property for the response status

    • warning

      added the new idle enum value to the response property for the response status

    • info

      added liveTranscription merge mapping keys to the response discriminator for the response status