> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mirurobotics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List

> List uploads.

| Scope | Required |
| - | - |
| `uploads:read` | Yes |


## OpenAPI

````yaml /references/platform-api/2026-11-16.yaml get /uploads
openapi: 3.0.3
info:
  title: Miru Platform API
  description: The API between Miru and any external client
  version: 2026-11-16.lassen
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  x-release-version: 2026-11-16.lassen
  x-git-commit:
    sha: 43d8e1c797e43bb869b8f349c2383bdd5274445f
    url: >-
      https://github.com/mirurobotics/openapi/commit/43d8e1c797e43bb869b8f349c2383bdd5274445f
    message: >-
      docs: replace customer-specific calibration examples with generic ones
      (#513)
    author: Ben's Agent
    branch: HEAD
    dirty: false
  x-build:
    built_at: '2026-11-17T00:22:51.314973+00:00'
servers:
  - url: https://api.mirurobotics.com/beta
    description: Miru Platform API
security:
  - ApiKeyAuth: []
paths:
  /uploads:
    parameters:
      - $ref: '#/components/parameters/MiruVersion'
    get:
      tags:
        - Uploads
      summary: List
      description: List uploads.
      operationId: listUploads
      parameters:
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/upload_order_bys'
        - $ref: '#/components/parameters/upload_list_expansions'
        - $ref: '#/components/parameters/upload_search_id'
        - $ref: '#/components/parameters/upload_search_device_id'
        - $ref: '#/components/parameters/upload_search_file_rule_id'
        - $ref: '#/components/parameters/upload_search_upload_collection_id'
        - $ref: '#/components/parameters/upload_search_status'
        - $ref: '#/components/parameters/upload_search_bundle_id'
      responses:
        '200':
          description: Successfully listed the uploads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadList'
components:
  parameters:
    MiruVersion:
      name: Miru-Version
      in: header
      required: true
      schema:
        type: string
        example: 2026-11-16.lassen
      description: The API version the client was built against.
    offset:
      name: offset
      in: query
      required: false
      description: >-
        The offset of the items to return. An offset of 10 with a limit of 10
        returns items 11-20.
      schema:
        type: integer
        default: 0
        minimum: 0
        example: 0
    limit:
      name: limit
      in: query
      required: false
      description: >-
        The maximum number of items to return. A limit of 15 with an offset of 0
        returns items 1-15.
      schema:
        type: integer
        default: 10
        minimum: 1
        maximum: 100
        example: 10
    upload_order_bys:
      name: order_by
      in: query
      required: false
      style: form
      explode: false
      description: Sort order for the upload results.
      schema:
        type: array
        items:
          $ref: '#/components/schemas/UploadOrderBy'
        example:
          - created_at:desc
    upload_list_expansions:
      name: expand
      in: query
      required: false
      description: Fields to expand on each upload in the list.
      x-miru-example-exempt: true
      schema:
        type: array
        items:
          $ref: '#/components/schemas/UploadListExpansion'
    upload_search_id:
      name: id
      in: query
      required: false
      style: form
      explode: false
      description: The upload IDs to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - upl_123
    upload_search_device_id:
      name: device_id
      in: query
      required: false
      style: form
      explode: false
      description: The device IDs to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - dvc_123
    upload_search_file_rule_id:
      name: file_rule_id
      in: query
      required: false
      style: form
      explode: false
      description: The file rule IDs to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - file_rule_123
    upload_search_upload_collection_id:
      name: upload_collection_id
      in: query
      required: false
      style: form
      explode: false
      description: The upload collection IDs to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - upl_col_123
    upload_search_status:
      name: status
      in: query
      required: false
      style: form
      explode: false
      description: The upload statuses to filter by.
      schema:
        type: array
        items:
          $ref: '#/components/schemas/UploadStatus'
        example:
          - uploaded
    upload_search_bundle_id:
      name: bundle_id
      in: query
      required: false
      style: form
      explode: false
      description: The upload bundle IDs to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - upl_bdl_123
  schemas:
    UploadList:
      title: Upload List
      allOf:
        - $ref: '#/components/schemas/PaginatedList'
        - type: object
          required:
            - data
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Upload'
              description: The list of uploads.
    UploadOrderBy:
      type: string
      enum:
        - id:asc
        - id:desc
        - created_at:asc
        - created_at:desc
        - uploaded_at:asc
        - uploaded_at:desc
      x-enum-varnames:
        - UPLOAD_ORDER_BY_ID_ASC
        - UPLOAD_ORDER_BY_ID_DESC
        - UPLOAD_ORDER_BY_CREATED_AT_ASC
        - UPLOAD_ORDER_BY_CREATED_AT_DESC
        - UPLOAD_ORDER_BY_UPLOADED_AT_ASC
        - UPLOAD_ORDER_BY_UPLOADED_AT_DESC
      default: created_at:desc
    UploadListExpansion:
      type: string
      enum:
        - total_count
      x-enum-varnames:
        - UPLOAD_LIST_EXPAND_TOTAL_COUNT
    UploadStatus:
      title: Upload Status
      type: string
      description: >
        The lifecycle status of an upload in the ledger.

        - `pending`: a presigned URL has been minted but the device has not yet
        confirmed a durable write.

        - `uploaded`: the device confirmed a durable write to the bucket.
      enum:
        - pending
        - uploaded
      x-enum-varnames:
        - UPLOAD_STATUS_PENDING
        - UPLOAD_STATUS_UPLOADED
    PaginatedList:
      title: Paginated List
      type: object
      required:
        - object
        - limit
        - offset
        - has_more
      properties:
        object:
          type: string
          enum:
            - list
          example: list
          x-stainless-const: true
          description: The object type, which is always `list`.
        total_count:
          type: integer
          format: int64
          description: >-
            The total number of items in the list. By default the total count is
            not returned. The total count must be expanded (using
            expand=total_count) to get the total number of items in the list.
        limit:
          type: integer
          description: >-
            The maximum number of items to return. A limit of 15 with an offset
            of 0 returns items 1-15.
          default: 10
          minimum: 1
          maximum: 100
        offset:
          type: integer
          description: >-
            The offset of the items to return. An offset of 10 with a limit of
            10 returns items 11-20.
          default: 0
          minimum: 0
        has_more:
          type: boolean
          description: >-
            True if there are more items in the list to return. False if there
            are no more items to return.
          example: false
    Upload:
      title: Upload
      allOf:
        - $ref: '#/components/schemas/BaseUpload'
        - type: object
          required:
            - bundle_id
          properties:
            bundle_id:
              type: string
              nullable: true
              example: upl_bdl_123
              description: >-
                ID of the bundle this upload belongs to. Null when the producing
                file rule does not bundle.
      example:
        object: upload
        id: upl_123
        device_id: dvc_123
        file_rule_id: file_rule_123
        upload_collection_id: upl_col_123
        upload_collection_name: Robot Logs
        source:
          file_path: /var/log/robot/robot.log
          mtime: '2021-01-01T00:00:00Z'
          first_observed_at: '2021-01-01T00:00:00Z'
          last_observed_at: '2021-01-01T00:00:05Z'
        destination:
          bucket_id: bkt_123
          bucket_name: my-uploads-bucket
          object_key: logs/dvc_123/robot.log
        digest: >-
          sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
        size: 1048576
        status: uploaded
        release_id: rls_123
        deployment_id: dpl_123
        uploaded_at: '2021-01-01T00:00:10Z'
        created_at: '2021-01-01T00:00:00Z'
        updated_at: '2021-01-01T00:00:00Z'
        bundle_id: null
    BaseUpload:
      title: Base Upload
      type: object
      required:
        - object
        - id
        - device_id
        - file_rule_id
        - upload_collection_id
        - upload_collection_name
        - source
        - destination
        - digest
        - size
        - status
        - release_id
        - deployment_id
        - uploaded_at
        - created_at
        - updated_at
      properties:
        object:
          type: string
          enum:
            - upload
          example: upload
          x-stainless-const: true
          description: The object type, which is always `upload`.
        id:
          type: string
          example: upl_123
          description: ID of the upload.
        device_id:
          type: string
          example: dvc_123
          description: ID of the device that produced the upload.
        file_rule_id:
          type: string
          example: file_rule_123
          description: ID of the file rule that produced the upload.
        upload_collection_id:
          type: string
          example: upl_col_123
          description: ID of the upload collection the producing file rule uploads to.
        upload_collection_name:
          type: string
          example: Robot Logs
          description: >-
            The name of the upload collection the producing file rule uploads
            to.
        source:
          allOf:
            - $ref: '#/components/schemas/UploadSource'
          description: >-
            Source-side details of the file on the device that produced this
            upload.
        destination:
          allOf:
            - $ref: '#/components/schemas/UploadDestination'
          description: Destination-side details of where the file was uploaded.
        digest:
          type: string
          example: >-
            sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
          description: >-
            The SHA-256 digest of the uploaded file, formatted as `sha256:`
            followed by 64 lowercase hex characters.
        size:
          type: integer
          format: int64
          example: 1048576
          description: The size of the uploaded file in bytes.
        status:
          $ref: '#/components/schemas/UploadStatus'
        release_id:
          type: string
          example: rls_123
          description: ID of the release the device was on when the upload was produced.
        deployment_id:
          type: string
          example: dpl_123
          description: >-
            ID of the deployment that was active on the device when the upload
            was produced.
        uploaded_at:
          type: string
          format: date-time
          nullable: true
          example: '2021-01-01T00:00:10Z'
          description: >-
            Timestamp of when the upload was durably confirmed. Null until the
            upload completes.
        created_at:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00Z'
          description: Timestamp of when the upload was created.
        updated_at:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00Z'
          description: Timestamp of when the upload was last updated.
    UploadSource:
      title: Upload Source
      type: object
      description: Source-side details of the file on the device that produced an upload.
      required:
        - file_path
        - mtime
        - first_observed_at
        - last_observed_at
      properties:
        file_path:
          type: string
          example: /var/log/robot/robot.log
          description: >-
            Absolute path of the file on the device. Its basename renders the
            `{file_name}` token in the upload path template.
        mtime:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00Z'
          description: >-
            The file's last-modified time (mtime) on the device, i.e. roughly
            when writing finished. In a create-upload request the agent sends it
            with the device's local UTC offset at that instant (e.g.
            `2021-01-01T00:00:00-05:00`), which a rule with `upload.timezone:
            device` renders its path's time variables in; older agents send UTC.
            Responses return it in UTC.
        first_observed_at:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00Z'
          description: >-
            Timestamp of when the device agent first observed the file on the
            device.
        last_observed_at:
          type: string
          format: date-time
          example: '2021-01-01T00:00:05Z'
          description: >-
            Timestamp of when the device agent most recently observed the file
            before the upload was minted.
      example:
        file_path: /var/log/robot/robot.log
        mtime: '2021-01-01T00:00:00Z'
        first_observed_at: '2021-01-01T00:00:00Z'
        last_observed_at: '2021-01-01T00:00:05Z'
    UploadDestination:
      title: Upload Destination
      type: object
      description: Destination-side details of where an upload was written.
      required:
        - bucket_id
        - bucket_name
        - object_key
      properties:
        bucket_id:
          type: string
          example: bkt_123
          description: ID of the registered bucket the file was uploaded to.
        bucket_name:
          type: string
          example: my-uploads-bucket
          description: >-
            Physical name of the bucket in the object store. This is the bucket
            parameter the device passes to the native cloud SDK (not the Miru
            `bucket_id`).
        object_key:
          type: string
          example: logs/dvc_123/robot.log
          description: The object path the file was written to in the destination bucket.
      example:
        bucket_id: bkt_123
        bucket_name: my-uploads-bucket
        object_key: logs/dvc_123/robot.log
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: The API key to use for authentication.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.