> ## 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.

# Device health check-in

> Reports device health status and receives pending actions. Edge agents should call this periodically (e.g., every 30 seconds).



## OpenAPI

````yaml /api-spec.json post /device/checkin
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:
  /device/checkin:
    post:
      tags:
        - Devices & provisioning
      summary: Device health check-in
      description: >-
        Reports device health status and receives pending actions. Edge agents
        should call this periodically (e.g., every 30 seconds).
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/handlers.DeviceCheckinRequest'
        description: Check-in data with status and metrics
        required: true
      responses:
        '200':
          description: Check-in successful with pending actions
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/types.APIResponse'
                  - properties:
                      data:
                        $ref: '#/components/schemas/handlers.DeviceCheckinResponse'
                    type: object
        '400':
          description: Invalid request body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.APIResponse'
        '401':
          description: Device authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.APIResponse'
      security:
        - DeviceKeyAuth: []
components:
  schemas:
    handlers.DeviceCheckinRequest:
      properties:
        metrics:
          additionalProperties: true
          description: Key-value pairs of device metrics (cpu_usage, memory_usage, etc.)
          type: object
        status:
          example: healthy
          type: string
      type: object
    types.APIResponse:
      properties:
        data: {}
        error:
          $ref: '#/components/schemas/types.APIError'
        meta:
          $ref: '#/components/schemas/types.APIMeta'
        success:
          type: boolean
      type: object
    handlers.DeviceCheckinResponse:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/models.DeviceAction'
          type: array
      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
    models.DeviceAction:
      properties:
        completed_at:
          type: string
        created_at:
          type: string
        device_id:
          description: Target device
          type: string
        download_url:
          description: Presigned URL
          type: string
        file_ext:
          description: '".pt", ".onnx", ".tflite", ".synap"'
          type: string
        id:
          type: integer
        label_map:
          description: Label mapping for inference
          type: string
        model_id:
          description: Model update fields
          type: string
        model_name:
          type: string
        status:
          description: '"pending", "completed"'
          type: string
        type:
          description: '"model_update"'
          type: string
        updated_at:
          type: string
        version:
          type: string
      type: object
  securitySchemes:
    DeviceKeyAuth:
      description: 'Device API key for edge agent authentication. Format: adk_<hex>'
      in: header
      name: X-Device-Key
      type: apiKey

````