Input Schema
{
"bodyFields": {
"aspect_ratio": {
"default": "1:1",
"description": "The aspect ratio of the generated image.",
"enum": [
"21:9",
"16:9",
"3:2",
"4:3",
"5:4",
"1:1",
"4:5",
"3:4",
"2:3",
"9:16"
],
"required": false,
"type": "\"21:9\" | \"16:9\" | \"3:2\" | \"4:3\" | \"5:4\" | \"1:1\" | \"4:5\" | \"3:4\" | \"2:3\" | \"9:16\""
},
"limit_generations": {
"default": false,
"description": "Experimental parameter to limit the number of generations from each round of prompting to 1. Set to `True` to to disregard any instructions in the prompt regarding the number of images to generate.",
"required": false,
"type": "boolean"
},
"num_images": {
"default": 1,
"description": "Number of images to generate",
"enum": [
"1"
],
"required": false,
"type": "integer"
},
"output_format": {
"default": "png",
"description": "The format of the generated image.",
"enum": [
"jpeg",
"png",
"webp"
],
"required": false,
"type": "\"jpeg\" | \"png\" | \"webp\""
},
"prompt": {
"description": "The text prompt to generate an image from.",
"example": "An action shot of a black lab swimming in an inground suburban swimming pool. The camera is placed meticulously on the water line, dividing the image in half, revealing both the dogs head above water holding a tennis ball in it's mouth, and it's paws paddling underwater.",
"required": true,
"type": "string"
},
"seed": {
"description": "The same seed and the same prompt given to the same version of the model will output the same image every time.\n ",
"required": false,
"type": "integer"
},
"sync_mode": {
"default": false,
"description": "If set to true, the function will wait for the image to be generated and uploaded before returning the response. This will increase the latency of the function but it allows you to get the image directly in the response without going through the CDN.\n ",
"required": false,
"type": "boolean"
}
},
"bodyType": "json",
"method": "POST",
"type": "http"
}
Output Schema
{
"jobId": {
"description": "Unique job identifier",
"type": "string"
},
"requestId": {
"description": "Provider request identifier",
"type": "string"
},
"status": {
"description": "Job status",
"enum": [
"processing",
"completed",
"failed"
],
"type": "string"
},
"statusUrl": {
"description": "URL to check job status",
"type": "string"
}
}