Rapidata Order API

openapi: 3.2.0
info:
  title: Rapidata Asset Order API
  description: The API for the Rapidata Asset service
  version: v1
servers:
- url: https://api.rapidata.ai/
tags:
- name: Order
  x-displayName: Order
paths:
  /order/{orderId}/approve:
    post:
      tags:
      - Order
      summary: Approves a submitted order so the pipeline can start processing it.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order to approve.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}/clone:
    post:
      tags:
      - Order
      summary: Clones an existing public order.
      description: The order to clone must be marked as public.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order to clone.
        required: true
        schema:
          type: string
      requestBody:
        description: The clone order details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneOrderEndpoint_Input'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloneOrderEndpoint_Output'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/complex:
    post:
      tags:
      - Order
      summary: Creates a new order with a custom pipeline configuration.
      requestBody:
        description: The complex order creation details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComplexOrderEndpoint_Input'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComplexOrderEndpoint_Output'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order:
    post:
      tags:
      - Order
      summary: Creates a new order with the given configuration.
      description: "Once created, use the returned dataset ID to fill the dataset with datapoints,\n then submit the order for processing."
      requestBody:
        description: The order creation configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrderModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrderEndpoint_Output'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/unsupported:
    post:
      tags:
      - Order
      summary: Creates a notification for an unsupported order type.
      requestBody:
        description: The unsupported order details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUnsupportedOrderEndpoint_Input'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}:
    delete:
      tags:
      - Order
      summary: Deletes an order and its associated resources.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
    get:
      tags:
      - Order
      summary: Retrieves the details of a specific order.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderByIdEndpoint_Output'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
    patch:
      tags:
      - Order
      summary: Updates the name or preceding order of an order.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order to update.
        required: true
        schema:
          type: string
      requestBody:
        description: The properties to update.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrderEndpoint_Input'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}/download-results:
    get:
      tags:
      - Order
      summary: Aggregates the results of an order and returns them as a file attachment.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}/results:
    get:
      tags:
      - Order
      summary: Aggregates the results of an order and returns them as a JSON string.
      description: For file download, use the download-results endpoint instead.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /orders/public:
    get:
      tags:
      - Order
      summary: Retrieves all publicly available orders.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPublicOrdersEndpoint_Output'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}/demo:
    patch:
      tags:
      - Order
      summary: Marks or unmarks an order as a demo.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order.
        required: true
        schema:
          type: string
      - name: isDemo
        in: query
        description: Whether to mark or unmark the order as a demo.
        schema:
          type: boolean
          default: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}/pause:
    post:
      tags:
      - Order
      summary: Pauses an order, stopping all campaigns from processing.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order to pause.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}/preview:
    post:
      tags:
      - Order
      summary: Starts preview mode for an order so labelers' experience can be inspected.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order to preview.
        required: true
        schema:
          type: string
      requestBody:
        description: Optional preview configuration.
        content:
          application/json:
            schema:
              type:
              - object
              - 'null'
              oneOf:
              - $ref: '#/components/schemas/PreviewOrderEndpoint_Input'
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /orders/aggregated-overview:
    get:
      tags:
      - Order
      summary: Retrieves orders aggregated by customer with total amounts and most recent order information.
      parameters:
      - name: page
        in: query
        description: The 1-based page index.
        schema:
          type: integer
        x-parameter-group: page
      - name: page_size
        in: query
        description: The number of items per page.
        schema:
          type: integer
        x-parameter-group: page
      - name: sort
        in: query
        description: Sort fields. Prefix with - for descending order (e.g. -created_at).
        schema:
          type: array
          items:
            enum:
            - amount
            - -amount
            - last7_days
            - -last7_days
            - last_order_date
            - -last_order_date
            - customer_mail
            - -customer_mail
            type: string
        x-parameter-group: sort
      - name: customer_mail
        in: query
        description: Filter by customer_mail.
        style: deepObject
        explode: true
        schema:
          type: object
          properties:
            eq:
              type: string
            neq:
              type: string
            gt:
              type: string
            gte:
              type: string
            lt:
              type: string
            lte:
              type: string
            contains:
              type: string
            starts_with:
              type: string
            ends_with:
              type: string
            in:
              type: array
              items:
                type: string
            not_contains:
              type: string
        x-parameter-group: filters
      - name: last_order_date
        in: query
        description: Filter by last_order_date.
        style: deepObject
        explode: true
        schema:
          type: object
          properties:
            eq:
              type: string
            neq:
              type: string
            gt:
              type: string
            gte:
              type: string
            lt:
              type: string
            lte:
              type: string
            contains:
              type: string
            starts_with:
              type: string
            ends_with:
              type: string
            in:
              type: array
              items:
                type: string
            not_contains:
              type: string
        x-parameter-group: filters
      - name: last_order_name
        in: query
        description: Filter by last_order_name.
        style: deepObject
        explode: true
        schema:
          type: object
          properties:
            eq:
              type: string
            neq:
              type: string
            gt:
              type: string
            gte:
              type: string
            lt:
              type: string
            lte:
              type: string
            contains:
              type: string
            starts_with:
              type: string
            ends_with:
              type: string
            in:
              type: array
              items:
                type: string
            not_contains:
              type: string
        x-parameter-group: filters
      - name: logic
        in: query
        description: 'How to combine the field filters: "and" (default) requires every filter to match, "or" requires any of them to match.'
        schema:
          enum:
          - and
          - or
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryAggregatedOrdersEndpoint_PagedResultOfOutput'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /orders:
    get:
      tags:
      - Order
      summary: Queries orders with filtering and pagination.
      parameters:
      - name: page
        in: query
        description: The 1-based page index.
        schema:
          type: integer
        x-parameter-group: page
      - name: page_size
        in: query
        description: The number of items per page.
        schema:
          type: integer
        x-parameter-group: page
      - name: sort
        in: query
        description: Sort fields. Prefix with - for descending order (e.g. -created_at).
        schema:
          type: array
          items:
            enum:
            - order_name
            - -order_name
            - order_date
            - -order_date
            - state
            - -state
            type: string
        x-parameter-group: sort
      - name: order_name
        in: query
        description: Filter by order_name.
        style: deepObject
        explode: true
        schema:
          type: object
          properties:
            eq:
              type: string
            neq:
              type: string
            gt:
              type: string
            gte:
              type: string
            lt:
              type: string
            lte:
              type: string
            contains:
              type: string
            starts_with:
              type: string
            ends_with:
              type: string
            in:
              type: array
              items:
                type: string
            not_contains:
              type: string
        x-parameter-group: filters
      - name: state
        in: query
        description: Filter by state.
        style: deepObject
        explode: true
        schema:
          type: object
          properties:
            eq:
              type: string
            neq:
              type: string
            gt:
              type: string
            gte:
              type: string
            lt:
              type: string
            lte:
              type: string
            contains:
              type: string
            starts_with:
              type: string
            ends_with:
              type: string
            in:
              type: array
              items:
                type: string
            not_contains:
              type: string
        x-parameter-group: filters
      - name: order_date
        in: query
        description: Filter by order_date.
        style: deepObject
        explode: true
        schema:
          type: object
          properties:
            eq:
              type: string
            neq:
              type: string
            gt:
              type: string
            gte:
              type: string
            lt:
              type: string
            lte:
              type: string
            contains:
              type: string
            starts_with:
              type: string
            ends_with:
              type: string
            in:
              type: array
              items:
                type: string
            not_contains:
              type: string
        x-parameter-group: filters
      - name: customer_mail
        in: query
        description: Filter by customer_mail.
        style: deepObject
        explode: true
        schema:
          type: object
          properties:
            eq:
              type: string
            neq:
              type: string
            gt:
              type: string
            gte:
              type: string
            lt:
              type: string
            lte:
              type: string
            contains:
              type: string
            starts_with:
              type: string
            ends_with:
              type: string
            in:
              type: array
              items:
                type: string
            not_contains:
              type: string
        x-parameter-group: filters
      - name: is_public
        in: query
        description: Filter by is_public.
        style: deepObject
        explode: true
        schema:
          type: object
          properties:
            eq:
              type: string
            neq:
              type: string
            gt:
              type: string
            gte:
              type: string
            lt:
              type: string
            lte:
              type: string
            contains:
              type: string
            starts_with:
              type: string
            ends_with:
              type: string
            in:
              type: array
              items:
                type: string
            not_contains:
              type: string
        x-parameter-group: filters
      - name: logic
        in: query
        description: 'How to combine the field filters: "and" (default) requires every filter to match, "or" requires any of them to match.'
        schema:
          enum:
          - and
          - or
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryOrdersEndpoint_PagedResultOfOutput'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}/resume:
    post:
      tags:
      - Order
      summary: Resumes a paused order, restarting all campaigns.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order to resume.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}/retry:
    post:
      tags:
      - Order
      summary: Retries processing of a failed order.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order to retry.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}/share:
    patch:
      tags:
      - Order
      summary: Marks or unmarks an order as public.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order.
        required: true
        schema:
          type: string
      - name: isPublic
        in: query
        description: Whether to mark or unmark the order as public.
        schema:
          type: boolean
          default: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}/submit:
    post:
      tags:
      - Order
      summary: Submits an order for processing.
      description: Once submitted, the order will be locked and no further changes can be made.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order to submit.
        required: true
        schema:
          type: string
      requestBody:
        description: Optional submission configuration.
        content:
          application/json:
            schema:
              type:
              - object
              - 'null'
              oneOf:
              - $ref: '#/components/schemas/SubmitOrderEndpoint_Input'
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
  /order/{orderId}/unlock:
    post:
      tags:
      - Order
      summary: Unlocks a cloned order so it can be modified.
      description: Unlocking clones the entire dataset and its datapoints.
      parameters:
      - name: orderId
        in: path
        description: The ID of the order to unlock.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnlockOrderEndpoint_Output'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - OpenIdConnect:
        - openid
        - profile
        - email
        - offline_access
components:
  schemas:
    IUserFilterModelUserScoreUserFilterModel:
      required:
      - _t
      properties:
        _t:
          enum:
          - UserScoreFilter
          type: string
        lowerbound:
          type: number
          format: double
        upperbound:
          type: number
          format: double
        dimension:
          type:
          - string
          - 'null'
    IRapidBlueprintTranscriptionRapidBlueprint:
      required:
      - title
      - _t
      properties:
        _t:
          enum:
          - TranscriptionBlueprint
          type: string
        title:
          type: string
    IRapidBlueprintScrubRapidBlueprint:
      required:
      - target
      - _t
      properties:
        _t:
          enum:
          - ScrubBlueprint
          type: string
        target:
          type: string
    CreateUnsupportedOrderEndpoint_Input:
      required:
      - orderName
      - dataType
      - labelType
      type: object
      properties:
        orderName:
          type: string
          description: The name of the order.
        dataType:
          type: string
          description: The type of data that was attempted to be ordered.
        labelType:
          type: string
          description: The type of labels that were attempted to be ordered.
    MetadataInputCollection:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/IMetadataInput'
    IMetadataInputTextMetadataInput:
      required:
      - text
      - visibilities
      - _t
      properties:
        _t:
          enum:
          - TextMetadataInput
          type: string
        text:
          type:
          - string
          - 'null'
        visibilities:
          $ref: '#/components/schemas/MetadataVisibilities'
    MetadataVisibilities:
      type: array
      items:
        enum:
        - None
        - Users
        - Customers
        - Admins
        - Dashboard
        - All
        type: string
    RetrievalMode:
      enum:
      - Random
      - Shuffled
      - Sequential
    IPipelineStepModelWorkflowAggregationStepModel:
      required:
      - campaignArtifactId
      - workflowArtifactId
      - fileArtifactId
      - _t
      properties:
        _t:
          enum:
          - WorkflowAggregationStepModel
          type: string
        campaignArtifactId:
          type: string
        workflowArtifactId:
          type: string
        fileArtifactId:
          type: string
        aggregatorType:
          $ref: '#/components/schemas/AggregatorType'
        demographicKeys:
          type:
          - array
          - 'null'
          items:
            type: string
    ISelectionEffortCappedSelection:
      required:
      - effortBudget
      - _t
      properties:
        _t:
          enum:
          - EffortCappedSelection
          type: string
        effortBudget:
          type: integer
          format: int32
        retrievalMode:
          $ref: '#/components/schemas/RetrievalMode'
        maxIterations:
          type:
          - integer
          - 'null'
          format: int32
    IRapidBlueprintPolygonRapidBlueprint:
      required:
      - target
      - _t
      properties:
        _t:
          enum:
          - PolygonBlueprint
          type: string
        target:
          type: string
    IUserFilterModelCustomUserFilterModel:
      required:
      - identifier
      - values
      - _t
      properties:
        _t:
          enum:
          - CustomFilter
          type: string
        identifier:
          type: string
        values:
          type: array
          items:
            type: string
    IRankingConfigModelBradleyTerryRankingConfigModel:
      required:
      - startingScore
      - _t
      properties:
        _t:
          enum:
          - BradleyTerryRankingConfig
          type: string
        startingScore:
          type: integer
          format: int32
    IRefereeModelQuorumRefereeModel:
      required:
      - maxVotes
      - threshold
      - _t
      properties:
        _t:
          enum:
          - QuorumReferee
          type: string
        maxVotes:
          type: integer
          format: int32
        threshold:
          type: integer
          format: int32
    IRankingConfigModelEloConfigModel:
      required:
      - startingScore
      - kFactor
      - scalingFactor
      - _t
      properties:
        _t:
          enum:
          - EloConfig
          type: string
        startingScore:
          type: integer
          format: int32
        kFactor:
          type: integer
          format: int32
        scalingFactor:
          type: integer
          format: int32
    IDatasetModel:
      required:
      - _t
      type: object
      oneOf:
      - $ref: '#/components/schemas/IDatasetModelCloneDatasetModel'
      discriminator:
        propertyName: _t
        mapping:
          CloneDatasetModel: '#/components/schemas/IDatasetModelCloneDatasetModel'
    ISelectionConditionalValidationSelection:
      required:
      - validationSetId
      - validationChances
      - _t
      properties:
        _t:
          enum:
          - ConditionalValidationSelection
          type: string
        validationSetId:
          type: string
        validationChances:
          type: array
          items:
            $ref: '#/components/schemas/ConditionalValidationSelection_ValidationChance'
        dimensions:
          type: array
          items:
            type: string
    IPipelineStepModel:
      required:
      - _t
 

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rapidata/refs/heads/main/openapi/rapidata-order-api-openapi.yml