Sign in
latestOpenAPI 3.0.42026-08-19355873993.7 KB

fdb89a6eb2fb

Order

Creates a new order with the given configuration.

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

post/order

Request body

orderNamestring required

The name is used as an identifier for an order and can be freely chosen.

aggregator'NonCommittal' | 'MajorityVote' | 'SimpleMatchup' | 'LocateCluster' | 'Classification' | 'Locate' | 'BoundingBox' | 'Line' | 'Transcription' | 'SinglePointLocate' | 'FreeText' | 'Scrub' | 'Ranking' | 'MultiRanking' | 'null' nullable

The aggregator is used to determine how the data will be aggregated. The default behavior is enough for most cases

priorityinteger nullable

The priority is used to prioritize over other orders.

userScoreDimensionsstring[] nullable

The user score dimensions are used to determine the score of the responses from the user.

demographicKeysstring[] nullable

The demographic keys are used to determine which demographics to store on the responses from the user.

validationSetIdstring nullable

The validation set id can be changed to point to a specific validation set. if not provided a sane default will be used.

retrievalMode'Random' | 'Shuffled' | 'Sequential' nullable

The retrieval mode defines how rapids are retrieved from the active labeling pool.

maxIterationsinteger nullable

The maximum number of times a user is allowed to see the same rapid.

precedingOrderIdstring nullable

Optional ID of the order that must complete before this order starts processing.

Response

OK

datasetIdstring nullable

The dataset ID of the created order.

orderIdstring required

The ID of the created order.

campaignIdstring nullable

The campaign ID of the created order.

pipelineIdstring required

The pipeline ID of the created order.