Rapidata Order API
The Order API from Rapidata — 19 operation(s) for order.
Rapidata Order API is one of 55 APIs that Rapidata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes 21 operations across 19 paths, and defines 99 schemas. It is described by OpenAPI 3.0.4, at version v1.
Requests are made against a single base URL, https://api.rapidata.ai/.
21 operations
19 paths
99 schemas
1 DELETE6 GET3 PATCH11 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Rapidata Order API declares
1 security scheme
for authenticating requests.
It supports OpenID Connect (OpenIdConnect) discovered at https://auth.rapidata.ai/.well-known/openid-configuration.
OpenIdConnect— OpenID Connect connection flow
Paths & Operations 21
Across 19 paths, the API surfaces 21 operations — 1 DELETE, 6 GET, 3 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.
Order 21
POST
/order/{orderId}/approve
Approves a submitted order so the pipeline can start processing it.
POST
/order/{orderId}/clone
Clones an existing public order.
POST
/order/complex
Creates a new order with a custom pipeline configuration.
POST
/order
Creates a new order with the given configuration.
POST
/order/unsupported
Creates a notification for an unsupported order type.
DELETE
/order/{orderId}
Deletes an order and its associated resources.
GET
/order/{orderId}
Retrieves the details of a specific order.
PATCH
/order/{orderId}
Updates the name or preceding order of an order.
GET
/order/{orderId}/download-results
Aggregates the results of an order and returns them as a file attachment.
GET
/order/{orderId}/results
Aggregates the results of an order and returns them as a JSON string.
GET
/orders/public
Retrieves all publicly available orders.
PATCH
/order/{orderId}/demo
Marks or unmarks an order as a demo.
POST
/order/{orderId}/pause
Pauses an order, stopping all campaigns from processing.
POST
/order/{orderId}/preview
Starts preview mode for an order so labelers' experience can be inspected.
GET
/orders/aggregated-overview
Retrieves orders aggregated by customer with total amounts and most recent order information.
GET
/orders
Queries orders with filtering and pagination.
POST
/order/{orderId}/resume
Resumes a paused order, restarting all campaigns.
POST
/order/{orderId}/retry
Retries processing of a failed order.
PATCH
/order/{orderId}/share
Marks or unmarks an order as public.
POST
/order/{orderId}/submit
Submits an order for processing.
POST
/order/{orderId}/unlock
Unlocks a cloned order so it can be modified.
Schemas 99
The contract defines 99 schemas that model the data the API accepts and returns. The most detailed are CreateOrderModel (16 properties), GetOrderByIdEndpoint_Output (8 properties), IOrderWorkflowInputModelGroupedRankingWorkflowInputModel (8 properties), QueryOrdersEndpoint_Output (8 properties). Each schema is shown below with its type and property counts.
UnlockOrderEndpoint_Output
object
1 property
1 required
CreateComplexOrderEndpoint_Output
object
4 properties
2 required
IUserFilterModelResponseCountUserFilterModel
object
4 properties
4 required
RetrievalMode
IRapidBlueprint
object
1 required
IUserFilterModelUserScoreUserFilterModel
object
4 properties
1 required
IRapidBlueprintAttachCategoryRapidBlueprint
object
4 properties
3 required
IRankingConfigModelBradleyTerryRankingConfigModel
object
2 properties
2 required
QueryAggregatedOrdersEndpoint_Output
object
6 properties
6 required
GetOrderByIdEndpoint_Output
object
8 properties
7 required
IPipelineStepModelWorkflowLabelingStepModel
object
2 properties
2 required
IRapidBlueprintPolygonRapidBlueprint
object
2 properties
2 required
IPipelineModelCreateSimplePipelineModel
object
4 properties
4 required
IRapidBlueprintBoundingBoxRapidBlueprint
object
2 properties
2 required
IMetadataInputTextMetadataInput
object
3 properties
3 required
ISelectionEffortCappedSelection
object
4 properties
2 required
QueryOrdersEndpoint_Output
object
8 properties
7 required
IRankingConfigModelEloConfigModel
object
4 properties
4 required
AgeUserFilterModel_AgeGroup
MetadataInputCollection
object
IRefereeModelEarlyStoppingRefereeModel
object
3 properties
3 required
IPairMakerConfigModel
object
1 required
IRapidBlueprintScrubRapidBlueprint
object
2 properties
2 required
IOrderWorkflowInputModelEvaluationWorkflowInputModel
object
4 properties
3 required
IOrderWorkflowInputModel
object
1 required
IDatasetModelCloneDatasetModel
object
3 properties
3 required
ISelection
object
1 required
IUserFilterModelCountryUserFilterModel
object
2 properties
2 required
IPipelineStepModelDatasetEvaluationStepModel
object
5 properties
5 required
IUserFilterModelNewUserFilterModel
object
1 property
1 required
FeatureFlag
object
2 properties
2 required
MetadataVisibilities
array
CloneOrderEndpoint_Output
object
2 properties
1 required
AttachCategoryRapidBlueprint_Category
object
2 properties
2 required
CloneOrderEndpoint_Input
object
1 property
1 required
ISelectionAbTestSelection
object
3 properties
3 required
IAssetInputTextAssetInput
object
4 properties
2 required
IPairMakerConfigModelOnlinePairMakerConfigModel
object
3 properties
1 required
OrderState
IRapidBlueprintFreeTextRapidBlueprint
object
4 properties
2 required
IPipelineStepModelWorkflowAggregationStepModel
object
6 properties
4 required
IRapidBlueprintCompareRapidBlueprint
object
3 properties
2 required
IRefereeModelNaiveRefereeModel
object
2 properties
2 required
ConditionalValidationSelection_ValidationChance
object
4 properties
3 required
UpdateOrderEndpoint_Input
object
2 properties
ISelectionDemographicSelection
object
3 properties
2 required
IRapidBlueprintLocateRapidBlueprint
object
2 properties
2 required
ISelectionShufflingSelection
object
2 properties
2 required
IUserFilterModelDeviceUserFilterModel
object
2 properties
2 required
IUserFilterModelCampaignUserFilterModel
object
2 properties
2 required
IMetadataInput
object
1 required
IUserFilterModelLanguageUserFilterModel
object
2 properties
2 required
ISelectionValidationSelection
object
3 properties
3 required
IUserFilterModelOrUserFilterModel
object
2 properties
2 required
IOrderWorkflowInputModelGroupedRankingWorkflowInputModel
object
8 properties
2 required
IUserFilterModelNotUserFilterModel
object
2 properties
2 required
QueryAggregatedOrdersEndpoint_PagedResultOfOutput
object
5 properties
4 required
CreateComplexOrderEndpoint_Input
object
4 properties
2 required
IRefereeModelQuorumRefereeModel
object
3 properties
3 required
ValidationProblemDetails
object
6 properties
IPipelineArtifactModelCreateDatasetArtifactModel
object
3 properties
3 required
IOrderWorkflowInputModelSimpleWorkflowInputModel
object
4 properties
2 required
IPipelineStepModelSendCompletionMailStepModel
object
3 properties
3 required
ISelectionCappedSelection
object
3 properties
3 required
DeviceType
IUserFilterModel
object
1 required
IUserFilterModelAgeUserFilterModel
object
2 properties
2 required
IRapidBlueprintTranscriptionRapidBlueprint
object
2 properties
2 required
IPipelineModel
object
1 required
IRapidBlueprintLineRapidBlueprint
object
2 properties
2 required
ComparisonOperator
IRankingConfigModel
object
1 required
IAssetInputMultiAssetInput
object
4 properties
2 required
PreviewOrderEndpoint_Input
object
1 property
CreateUnsupportedOrderEndpoint_Input
object
3 properties
3 required
CreateOrderEndpoint_Output
object
4 properties
2 required
GetPublicOrdersEndpoint_OrderOutput
object
3 properties
3 required
AggregatorType
IPairMakerConfigModelFullPermutationPairMakerConfigModel
object
1 property
1 required
ISelectionLabelingSelection
object
5 properties
1 required
GetPublicOrdersEndpoint_Output
object
1 property
1 required
IUserFilterModelAndUserFilterModel
object
2 properties
2 required
IPipelineStepModel
object
1 required
IRapidBlueprintNamedEntityRapidBlueprint
object
3 properties
3 required
IDatasetModel
object
1 required
IAssetInput
object
1 required
IUserFilterModelCustomUserFilterModel
object
3 properties
3 required
StickyConfig
object
6 properties
1 required
SubmitOrderEndpoint_Input
object
1 property
IPipelineArtifactModel
object
1 required
IRefereeModelBudgetRefereeModel
object
2 properties
2 required
ISelectionStaticSelection
object
2 properties
2 required
IUserFilterModelGenderUserFilterModel
object
2 properties
2 required
IAssetInputExistingAssetInput
object
4 properties
2 required
QueryOrdersEndpoint_PagedResultOfOutput
object
5 properties
4 required
GenderUserFilterModel_Gender
ISelectionConditionalValidationSelection
object
4 properties
3 required
IRefereeModel
object
1 required
CreateOrderModel
object
This model is used to create a simple order
16 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Rapidata 12
Other APIs Rapidata publishes across the network.
Rapidata Asset API
Rapidata Audience API
Rapidata BatchUpload API
Rapidata Benchmark API
Rapidata Billing API
Rapidata BillingAccount API
Rapidata Cache API
Rapidata Campaign API
Rapidata Client API
Rapidata ContextShortening API
Rapidata Customer API
Rapidata CustomerRapid API
#Order