Skip to main content
POST
/
collection
/
{collection_id}
/
generate
/
image
Generate image using AI
curl --request POST \
  --url https://api.videodb.io/collection/{collection_id}/generate/image/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "prompt": "A beautiful sunset over mountains",
  "aspect_ratio": "16:9",
  "callback_url": "https://webhook.example.com/callback"
}
'
{
  "success": true,
  "status": "processing",
  "data": {
    "id": "job-123",
    "output_url": "https://api.videodb.io/async-response/job-123"
  }
}
Create AI-generated images from text descriptions with customizable aspect ratios. The generated image is returned immediately as an Image object.
import videodb

conn = videodb.connect(api_key="your_api_key")
coll = conn.get_collection()

image = coll.generate_image(
    prompt="Serene mountain landscape with golden sunset",
    aspect_ratio="16:9"
)

print(image.id)
print(image.generate_url())
  • Supported aspect ratios: 1:1, 9:16, 16:9, 4:3, 3:4
  • Default aspect ratio is 1:1 if not specified
  • Generation is asynchronous; use callback_url for webhook notification when ready
  • Image IDs have an i- prefix (e.g., i-a1b2c3d4)

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"

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