Skip to main content
POST
Generate image using AI

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

collection_id
string
required
Example:

"default"

Body

application/json
prompt
string
required
Example:

"A beautiful sunset over mountains"

aspect_ratio
string
Example:

"16:9"

model_name
string

Model used for image generation.

Example:

"black-forest-labs/FLUX.1-dev"

config
object

Model configuration. For FLUX supports size, num_inference_steps, guidance_scale, negative_prompt, and seed.

sandbox_id
string

Sandbox ID used for self-hosted image generation.

Example:

"bx-123abc"

callback_url
string
Example:

"https://webhook.example.com/callback"

Response

200 - application/json

Image generation started

success
boolean
Example:

true

status
enum<string>
Available options:
processing,
done,
failed
Example:

"processing"

data
object