API Reference

Replace background ​

POST https://api.newportai.com/api/async/replace_background

Replace backgroup feature would remove the existing backdrop and substituting it with a new one that aligns with the desired context. This process allows for the alteration of the image’s mood, theme, or setting to match the intended purpose or style specified in the prompt.

  • Use Replace backgroup API to get taskId with POST method.
  • Use Polling API to get Replcae backgroup result with POST method.

Request Header Parameters ​

  • Content-TypestringRequired
    Enum
    application/json
  • AuthorizationstringRequired
    Bearer authentication format, for example: Bearer

Request Body Parameters ​

  • urlstringRequired
    url of the original image, with a maximum resolution of 16 megawpixels and a max file size of 10MB.
  • promptstringRequired
    Text input required to guide the image generation, divided by `,`, Range[1,1024].

Response ​

  • codeinteger
    0 success, or error code.
  • messagestring
    "success", or error msg.
  • dataobject
    taskIdstring
    Use the taskId to request the Polling API to retrieve the generated outputs.

Example ​

Request:

zsh
curl -X POST 'https://api.newportai.com/api/async/replace_background' \
-H "Authorization: Bearer {{key}}" \
-H 'Content-Type: application/json' \
--data '{
  "url": "https://newportai-api-market.s3.amazonaws.com/demo_image/demo_image.jpg",
  "prompt": "desert"
}'

Response:

json
{
  "code": 0,
  "message": "success", 
  "data": {
    "taskId": "b08337dc08d7428daa64b3d5e61b8350"
  }
}

Next Step: ​

Use Polling API to get the result.

Demo
before
after