> ## Documentation Index
> Fetch the complete documentation index at: https://developers.jasper.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Clean up

Remove unwanted elements from an image using a mask to specify areas to clean

<Callout icon="📘" theme="info">
  ## Get Started with Image API

  To use Jasper's Image endpoints, you'll need an API key. Image API access is available for customers on the Jasper Business plan with an API subscription.

  **Already a Business customer?** Generate your API key in <Anchor label="Settings → API Tokens" target="_blank" href="https://app.jasper.ai/settings/dev-tools/tokens">Settings → API Tokens</Anchor>.

  **New to Jasper?** [Request API access →](https://developers.jasper.ai/docs/request-image-api-access)
</Callout>

Cleanup now supports RGBA images. Read the [native RGBA object removal blog post](https://www.jasper.ai/blog/native-rgba-object-removal)  for more details.

<a label="LLM friendly version" href="https://developers.jasper.ai/reference/cleanup.md">LLM friendly version</a>

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "paths": {
    "/v1/image/cleanup": {
      "post": {
        "description": "Remove unwanted elements from an image using a mask to specify areas to clean",
        "operationId": "cleanup",
        "parameters": [
          {
            "name": "accept",
            "required": false,
            "in": "header",
            "description": "The Accept request HTTP header indicates the preferred returned image content type, expressed as a MIME type",
            "schema": {
              "type": "string",
              "enum": [
                "image/webp",
                "image/png",
                "image/jpeg"
              ]
            }
          }
        ],
        "requestBody": {
          "required": true,
          "description": "Image file upload and mask file upload\n     Size of an image uploaded must not exceed 30MB and resolution must not exceed 16 mega-pixels\n     Size of a mask uploaded must not exceed 30MB and resolution must not exceed 16 mega-pixels\n     Both image and mask must have the same size\n    ",
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "image_file": {
                    "type": "string",
                    "format": "binary",
                    "description": "The image to be cleaned"
                  },
                  "mask_file": {
                    "type": "string",
                    "format": "binary",
                    "description": "The mask indicating areas to clean\n          The mask should be black and white with no grey pixels (e.g. values of only 0 or 255), the value of 0 indicating a pixel to keep as is and 255 a pixel to 'clean up'\n          "
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The image was successfully cleaned."
          },
          "400": {
            "description": "Bad request. May be missing required inputs or may have badly formatted inputs or options."
          },
          "500": {
            "description": "Internal server error. Unable to clean image."
          }
        },
        "security": [
          {
            "X-API-Key": []
          },
          {
            "oauth2": [
              "user"
            ]
          }
        ],
        "summary": "Clean up",
        "tags": [
          "Images"
        ]
      }
    }
  },
  "info": {
    "title": "Jasper API",
    "description": "Jasper API",
    "version": "1.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://api.jasper.ai"
    }
  ],
  "components": {
    "securitySchemes": {
      "X-API-Key": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "Workspace authentication using API key tokens in the X-API-Key header."
      },
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://api.jasper.ai/oauth2/authorize",
            "tokenUrl": "https://api.jasper.ai/oauth2/token",
            "refreshUrl": "https://api.jasper.ai/oauth2/token",
            "scopes": {
              "user:read": "Read user information",
              "user": "Read and write user information"
            }
          }
        },
        "description": "User-level authentication using OAuth bearer tokens in the Authorization header."
      }
    }
  },
  "x-readme": {
    "metrics-enabled": false
  }
}
```