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

# List images

> Returns images with optional filters for project, batch, device, annotation status, dataset split, class values, and text search. Supports eager annotation loading and inline streaming URLs.



## OpenAPI

````yaml /api-spec.json get /data/images
openapi: 3.0.0
info:
  contact:
    name: Acusight API Support
  description: >-
    Acusight platform API - custom endpoints + Portainer proxy routes for edge
    AI deployments
  title: Acusight API
  version: 1.0.0
servers:
  - url: https://acusight.io/api
    description: AcuSight Cloud (hosted)
security: []
tags:
  - name: Devices & provisioning
    description: Register, provision, and manage edge devices and their agents.
  - name: Virtual devices
    description: Create and drive simulated devices for testing and demos.
  - name: Alerts & telemetry
    description: Model alerts, alert rules, and product telemetry.
  - name: Organization
    description: Organization-level settings.
  - name: Datasets & data
    description: Projects, batches, datasets, images, annotations, and drift.
  - name: Models & training
    description: Model registry, training jobs, exports, and inference.
  - name: Pipeline data
    description: Detection time-series and aggregated pipeline analytics.
paths:
  /data/images:
    get:
      tags:
        - Datasets & data
      summary: List images
      description: >-
        Returns images with optional filters for project, batch, device,
        annotation status, dataset split, class values, and text search.
        Supports eager annotation loading and inline streaming URLs.
      parameters:
        - description: Filter by project ID (use 'null' for unassigned)
          in: query
          name: project_id
          schema:
            type: string
        - description: Filter by batch ID
          in: query
          name: batch_id
          schema:
            type: string
        - description: Filter by device identifier
          in: query
          name: device_id
          schema:
            type: string
        - description: Filter by batch stage when project_id provided
          in: query
          name: stage
          schema:
            type: string
        - description: Filter by annotation status
          in: query
          name: annotation_status
          schema:
            type: string
        - description: Filter by dataset split (train, val, test, none, all)
          in: query
          name: split
          schema:
            type: string
        - description: Comma-separated class values to filter
          in: query
          name: class_values
          schema:
            type: string
        - description: Search by filename substring
          in: query
          name: search
          schema:
            type: string
        - description: Exact filename filter
          in: query
          name: filename
          schema:
            type: string
        - description: Include signed image URL in results
          in: query
          name: include_image_url
          schema:
            type: boolean
        - description: Include annotation payloads
          in: query
          name: include_annotations
          schema:
            type: boolean
        - description: Page size (default 50, max 100)
          in: query
          name: limit
          schema:
            type: integer
        - description: Result offset
          in: query
          name: offset
          schema:
            type: integer
        - description: Sort field (created_at, updated_at, filename)
          in: query
          name: sort
          schema:
            type: string
        - description: Sort direction (asc or desc)
          in: query
          name: order
          schema:
            type: string
      responses:
        '200':
          description: Paginated image list
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/types.APIResponse'
                  - properties:
                      data:
                        items:
                          $ref: '#/components/schemas/types.ImageDetailResponse'
                        type: array
                    type: object
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.APIResponse'
        '404':
          description: Device not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.APIResponse'
        '500':
          description: Failed to fetch images
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.APIResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    types.APIResponse:
      properties:
        data: {}
        error:
          $ref: '#/components/schemas/types.APIError'
        meta:
          $ref: '#/components/schemas/types.APIMeta'
        success:
          type: boolean
      type: object
    types.ImageDetailResponse:
      properties:
        annotation_status:
          type: string
        annotations:
          items:
            $ref: '#/components/schemas/types.AnnotationDTO'
          type: array
        batch_id:
          type: integer
        batch_name:
          type: string
        created_at:
          type: string
        device_id:
          type: string
        filename:
          type: string
        height:
          type: integer
        id:
          type: integer
        image_url:
          type: string
        project_name:
          type: string
        split:
          type: string
        split_locked:
          type: boolean
        storage_key:
          type: string
        updated_at:
          type: string
        version_name:
          type: string
        width:
          type: integer
      type: object
    types.APIError:
      properties:
        code:
          type: string
        details:
          type: string
        message:
          type: string
      type: object
    types.APIMeta:
      properties:
        count:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
        total:
          type: integer
      type: object
    types.AnnotationDTO:
      properties:
        class_value:
          type: string
        confidence:
          type: number
        created_at:
          type: string
        geometry:
          items:
            type: integer
          type: array
        height:
          type: number
        id:
          type: integer
        image_id:
          type: integer
        source:
          type: string
        type:
          type: string
        updated_at:
          type: string
        width:
          type: number
        x_center:
          type: number
        y_center:
          type: number
        z_order:
          type: integer
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT access token. Paste the token only; the Bearer prefix is added
        automatically.

````