Schema

---

Input Schema

Table

name string
Name for your generation (3-30 characters)
Default "My Image"

prompt string
A text description of the image you want to generate (40-2000 characters)

output_number integer
Number of images to generate (currently fixed at 1)
Default 1

aspect_ratio string
Aspect ratio for generated image
Default "1:1"

image_input array
Optional. Input image(s) to transform or use as reference (1-10 images max, 2MB each, 20MB total)
Default []

output_format string
Output format for generated image
Default "png"

JSON

{
  "type": "object",
  "title": "Image Generation API Input",
  "required": [
    "prompt"
  ],
  "properties": {
    "name": {
      "description": "Name for your generation (3-30 characters)",
      "type": "string",
      "title": "Name",
      "default": "My Image",
      "x-order": 0
    },
    "prompt": {
      "description": "A text description of the image you want to generate (40-2000 characters)",
      "type": "string",
      "title": "Prompt",
      "x-order": 1
    },
    "output_number": {
      "description": "Number of images to generate (currently fixed at 1)",
      "type": "integer",
      "title": "Output Number",
      "default": 1,
      "x-order": 2
    },
    "aspect_ratio": {
      "description": "Aspect ratio for generated image",
      "type": "string",
      "title": "aspect_ratio",
      "enum": [
        "match_input_image",
        "1:1",
        "2:3",
        "3:4",
        "4:5",
        "9:16",
        "3:2",
        "4:3",
        "5:4",
        "16:9",
        "21:9"
      ],
      "default": "1:1",
      "x-order": 3
    },
    "image_input": {
      "description": "Input image URL(s) to transform or use as reference (single URL or array of URLs, 1-10 images max, 2MB each, 20MB total)",
      "type": "array",
      "title": "Image Input",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "default": [],
      "x-order": 4
    },
    "output_format": {
      "description": "Output format for generated image",
      "type": "string",
      "title": "output_format",
      "enum": [
        "png",
        "jpg"
      ],
      "default": "png",
      "x-order": 5
    }
  }
}

Output Schema

Table

success boolean
Indicates if the request was successful

data object
Response data containing generation information

data.generationId string
Unique identifier for the generation

data.status string
Initial status of the generation
Returns "starting"

data.creditCost integer
Number of credits deducted for this generation

JSON

{
  "type": "object",
  "title": "Image Generation API Output",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "description": "Indicates if the request was successful",
      "type": "boolean",
      "title": "Success"
    },
    "data": {
      "description": "Response data containing generation information",
      "type": "object",
      "title": "Data",
      "properties": {
        "generationId": {
          "description": "Unique identifier for the generation",
          "type": "string",
          "format": "uuid",
          "title": "Generation ID"
        },
        "status": {
          "description": "Initial status of the generation",
          "type": "string",
          "enum": [
            "starting",
            "processing",
            "succeeded",
            "failed"
          ],
          "title": "Status"
        },
        "creditCost": {
          "description": "Number of credits deducted for this generation",
          "type": "integer",
          "title": "Credit Cost"
        }
      },
      "required": [
        "generationId",
        "status",
        "creditCost"
      ]
    }
  }
}