---
title: "Returns the workflow identified by workflowId."
method: GET
path: "/workflow/{workflowId}"
tags: ["Workflow"]
---

# Returns the workflow identified by workflowId.

`GET /workflow/{workflowId}`

## Path parameters

- `workflowId` string, required

## Response `200`

OK

- GetWorkflowByIdEndpointOutput
  - `workflow` union, required
    - object
      - `_t` 'EvaluationWorkflow', required
      - `id` string, required
      - `validationSetId` string, required
      - `state` 'Created' | 'Started' | 'Labeling' | 'Paused' | 'Done' | 'Failed', required
      - `referee` union, required
        - object
          - `_t` 'BudgetRefereeConfig', required
          - `totalBudget` integer, required
          - `totalServeBudget` integer, nullable
        - object
          - `_t` 'NaiveRefereeConfig', required
          - `responsesRequired` integer
        - object
          - `_t` 'NeverEndingRefereeConfig', required
        - object
          - `_t` 'ProbabilisticAttachCategoryRefereeConfig', required
          - `threshold` number, double, required
          - `maxVotes` integer, required
        - object
          - `_t` 'QuorumRefereeConfig', required
          - `maxVotes` integer, required
          - `threshold` integer, required
      - `name` string, required
      - `ownerMail` string, nullable, required
      - `organizationId` string, required
    - object
      - `_t` 'GroupedRankingWorkflowModel', required
      - `id` string, required
      - `referee` union, required
        - object
          - `_t` 'BudgetRefereeConfig', required
          - `totalBudget` integer, required
          - `totalServeBudget` integer, nullable
        - object
          - `_t` 'NaiveRefereeConfig', required
          - `responsesRequired` integer
        - object
          - `_t` 'NeverEndingRefereeConfig', required
        - object
          - `_t` 'ProbabilisticAttachCategoryRefereeConfig', required
          - `threshold` number, double, required
          - `maxVotes` integer, required
        - object
          - `_t` 'QuorumRefereeConfig', required
          - `maxVotes` integer, required
          - `threshold` integer, required
      - `state` 'Created' | 'Started' | 'Labeling' | 'Paused' | 'Done' | 'Failed', required
      - `criteria` string, required
      - `name` string, required
      - `ownerMail` string, nullable, required
      - `organizationId` string, required
      - `rankingConfig` union
        - IRankingConfigBradleyTerryRankingConfig
          - `_t` 'BradleyTerryRankingConfig', required
          - `startingScore` integer, required
        - IRankingConfigEloConfig
          - `_t` 'EloConfig', required
          - `startingScore` integer, required
          - `kFactor` integer, required
          - `scalingFactor` integer, required
    - object
      - `_t` 'RankingWorkflowModel', required
      - `id` string, required
      - `referee` union, required
        - object
          - `_t` 'BudgetRefereeConfig', required
          - `totalBudget` integer, required
          - `totalServeBudget` integer, nullable
        - object
          - `_t` 'NaiveRefereeConfig', required
          - `responsesRequired` integer
        - object
          - `_t` 'NeverEndingRefereeConfig', required
        - object
          - `_t` 'ProbabilisticAttachCategoryRefereeConfig', required
          - `threshold` number, double, required
          - `maxVotes` integer, required
        - object
          - `_t` 'QuorumRefereeConfig', required
          - `maxVotes` integer, required
          - `threshold` integer, required
      - `pairMakerInformation` union, required
        - object
          - `_t` 'FullPermutationPairMakerInformation', required
        - object
          - `_t` 'OnlinePairMakerInformation', required
          - `randomMatchesRatio` number, float, required
          - `totalComparisonBudget` integer, required
          - `currentComparisonBudget` integer, required
      - `state` 'Created' | 'Started' | 'Labeling' | 'Paused' | 'Done' | 'Failed', required
      - `criteria` string, required
      - `name` string, required
      - `rankingConfig` union
        - IRankingConfigBradleyTerryRankingConfig
          - `_t` 'BradleyTerryRankingConfig', required
          - `startingScore` integer, required
        - IRankingConfigEloConfig
          - `_t` 'EloConfig', required
          - `startingScore` integer, required
          - `kFactor` integer, required
          - `scalingFactor` integer, required
      - `context` string, nullable, required
      - `contextAsset` union, required
        - IAssetFileAsset
          - `_t` 'FileAsset', required
          - `fileName` string, required
          - `metadata` MetadataModelCollection, required
          - `identifier` string, required
        - IAssetMultiAsset
          - `_t` 'MultiAsset', required
          - `assets` IAsset[], required
            - union
              - …
          - `metadata` MetadataModelCollection, required
          - `identifier` string, required
        - IAssetNullAsset
          - `_t` 'NullAsset', required
          - `metadata` MetadataModelCollection, required
          - `identifier` string, required
        - IAssetTextAsset
          - `_t` 'TextAsset', required
          - `text` string, required
          - `metadata` MetadataModelCollection, required
          - `identifier` string, required
      - `ownerMail` string, nullable, required
      - `organizationId` string, required
    - object
      - `_t` 'SimpleWorkflowModel', required
      - `id` string, required
      - `state` 'Created' | 'Started' | 'Labeling' | 'Paused' | 'Done' | 'Failed', required
      - `blueprint` union, required
        - object
          - `_t` 'ClassifyBlueprint', required
          - `categories` AttachCategoryWorkflowRapidBlueprintCategory[], required
            - `label` string, required
            - `value` string, required
          - `title` string, required
        - object
          - `_t` 'BoundingBoxBlueprint', required
          - `target` string, required
        - object
          - `_t` 'CompareBlueprint', required
          - `criteria` string, required
          - `indexIdentifiers` string[], required
        - object
          - `_t` 'FreeTextBlueprint', required
          - `question` string, required
          - `shouldValidateResponse` boolean, required
          - `validationSystemPrompt` string, nullable
        - object
          - `_t` 'LineBlueprint', required
          - `target` string, required
        - object
          - `_t` 'LocateBlueprint', required
          - `target` string, required
        - object
          - `_t` 'NamedEntityBlueprint', required
          - `target` string, required
          - `classes` string[], required
        - object
          - `_t` 'PolygonBlueprint', required
          - `target` string, required
        - object
          - `_t` 'ScrubBlueprint', required
          - `target` string, required
        - object
          - `_t` 'TranscriptionBlueprint', required
          - `title` string, required
      - `referee` union, required
        - object
          - `_t` 'BudgetRefereeConfig', required
          - `totalBudget` integer, required
          - `totalServeBudget` integer, nullable
        - object
          - `_t` 'NaiveRefereeConfig', required
          - `responsesRequired` integer
        - object
          - `_t` 'NeverEndingRefereeConfig', required
        - object
          - `_t` 'ProbabilisticAttachCategoryRefereeConfig', required
          - `threshold` number, double, required
          - `maxVotes` integer, required
        - object
          - `_t` 'QuorumRefereeConfig', required
          - `maxVotes` integer, required
          - `threshold` integer, required
      - `name` string, required
      - `ownerMail` string, nullable, required
      - `organizationId` string, required

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `403` — Forbidden

---

[API](https://skmtc.net/rapidata/apis/rapidata-api.md) · [All operations](https://skmtc.net/rapidata/apis/rapidata-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rapidata/rapidata-api/versions/e42ec51c7b88/schema)