# Background Remover API

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /image/background/remover:
    post:
      summary: Background Remover API
      deprecated: false
      description: >-
        This API endpoint allows you to remove the background from an image by
        uploading it. The response will contain the image with the background
        removed.
      tags:
        - Image Editing
        - image
      parameters:
        - name: Authorization
          in: header
          description: A bearer token that authenticates the user for making the request.
          required: true
          example: Bearer {{API Token}}
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            encoding:
              image:
                contentType: image/jpeg
            schema:
              type: object
              properties:
                image:
                  type: string
                  format: binary
                  description: >-
                    The image file to be processed, encoded in Base64 format or
                    as a standard file upload. The API will process this image
                    and return the same image with its background removed.
                  example: cmMtdXBsb2FkLTE3Mjg1NjE5NzAzMTktNA==/model.jpg
              required:
                - image
      responses:
        '200':
          description: >-
            If the request is successful, the API will return the image file
            with removed background.
          content:
            '*/*':
              schema:
                type: object
                properties: {}
              example: The response for 200 code is bytes.
          headers: {}
          x-apidog-name: Success
        '400':
          description: >-
            This response indicates that the request was invalid, likely due to
            incorrect parameters or missing fields. 
          content:
            application/json:
              schema:
                title: ''
                type: object
                properties:
                  status:
                    type: string
                    description: Request status
                  code:
                    type: integer
                    description: Error code
                  error:
                    type: string
                    description: Error name
                  message:
                    type: string
                    description: Error message
                x-apidog-orders:
                  - status
                  - code
                  - error
                  - message
                required:
                  - status
                  - code
                  - error
                  - message
              example:
                code: 1103
                error: InvalidBody
                message: No image was provided.
                status: error
          headers: {}
          x-apidog-name: Bad Request
        '500':
          description: >-
            This indicates that something went wrong on the server side while
            processing the request. It may be due to a server-side error or
            unexpected conditions. 
          content:
            application/json:
              schema:
                title: ''
                type: object
                properties:
                  status:
                    type: string
                    description: Request status
                  code:
                    type: integer
                    description: Error code
                  error:
                    type: string
                    description: Error name
                  message:
                    type: string
                    description: Error message
                x-apidog-orders:
                  - status
                  - code
                  - error
                  - message
                required:
                  - status
                  - code
                  - error
                  - message
              example:
                code: 1205
                error: InternalServiceError
                message: Unexpected service response.
                status: error
          headers: {}
          x-apidog-name: Internal Server Error
        '503':
          description: >-
            This error indicates that the service is currently down or
            unavailable. This could be due to high server load or scheduled
            maintenance.
          content:
            application/json:
              schema:
                title: ''
                type: object
                properties:
                  status:
                    type: string
                    description: Request status
                  code:
                    type: integer
                    description: Error code
                  error:
                    type: string
                    description: Error name
                  message:
                    type: string
                    description: Error message
                x-apidog-orders:
                  - status
                  - code
                  - error
                  - message
                required:
                  - status
                  - code
                  - error
                  - message
              example:
                code: 1206
                error: NotImplemented
                message: This service is not supported.
                status: error
          headers: {}
          x-apidog-name: Service Unavailable
        x-400:Bad Request:
          description: ''
          content:
            application/json:
              schema:
                title: ''
                type: object
                properties:
                  status:
                    type: string
                    description: Request status
                  code:
                    type: integer
                    description: Error code
                  error:
                    type: string
                    description: Error name
                  message:
                    type: string
                    description: Error message
                x-apidog-orders:
                  - status
                  - code
                  - error
                  - message
                required:
                  - status
                  - code
                  - error
                  - message
              example:
                code: 1103
                error: InvalidBody
                message: No style was provided.
                status: error
          headers: {}
          x-apidog-name: Bad Request
        x-200:Success:
          description: ''
          content:
            '*/*':
              schema:
                type: object
                properties: {}
              example: The response for 200 code is bytes.
          headers: {}
          x-apidog-name: Success
        x-500:Internal Server Error:
          description: ''
          content:
            application/json:
              schema:
                title: ''
                type: object
                properties:
                  status:
                    type: string
                    description: Request status
                  code:
                    type: integer
                    description: Error code
                  error:
                    type: string
                    description: Error name
                  message:
                    type: string
                    description: Error message
                x-apidog-orders:
                  - status
                  - code
                  - error
                  - message
                required:
                  - status
                  - code
                  - error
                  - message
              example:
                code: 1205
                error: InternalServiceError
                message: Unexpected service response.
                status: error
          headers: {}
          x-apidog-name: Internal Server Error
        x-503:Service Unavailable:
          description: ''
          content:
            application/json:
              schema:
                title: ''
                type: object
                properties:
                  status:
                    type: string
                    description: Request status
                  code:
                    type: integer
                    description: Error code
                  error:
                    type: string
                    description: Error name
                  message:
                    type: string
                    description: Error message
                x-apidog-orders:
                  - status
                  - code
                  - error
                  - message
                required:
                  - status
                  - code
                  - error
                  - message
              example:
                code: 1206
                error: NotImplemented
                message: This service is not supported.
                status: error
          headers: {}
          x-apidog-name: Service Unavailable
      security: []
      x-apidog-folder: Image Editing
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/690253/apis/api-10690786-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.vyro.ai/v2
    description: Prod Env
security: []

```