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.

Submit a Task

Send model: "blackforestlabs/flux/dev/image-to-image" and an input object to POST /api/generate/submit. Authenticate with Authorization: Bearer VIDGO_API_KEY.
  • prompt: Required string. Describe the image or editing instructions using at least one character after trimming.
  • image_urls: Required array containing one public HTTP(S) source-image URL. The source image guides the edited output.
  • n: Positive integer specifying the output image count, default 1.
  • output_format: png or jpeg, default png.

Canvas Parameter

size defines the text-to-image canvas and defaults to 1:1. Image-to-image generation uses the source image to guide the output. The request example supplies the source image, prompt, image count, and output format.

Retrieve Images

The submission response returns data.task_id. Use Query Task Status to follow the task through not_started, running, finished, or failed. Read image URLs from data.files[].file_url when the status is finished. For failed, read data.error_message. You can provide a top-level callback_url to receive the terminal result through a webhook.

Verified Example

This example was generated through the Vidgo test API. The source and result images are hosted on the Vidgo CDN. Source image A Warmer Reading Room

Authorizations

Authorization
string
header
required

Use Authorization: Bearer VIDGO_API_KEY.

Body

application/json
model
enum<string>
required
Available options:
blackforestlabs/flux/dev/image-to-image
input
object
required

Parameters for single-image editing.

callback_url
string<uri>

Optional webhook callback URL.

Response

Task submitted successfully

code
integer
required
Example:

200

data
object
required