---
url: /orchestration/reference/operations/GetWorkflowStep.md
description: 'GET /v2/consumer/workflows/{workflowId}/steps/{stepName} — Get the status of a workflow step'
---

> Documentation index: https://developer.civitai.com/llms.txt — every page on this site has a markdown version at its URL + `.md`.

# Get the status of a workflow step

`GET https://orchestration.civitai.com/v2/consumer/workflows/{workflowId}/steps/{stepName}`

Operation `GetWorkflowStep` · WorkflowSteps · Civitai Orchestration API, generated from the published OpenAPI spec ([v2-consumers.json](https://developer.civitai.com/openapi/v2-consumers.json)); the interactive HTML page is this URL without `.md`.

## Authentication

Send `Authorization: Bearer <token>` (the spec's `ApiKey` scheme); this operation documents `401 Unauthorized` for a missing or invalid token. See [Authentication](https://developer.civitai.com/orchestration/guide/authentication.md).

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `workflowId` | path | string | yes |  |
| `stepName` | path | string | yes |  |

## Responses

### 200 OK

Content type: `application/json`.

Schema `WorkflowStep`.

Polymorphic: the `$type` field selects the concrete type — `aceStepAudio` → `AceStepAudioStep`, `audioCaptioning` → `AudioCaptioningStep`, `audioModeration` → `AudioModerationStep`, `blobArchive` → `BlobArchiveStep`, `chatCompletion` → `ChatCompletionStep`, `comfy` → `ComfyStep`, `comfyNodepackSnapshot` → `ComfyNodepackSnapshotStep`, `composeMedia` → `ComposeMediaStep`, `convertImage` → `ConvertImageStep`, `customComfy` → `CustomComfyStep`, `imageBackgroundRemoval` → `ImageBackgroundRemovalStep`, `imageGen` → `ImageGenStep`, `imageResourceTraining` → `ImageResourceTrainingStep`, `imageToSvg` → `ImageToSvgStep`, `imageUpload` → `ImageUploadStep`, `imageUpscaler` → `ImageUpscalerStep`, `liveTextToSpeech` → `LiveTextToSpeechStep`, `liveTranscription` → `LiveTranscriptionStep`, `mediaCaptioning` → `MediaCaptioningStep`, `mediaHash` → `MediaHashStep`, `mediaRating` → `MediaRatingStep`, `merge` → `MergeStep`, `miniMaxMusic3` → `MiniMaxMusic3Step`, `model3DPreview` → `Model3DPreviewStep`, `modelHash` → `ModelHashStep`, `modelParseMetadata` → `ModelParseMetadataStep`, `polyGen` → `PolyGenStep`, `preprocessImage` → `PreprocessImageStep`, `preprocessVideo` → `PreprocessVideoStep`, `promptEnhancement` → `PromptEnhancementStep`, `promptModeration` → `PromptModerationStep`, `qwenImageBench` → `QwenImageBenchStep`, `soniloAudioGen` → `SoniloAudioGenStep`, `textToImage` → `TextToImageStep`, `textToSpeech` → `TextToSpeechStep`, `training` → `TrainingStep`, `transcode` → `TranscodeStep`, `transcription` → `TranscriptionStep`, `videoBackgroundRemoval` → `VideoBackgroundRemovalStep`, `videoEnhancement` → `VideoEnhancementStep`, `videoFrameExtraction` → `VideoFrameExtractionStep`, `videoGen` → `VideoGenStep`, `videoInterpolation` → `VideoInterpolationStep`, `videoMetadata` → `VideoMetadataStep`, `videoUpscaler` → `VideoUpscalerStep`, `wdTagging` → `WDTaggingStep`, `webScrape` → `WebScrapeStep`, `webSearch` → `WebSearchStep`, `yuE2` → `YuE2Step`.

| Field | Type | Required | Description |
|---|---|---|---|
| `$type` | string | yes |  |
| `name` | string | yes | The name of the workflow step. Used to allow steps to refer to one another. |
| `priority` | `Priority` (one of `high`, `normal`, `low`, `idle`) | yes |  |
| `timeout` | string (date-span), nullable | no |  |
| `retries` | integer (int32), nullable | no |  |
| `status` | `WorkflowStatus` (one of `unassigned`, `preparing`, `scheduled`, `processing`, `succeeded`, `failed`, `expired`, `canceled`) | yes |  |
| `startedAt` | string (date-time), nullable | no |  |
| `completedAt` | string (date-time), nullable | no |  |
| `metadata` | object | yes |  |
| `estimatedProgressRate` | number (double), nullable | no | Estimated progress of this step, or null when there is no estimate (including once the step reaches a final status). |
| `preparation` | array of `WorkflowStepPreparationResource`, nullable | no | Every resource download this step is waiting on, the one holding it back first. Only set while the step is preparing. |
| `queuePosition` | `WorkflowStepQueuePosition` | no | The step's queue position, aggregated across its jobs (worst support, fewest preceding jobs, earliest estimated start, latest estimated completion). Null once the step starts processing. |
| `warnings` | array of `WorkflowStepWarning`, nullable | no | Non-fatal warnings about this step, such as a requested model that is scheduled for retirement. Omitted when there are none. |

### 401 Unauthorized

Content type: `application/json`.

Schema `ProblemDetails`.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | string, nullable | no |  |
| `title` | string, nullable | no |  |
| `status` | integer (int32), nullable | no |  |
| `detail` | string, nullable | no |  |
| `instance` | string, nullable | no |  |

### 404 Not Found

Content type: `application/json`.

Schema `ProblemDetails` — fields as listed above.