openapi: 3.1.0
info:
  title: CodeProject.AI Server Articles Status API
  description: CodeProject.AI Server is a self-contained, self-hosted, free and open-source AI service that exposes computer-vision, audio, NLP, and model-training capabilities through a local HTTP REST API. It runs on Windows, macOS, Linux, Raspberry Pi, NVIDIA Jetson, OrangePi, and as a Docker container, and is most often integrated with home-automation and surveillance platforms (Blue Iris, Home Assistant, Agent DVR) for object detection, face recognition, ALPR (license-plate), and scene classification. All endpoints are POST and accept multipart/form-data uploads.
  version: '2.9'
  contact:
    name: CodeProject.AI Server
    url: https://www.codeproject.com/AI/
  license:
    name: GPL-3.0
    url: https://github.com/codeproject/CodeProject.AI-Server/blob/main/LICENSE
servers:
- url: http://localhost:32168
  description: Default local CodeProject.AI Server endpoint
tags:
- name: Status
  description: Server status, version, logs, and update checks.
paths:
  /v1/status/ping:
    post:
      operationId: pingServer
      summary: Server health check
      tags:
      - Status
      responses:
        '200':
          description: Server reachable
  /v1/status/version:
    post:
      operationId: getServerVersion
      summary: Get server version
      tags:
      - Status
      responses:
        '200':
          description: Version information
  /v1/status/logs:
    post:
      operationId: getServerLogs
      summary: Retrieve server logs
      tags:
      - Status
      responses:
        '200':
          description: Log entries
  /v1/status/updateavailable:
    post:
      operationId: checkForUpdates
      summary: Check whether a new server version is available
      tags:
      - Status
      responses:
        '200':
          description: Update availability status
components:
  securitySchemes:
    none:
      type: apiKey
      in: header
      name: X-Disabled
      description: CodeProject.AI Server runs locally and does not require authentication by default. Operators are expected to keep the service on a private network or behind their own reverse proxy.
externalDocs:
  description: CodeProject.AI Server documentation
  url: https://codeproject.github.io/codeproject.ai/