Skip to main content
POST
Submit Flux Schnell Text to Image Task

Submit a Task

Send model: "blackforestlabs/flux/schnell" and an input object to POST /api/generate/submit. Authenticate with Authorization: Bearer VIDGO_API_KEY.
  • prompt: Required string. Describe the image using at least one character after trimming.
  • size: Output canvas, default 1:1. Choose 1:1, 1:1 HD, 4:3, 3:4, 16:9, 9:16, or a custom WIDTHxHEIGHT such as 1024x1536. Custom width and height are positive integers.
  • n: Positive integer specifying the output image count, default 1.
  • output_format: png or jpeg, default png.

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

First Light at the Cliffside Pool. This text-to-image example uses a prompt only.
First Light at the Cliffside Pool

Authorizations

Authorization
string
header
required

Use Authorization: Bearer VIDGO_API_KEY.

Body

application/json
model
enum<string>
required
Available options:
blackforestlabs/flux/schnell
input
object
required

Parameters for text-to-image generation.

callback_url
string<uri>

Optional webhook callback URL.

Response

Task submitted successfully

code
integer
required
Example:

200

data
object
required