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

# Agent heartbeat

> Updates device heartbeat metadata, reconciles deployment state, and returns any pending device actions to execute.



## OpenAPI

````yaml /api-spec.json post /core/agent/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:
  /core/agent/checkin:
    post:
      tags:
        - Devices & provisioning
      summary: Agent heartbeat
      description: >-
        Updates device heartbeat metadata, reconciles deployment state, and
        returns any pending device actions to execute.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/handlers.CheckinRequest'
        description: Agent heartbeat payload
        required: true
      responses:
        '200':
          description: Heartbeat processed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.CheckinResponse'
        '400':
          description: Invalid request payload
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '404':
          description: Device not registered
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '500':
          description: Failed to update device heartbeat
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
      security:
        - DeviceKeyAuth: []
components:
  schemas:
    handlers.CheckinRequest:
      properties:
        current_model_id:
          type: string
        device_id:
          type: string
        ip_address:
          description: IPAddress allows the agent to report its LAN IP for live streaming
          type: string
        pending_requests:
          items:
            $ref: '#/components/schemas/handlers.DeviceRequest'
          type: array
        status:
          type: string
      required:
        - device_id
      type: object
    handlers.CheckinResponse:
      properties:
        pending_actions:
          items:
            $ref: '#/components/schemas/models.DeviceAction'
          type: array
        success:
          type: boolean
      type: object
    handlers.DeviceRequest:
      properties:
        payload:
          additionalProperties: true
          type: object
        type:
          type: string
      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

````