openapi: 3.1.0
info:
  title: DeepFace Verify API
  version: 1.1.0
paths:
  /presence:
    post:
      summary: Presence
      description: |-
        ✨ Check for the presence of a person on one photo.
        Returns label from the set: Face, No face, Multiple faces.
      operationId: presence_presence_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PresenceRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresenceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v2/presence:
    post:
      summary: Presence V2
      description: |-
        ✨ Check for the presence of a person on one photo.
        Returns label from the set: Face, No face, Multiple faces.
      operationId: presence_v2_v2_presence_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PresenceRequestV2'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresenceResponseV2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /health:
    get:
      summary: Health
      operationId: health_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Health Health Get
  /v2/verify:
    post:
      summary: Verify V2
      operationId: verify_v2_v2_verify_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyRequestV2'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyResponseV2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /verify:
    post:
      summary: Verify
      operationId: verify_verify_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PresenceEnum:
      type: string
      enum:
        - FACE
        - NO_FACE
        - MULTIPLE_FACES
      title: PresenceEnum
    PresenceRequest:
      properties:
        url:
          type: string
          minLength: 1
          format: uri
          title: Url
      type: object
      required:
        - url
      title: PresenceRequest
    PresenceRequestV2:
      properties:
        image_base64:
          type: string
          title: Image Base64
      type: object
      required:
        - image_base64
      title: PresenceRequestV2
    PresenceResponse:
      properties:
        result:
          $ref: '#/components/schemas/PresenceEnum'
        count:
          type: integer
          title: Count
      type: object
      required:
        - result
        - count
      title: PresenceResponse
    PresenceResponseV2:
      properties:
        result:
          $ref: '#/components/schemas/PresenceEnum'
        count:
          type: integer
          title: Count
      type: object
      required:
        - result
        - count
      title: PresenceResponseV2
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    VerifyRequest:
      properties:
        url1:
          type: string
          minLength: 1
          format: uri
          title: Url1
        url2:
          type: string
          minLength: 1
          format: uri
          title: Url2
      type: object
      required:
        - url1
        - url2
      title: VerifyRequest
    VerifyRequestV2:
      properties:
        image1_base64:
          type: string
          title: Image1 Base64
        image2_base64:
          type: string
          title: Image2 Base64
      type: object
      required:
        - image1_base64
        - image2_base64
      title: VerifyRequestV2
    VerifyResponse:
      properties:
        verified:
          type: boolean
          title: Verified
      type: object
      required:
        - verified
      title: VerifyResponse
    VerifyResponseV2:
      properties:
        verified:
          type: boolean
          title: Verified
      type: object
      required:
        - verified
      title: VerifyResponseV2