---
title: "Creates a new order with the given configuration."
method: POST
path: "/order"
tags: ["Order"]
---

# Creates a new order with the given configuration.

`POST /order`

Once created, use the returned dataset ID to fill the dataset with datapoints,
 then submit the order for processing.

## Request body

- CreateOrder — This model is used to create a simple order
  - `orderName` string, required — The name is used as an identifier for an order and can be freely chosen.
  - `workflow` union, required
    - object
      - `_t` 'EvaluationWorkflow', required
      - `validationSetId` string, required
      - `shouldAcceptIncorrect` boolean, required
      - `featureFlags` FeatureFlag[]
        - `key` string, required
        - `value` string, required
    - object
      - `_t` 'GroupedRankingWorkflow', required
      - `criteria` string, required
      - `pairMakerConfig` union
        - object
          - `_t` 'FullPermutationPairMaker', required
        - object
          - `_t` 'OnlinePairMaker', required
          - `randomMatchesRatio` number, float
          - `totalComparisonBudget` integer
      - `rankingConfig` union
        - IRankingConfigBradleyTerryRankingConfig
          - `_t` 'BradleyTerryRankingConfig', required
          - `startingScore` integer, required
        - IRankingConfigEloConfig
          - `_t` 'EloConfig', required
          - `startingScore` integer, required
          - `kFactor` integer, required
          - `scalingFactor` integer, required
      - `contexts` object, nullable
      - `contextAssets` object, nullable
      - `featureFlags` FeatureFlag[]
        - `key` string, required
        - `value` string, required
      - `maxParallelism` integer
    - object
      - `_t` 'SimpleWorkflow', required
      - `blueprint` union, required
        - object
          - `_t` 'ClassifyBlueprint', required
          - `categories` AttachCategoryRapidBlueprintCategory[], required
            - `label` string, required
            - `value` string, required
          - `possibleCategories` string[], nullable
          - `title` string, required
        - object
          - `_t` 'BoundingBoxBlueprint', required
          - `target` string, required
        - object
          - `_t` 'CompareBlueprint', required
          - `criteria` string, required
          - `indexIdentifiers` string[], nullable
        - object
          - `_t` 'FreeTextBlueprint', required
          - `question` string, required
          - `shouldValidateResponse` boolean, nullable
          - `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
      - `batchSize` integer, nullable
      - `featureFlags` FeatureFlag[]
        - `key` string, required
        - `value` string, required
  - `referee` union, required
    - object
      - `_t` 'BudgetReferee', required
      - `totalBudget` integer, required
    - object
      - `_t` 'EarlyStoppingReferee', required
      - `maxVotes` integer, required
      - `threshold` number, double, required
    - object
      - `_t` 'NaiveReferee', required
      - `totalVotes` integer, required
    - object
      - `_t` 'QuorumReferee', required
      - `maxVotes` integer, required
      - `threshold` integer, required
  - `aggregator` unknown
  - `rapidFeatureFlags` FeatureFlag[], nullable — The feature flags that apply to each rapid created by this order.
    - `key` string, required
    - `value` string, required
  - `campaignFeatureFlags` FeatureFlag[], nullable — The feature flags that apply to the campaign (session-wide) for this order.
    - `key` string, required
    - `value` string, required
  - `priority` integer, nullable — The priority is used to prioritize over other orders.
  - `stickyConfig` StickyConfig
    - `isEnabled` boolean
    - `dimension` string
    - `bypassFilters` boolean
    - `bypassPrioritySelection` boolean
    - `blockOtherStickyCampaigns` boolean
    - `clearOnPause` boolean
  - `userScoreDimensions` string[], nullable — The user score dimensions are used to determine the score of the responses from the user.
  - `demographicKeys` string[], nullable — The demographic keys are used to determine which demographics to store on the responses from the user.
  - `userFilters` IUserFilter[], nullable — The user filters are used to restrict the order to only collect votes from a specific demographic.
    - union
      - object
        - `_t` 'AgeFilter', required
        - `ageGroups` AgeUserFilterAgeGroup[], required
      - object
        - `_t` 'AndFilter', required
        - `filters` IUserFilter[], required
      - object
        - `_t` 'CampaignFilter', required
        - `campaignIds` string[], required
      - object
        - `_t` 'CountryFilter', required
        - `countries` string[], required
      - object
        - `_t` 'CustomFilter', required
        - `identifier` string, required
        - `values` string[], required
      - object
        - `_t` 'DeviceFilter', required
        - `deviceTypes` DeviceType[], required
      - object
        - `_t` 'GenderFilter', required
        - `genders` GenderUserFilterGender[], required
      - object
        - `_t` 'LanguageFilter', required
        - `languages` string[], required
      - object
        - `_t` 'NewUserFilter', required
      - object
        - `_t` 'NotFilter', required
        - `filter` IUserFilter, required — recursive
      - object
        - `_t` 'OrFilter', required
        - `filters` IUserFilter[], required
      - object
        - `_t` 'ResponseCountFilter', required
        - `responseCount` integer, required
        - `dimension` string, required
        - `operator` 'Equal' | 'NotEqual' | 'LessThan' | 'LessThanOrEqual' | 'GreaterThan' | 'GreaterThanOrEqual', required
      - object
        - `_t` 'UserScoreFilter', required
        - `lowerbound` number, double
        - `upperbound` number, double
        - `dimension` string, nullable
  - `validationSetId` string, nullable — The validation set id can be changed to point to a specific validation set. if not provided a sane default will be used.
  - `selections` ISelection[], nullable — The selections are used to determine which tasks are shown to a user.
    - union
      - object
        - `_t` 'AbTestSelection', required
        - `a` ISelection[], required
        - `b` ISelection[], required
      - object
        - `_t` 'CappedSelection', required
        - `selections` ISelection[], required
        - `maxRapids` integer, required
      - object
        - `_t` 'ConditionalValidationSelection', required
        - `validationSetId` string, required
        - `validationChances` ConditionalValidationSelectionValidationChance[], required
          - `userScoreThreshold` number, double, required
          - `chance` number, double, required
          - `rapidCount` integer, required
          - `selections` ISelection[], nullable
        - `dimensions` string[]
      - object
        - `_t` 'DemographicSelection', required
        - `keys` string[], required
        - `maxRapids` integer
      - object
        - `_t` 'EffortCappedSelection', required
        - `effortBudget` integer, required
        - `retrievalMode` 'Random' | 'Shuffled' | 'Sequential'
        - `maxIterations` integer, nullable
      - object
        - `_t` 'LabelingSelection', required
        - `amount` integer, nullable
        - `effortBudget` integer
        - `retrievalMode` 'Random' | 'Shuffled' | 'Sequential'
        - `maxIterations` integer, nullable
      - object
        - `_t` 'ShufflingSelection', required
        - `selections` ISelection[], required
      - object
        - `_t` 'StaticSelection', required
        - `rapidIds` string[], required
      - object
        - `_t` 'ValidationSelection', required
        - `amount` integer, required
        - `validationSetId` string, required
  - `retrievalMode` 'Random' | 'Shuffled' | 'Sequential'
  - `maxIterations` integer, nullable — The maximum number of times a user is allowed to see the same rapid.
  - `precedingOrderId` string, nullable — Optional ID of the order that must complete before this order starts processing.

## Response `200`

OK

- CreateOrderEndpointOutput
  - `datasetId` string, nullable — The dataset ID of the created order.
  - `orderId` string, required — The ID of the created order.
  - `campaignId` string, nullable — The campaign ID of the created order.
  - `pipelineId` string, required — The pipeline ID of the created order.

## 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)