# Replace background

Replaces the image background using the provided text prompt and returns a photorealistic composite.

<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>

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

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "paths": {
    "/v1/image/replace-background": {
      "post": {
        "description": "Replaces the image background using the provided text prompt and returns a photorealistic composite.",
        "operationId": "replaceBackground",
        "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 prompt\n     Size of an image uploaded must not exceed 20MB and resolution must not exceed 4 mega-pixels (2048*2048)\n     Prompt must not exceed 5000 characters\n    ",
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "image_file": {
                    "type": "string",
                    "format": "binary"
                  },
                  "prompt": {
                    "type": "string",
                    "description": "Description of the desired background",
                    "maxLength": 5000
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The image background was successfully replaced."
          },
          "400": {
            "description": "Bad request. May be missing required inputs or may have badly formatted inputs or options."
          },
          "500": {
            "description": "Internal server error. Unable to replace background."
          }
        },
        "security": [
          {
            "X-API-Key": []
          },
          {
            "oauth2": [
              "user"
            ]
          }
        ],
        "summary": "Replace background",
        "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
  }
}
```