DreamAPI
DreamAPI
Docs

Outpainting

POSThttps://api.newportai.com/api/async/outpainting

The Outpainting API extends the boundaries of an image, creating a larger canvas while ensuring a seamless transition between the original content and the newly generated areas. This feature is ideal for adjusting aspect ratios or enhancing the overall composition of an image.

  • Submit a POST request to the Outpainting API to obtain a taskId.
  • Submit a POST request to the Polling API to retrieve the outpainted results.
  • Configure a Callback URL to receive results automatically on completion.

Request Headers

Content-Type string Required

Enum: application/json

Authorization string Required

Bearer authentication token. Example: Bearer {{APIKey}}.

Request Body

url string Required

The URL of the source image. Constraints: maximum resolution of 16 megapixels and a maximum file size of 10MB.

outPaintSize object Required

Specifies the number of pixels to extend in each direction. Format: { "left": integer, "right": integer, "top": integer, "bottom": integer }.

Response

code integer

Returns 0 for success, or a specific error code.

message string

Returns "success" or a descriptive error message.

data object
taskId string

The unique identifier for the task. Use this ID with the Polling API to retrieve the generated output.

Errors

10192Illegal param

Polling

Use the Polling API to retrieve the processing results.

Callback

Alternatively, you can enable Callback to receive task results automatically upon completion.

0Task Completed
{
  "code": 0,
  "message": "success",
  "data": {
    "task": {
      "taskId": "b08337dc08d7428daa64b3d5e61b8350",
      "status": 3,
      "taskType": "outpainting"
    },
    "images": [
      {
        "imageType": "png",
        "imageUrl": "https://dreamface-resource-cv.oss-us-east-1.aliyuncs.com/aigc-dreamface-outpainting/2025-06-27/outpainting-result.png"
      }
    ]
  }
}
Request
cURL
curl -X POST 'https://api.newportai.com/api/async/outpainting' \
  -H "Authorization: Bearer {{key}}" \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://d2t5pyzt5qvy2d.cloudfront.net/api/static_resource/prod/default/INj5UrnnrKIzCR1uYBWv0.png",
  "outPaintSize": {
      "left": 100,
      "right": 100,
      "top": 100,
      "bottom": 100
  }
}'
0Successful
{
  "code": 0,
  "message": "success",
  "data": {
    "taskId": "b08337dc08d7428daa64b3d5e61b8350"
  }
}