sitecore Download Orders API

openapi: 3.2.0
info:
  title: Sitecore Content Hub REST Download Orders API
  description: The Sitecore Content Hub REST API is a hypermedia API built on HTTP that provides programmatic access to the full range of Content Hub resources, including entities, assets, jobs, search, selections, upload, and audit logs. Developers use it to automate digital asset management workflows, migrate content, build custom integrations, and manage Content Hub configuration. The API supports standard CRUD operations and is authenticated using OAuth 2.0 tokens obtained from the Content Hub identity provider. Navigation between resources uses hyperlinks rather than hardcoded URL patterns. The base URL is tenant-specific and corresponds to the URL of the Content Hub instance followed by /api/.
  version: v1
  contact:
    name: Sitecore Support
    url: https://www.sitecore.com/support
  termsOfService: https://www.sitecore.com/legal/terms-of-service
servers:
- url: https://{tenant}.stylelabs.io/api
  description: Content Hub Production Server
  variables:
    tenant:
      description: The tenant-specific subdomain for the Content Hub instance
      default: your-tenant
security:
- bearerAuth: []
tags:
- name: Download Orders
  description: Endpoints for creating and managing download orders that package assets for delivery, supporting both single and batch asset downloads.
paths:
  /downloadorders:
    post:
      operationId: createDownloadOrder
      summary: Create a download order
      description: Creates a download order that packages one or more assets for delivery. Download orders can specify renditions, file formats, and delivery options. The order is processed asynchronously and the download URL is provided upon completion.
      tags:
      - Download Orders
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDownloadOrderRequest'
      responses:
        '202':
          description: Download order accepted for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadOrder'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ErrorResponse:
      type: object
      description: An error response body
      properties:
        message:
          type: string
          description: A human-readable error message
        statusCode:
          type: integer
          description: The HTTP status code
        errors:
          type: array
          description: List of detailed error messages
          items:
            type: string
    CreateDownloadOrderRequest:
      type: object
      description: Request body for creating a download order
      required:
      - entityIds
      properties:
        entityIds:
          type: array
          description: Entity identifiers of assets to include in the download
          items:
            type: integer
        renditionName:
          type: string
          description: The name of the asset rendition to download (e.g., Original, Preview)
        includeMetadata:
          type: boolean
          description: Whether to include metadata alongside the asset files
          default: false
    DownloadOrder:
      type: object
      description: A download order packaging assets for delivery
      properties:
        id:
          type: string
          description: The unique identifier of the download order
        status:
          type: string
          description: The current processing status of the download order
          enum:
          - Queued
          - Processing
          - Completed
          - Failed
        downloadUrl:
          type: string
          description: The URL from which the packaged assets can be downloaded
          format: uri
        createdOn:
          type: string
          description: The ISO 8601 timestamp when the download order was created
          format: date-time
        completedOn:
          type: string
          description: The ISO 8601 timestamp when the download order was completed
          format: date-time
  responses:
    Unauthorized:
      description: Authentication token is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: The request body or parameters are invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained from the Content Hub identity provider. Include the token in the Authorization header as 'Bearer {token}'.
externalDocs:
  description: Sitecore Content Hub REST API Documentation
  url: https://doc.sitecore.com/ch/en/developers/cloud-dev/rest-apis.html