Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer token used for request authentication. Alternatively, you can send the API key in the x-api-key header. Note: A payment method is required to use the API.

Body

application/json

Request body for the Grounded Generation API.

modality
enum<string>
required

The type of output to generate.

Available options:
image,
video
prompt
string
required

The text description of what to generate.

Required string length: 1 - 8000
model
enum<string>

The model to use. When omitted, the model default applies.

Available options:
google/gemini-3-pro-image,
minimax/hailuo-3
aspect_ratio
enum<string>
default:16:9

Aspect ratio of the output.

Available options:
16:9,
1:1,
9:16
duration
integer
default:5

Video length in seconds. Applies when modality is video. Values outside the allowed range are adjusted to the nearest bound.

Required range: 5 <= x <= 10

Response

Successful grounded generation response. The task starts in queued.

generation_id
string
required

Unique task id, used to retrieve the result.

modality
enum<string>
required

The type of output this task generates.

Available options:
image,
video
status
enum<string>
required

Task state.

Available options:
queued
created_at
integer
required

Unix timestamp in seconds when the task was created.

request_id
string

Unique identifier for the request.