Skip to main content
POST
  1. After submission, a task_id will be returned. If you provided a callback_url, when the task status becomes finished or failed, a POST request will be sent to the callback_url.
  2. Regardless of whether callback_url is provided, you can retrieve the result through the unified Query Task Status endpoint.
Make targeted image changes with GPT Image 1.5 using text instructions, reference images, and optional masks for selected areas.

Models

  • openai/gpt-image-1.5/edit - Edit images using a prompt and image references.

Features

  • Edit images using a prompt and image references.
  • Accepts at least 1 image in image_urls.
  • Each editing request produces one image and is billed as one image.

Output Options

Image Size

  • size: Optional. Accepted values: 1024x1024, 1024x1536, 1536x1024. Default: 1024x1024.

Image Count

  • n: Optional compatibility parameter. Accepted values: 1, 2, 3, 4. Default: 1. Each edit request produces one image and is billed for one image; larger values do not increase the output count.

Advanced Parameters

Set model and optional callback_url at the request root. Place all workflow parameters, including output options, inside input.

Prompt

  • prompt: Required. Describe the requested changes. Length: 1-1,000 characters.
  • Include at least one non-whitespace character.

Image URLs

  • image_urls: Required. Provide publicly accessible image URLs. Supply at least 1 item. Each item must be an HTTP(S) URL.

Mask URL

  • mask_url: Optional. Publicly accessible HTTP(S) URL of a mask image that selects the area to edit.

Authorizations

Authorization
string
header
required

Use VIDGO_API_KEY.

Body

application/json

Set model and optional callback_url at the request root. Place generation parameters inside input.

model
enum<string>
required
Available options:
openai/gpt-image-1.5/edit
Example:

"openai/gpt-image-1.5/edit"

input
object
required
callback_url
string | null

Public HTTP(S) URL that receives a POST notification when the task reaches finished or failed.

Response

Task submitted

code
enum<integer>
required
Available options:
200
data
object
required