Image Editing Background Change

48 credits/call
ae_image_editing_background_change

Replace an image's background with a new scene described in your prompt.

Image
48 credits/call

Pricing

48 credits/call
ConditionCharge
Each call48 credits/call

Parameters

Optional parameters use the platform defaults when omitted.

ParameterTypeRequiredDescriptionDefault
request_bodyobjectYesNo parameter description.—
request_body.seedinteger | unknownNoThe same seed and the same prompt given to the same version of the model will output the same image every time.—
request_body.promptstringNoThe desired background to apply.beach sunset with palm trees
request_body.image_urlstringYesImage prompt for the omni model.—
request_body.sync_modebooleanNoIf `True`, the media will be returned as a data URI and the output data won't be available in the request history.false
request_body.aspect_ratiostring | unknownNoThe aspect ratio of the generated image.—
request_body.output_formatenum (jpeg | png)NoThe format of the generated image.jpeg
request_body.guidance_scalenumberNoThe CFG (Classifier Free Guidance) scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you.3.5
request_body.safety_toleranceenum (1 | 2 | 3 | 4 | 5 | 6)NoThe safety tolerance level for the generated image. 1 being the most strict and 6 being the most permissive.2
request_body.num_inference_stepsintegerNoNumber of inference steps for sampling.30

Invocation example

Copy the request and explore its response example.

POST/agent-api/v1/tool/executeX-Api-Key

Submit first, then query with the returned task_id until the task completes.

Request coderequest.sh
curl --request POST \
  --url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_image_editing_background_change' \
  --header "X-Api-Key: $AGENTEARTH_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "params": {
    "request_body": {
      "aspect_ratio": "9:16",
      "image_url": "https://d.uguu.se/inPcpTMx.jpg",
      "num_inference_steps": 30,
      "output_format": "jpeg",
      "prompt": "Professional ID photo background: replace the background with a smooth light blue studio gradient backdrop (lighter at bottom, standard Chinese ID photo blue). Keep the girl, her face, hair, pink jacket and purple headband exactly unchanged with clean natural edges. Remove any stray clothing or objects floating in the background area.",
      "safety_tolerance": "2"
    }
  }
}'
Response exampleresponse.json
JSON
{
  "description": "task accepted; poll the result via query_tool with this task_id",
  "query_tool": "ae_get_result",
  "status": "created",
  "task_id": "5a059fb8-65ae-422b-af50-c9e221cfdbe4"
}