openapi: 3.0.3
info:
  title: PicPurify Image and Video Moderation Image Analysis API
  description: PicPurify provides image and video moderation services including weapons (gun and knife) detection, nudity, drug, gore, hate sign, age, gender, and other content moderation tasks.
  version: '1.1'
  contact:
    name: PicPurify
    url: https://www.picpurify.com/
servers:
- url: https://www.picpurify.com
tags:
- name: Image Analysis
  description: Submit an image (file upload or URL) for one or more moderation/detection tasks.
paths:
  /analyse/1.1:
    post:
      tags:
      - Image Analysis
      summary: Analyze an image
      description: Submit an image for moderation. Supports tasks such as gun_detection, knife_detection, weapon_moderation, porn_moderation, drug_moderation, gore_moderation, hate_sign_detection, money_detection, age_detection, gender_detection, and more.
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - API_KEY
              - task
              properties:
                API_KEY:
                  type: string
                  description: Your PicPurify API key.
                task:
                  type: string
                  description: One or more comma-separated moderation/detection tasks (e.g. "weapon_moderation,porn_moderation").
                file_image:
                  type: string
                  format: binary
                  description: Binary image file. Use this OR url_image.
                url_image:
                  type: string
                  format: uri
                  description: Public URL of the image to analyze. Use this OR file_image.
                reference_id:
                  type: string
                  description: Optional unique identifier returned in the response.
                origin_id:
                  type: string
                  description: Optional caller-supplied origin identifier.
      responses:
        '200':
          description: Analysis result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisResult'
components:
  schemas:
    AnalysisResult:
      type: object
      properties:
        status:
          type: string
          description: Request status (success or failure).
        final_decision:
          type: string
          enum:
          - OK
          - KO
          description: OK means content is acceptable; KO means it violates the requested task.
        confidence_score_decision:
          type: number
        reference_id:
          type: string
        origin_id:
          type: string
        media:
          type: object
          additionalProperties: true