GPT Image 2 Generator API documentation
Generate images with GPT Image 2 Generator (OpenAI).
Endpoints
| Contract item | Value |
|---|---|
| Capability | gpt-image-2-generator |
| Submit | POST https://vidmage.ai/api/v1/gpt-image-2-generator/submit |
| Query | POST https://vidmage.ai/api/v1/gpt-image-2-generator/query |
| Task identifier | taskId |
| Result field | imageUrl |
Authenticate with Authorization: Bearer YOUR_API_KEY. Save the task identifier and query the same capability. Use a stable Idempotency-Key for submission retries.
Product guide: GPT Image API
Parameters and input rules
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
prompt | string | Yes | Not specified | Text prompt describing the image to generate (max 20000 chars). For an unspecified character or figurine, use an original non-branded character with no logos and no resemblance to existing copyrighted superheroes; preserve any character the user explicitly names. Minimum characters: 1Maximum characters: 20000 |
aspectRatio | string | No | "16:9" | Output aspect ratio. Values: "1:1", "3:2", "2:3", "5:4", "4:5", "16:9", "9:16", "21:9", "3:4", "4:3", "9:21", "1:2", "2:1", "1:3", "3:1" |
resolution | string | No | "1k" | Output resolution tier. Values: "1k", "2k", "4k" |
text to image
These are public VidMage field names. The server maps them to provider fields. Input media selects the mode; use its limits together with the parameter table.
| Control | Mode-specific rule |
|---|---|
prompt | Required; 1–20000 characters. |
aspectRatio | Values: "1:1", "3:2", "2:3", "5:4", "4:5", "16:9", "9:16", "21:9", "3:4", "4:3", "9:21", "1:2", "2:1", "1:3", "3:1". Default: 16:9. |
resolution | Values: "1k", "2k", "4k". Default: 1k. |
Example request
{
"prompt": "A friendly home robot watering herbs in a bright Scandinavian kitchen, realistic lifestyle photography",
"aspectRatio": "16:9",
"resolution": "1k"
}# Set VIDMAGE_IDEMPOTENCY_KEY to a unique value for this task; preserve it for transport retries.
curl -X POST "https://vidmage.ai/api/v1/gpt-image-2-generator/submit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
-H "Content-Type: application/json" \
-d '{"prompt":"A friendly home robot watering herbs in a bright Scandinavian kitchen, realistic lifestyle photography","aspectRatio":"16:9","resolution":"1k"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }Task results and recovery
URL of the generated image. Read imageUrl from the completed query response. Preserve taskId while the task is running.
curl -X POST "https://vidmage.ai/api/v1/gpt-image-2-generator/query" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "imageUrl": "https://..." } }Submission and task queries report the available task and usage information. A timeout is not a confirmed failure. Recover the existing task instead of resubmitting.
For face selection and error recovery, follow Task lifecycle. MCP uses the normalized taskId argument in get_task_result, including capabilities whose REST identifier is requestId.
Credits
| Component / option | Rate | Minimum |
|---|---|---|
| 1k | 5 credits / generation | — |
| 2k | 5 credits / generation | — |
| 4k | 5 credits / generation | — |
Base charge is per generation at the selected resolution.
Use the Playground or the MCP credit estimator for your exact inputs. Credits and billing.