GPT-4O Image Generation
- GPT-4o (gpt-4o) model supports text-to-image, image-to-image, image editing and other generation modes
- Asynchronous processing mode, use the returned task ID to query
- Generated image links are valid for 24 hours, please save them promptly
OpenAPI
````yaml en/api-manual/image-series/gpt-4o/gpt-4o-image-generation.json post /v1/images/generations openapi: 3.1.0 info: title: gpt-4o-image Interface description: >- Use AI models to create image tasks, supporting multiple models and parameter configurations license: name: MIT version: 1.0.0 servers: - url: https://ai.odkkk.com/apiv1 description: Production environment security: - bearerAuth: [] tags: - name: Image Generation description: AI image generation related APIs paths: /v1/images/generations: post: tags: - Image Generation summary: gpt-4o-image Interface description: >- - GPT-4o (gpt-4o) model supports text-to-image, image-to-image, image editing and other generation modes
- Asynchronous processing mode, use the returned task ID to
[query](/en/api-manual/task-management/get-task-detail)
- Generated image links are valid for 24 hours, please save them
promptly
operationId: createImageGeneration
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ImageGenerationRequest'
examples:
text_to_image:
summary: Text to Image
value:
model: gpt-4o-image
prompt: A beautiful sunset over the ocean with vibrant colors
responses:
'200':
description: Image task created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ImageGenerationResponse'
'400':
description: Invalid request parameters
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 400
message: Invalid request parameters
type: invalid_request_error
'401':
description: Unauthenticated, invalid or expired token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 401
message: Invalid or expired token
type: authentication_error
'402':
description: Insufficient quota, recharge required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 402
message: Insufficient quota
type: insufficient_quota_error
fallback_suggestion: https://ai.odkkk.com/apiv1/dashboard/billing
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 403
message: Access denied for this model
type: permission_error
param: model
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 404
message: Specified model not found
type: not_found_error
param: model
fallback_suggestion: gpt-4o-image
'413':
description: Request entity too large
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 413
message: Image file too large
type: request_too_large_error
param: image_urls
fallback_suggestion: compress image to under 4MB
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 429
message: Rate limit exceeded
type: rate_limit_error
fallback_suggestion: retry after 60 seconds
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 500
message: Internal server error
type: internal_server_error
fallback_suggestion: try again later
'502':
description: Upstream service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 502
message: Upstream AI service unavailable
type: upstream_error
fallback_suggestion: try different model
'503':
description: Service temporarily unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 503
message: Service temporarily unavailable
type: service_unavailable_error
fallback_suggestion: retry after 30 seconds
components: schemas: ImageGenerationRequest: type: object required: - model - prompt properties: model: type: string description: Image generation model name enum: - gpt-4o-image default: gpt-4o-image example: gpt-4o-image prompt: type: string description: >- Prompt describing the desired image to generate, or describing how to edit the input image, limited to 2000 tokens example: A beautiful sunset over the ocean with vibrant colors maxLength: 2000 size: type: string description: |- Size of the generated image, supports two formats:
**Simplified ratio format:**
- Supports `1:1`, `2:3`, `3:2` values
**Pixel format:**
- Supports `1024x1024`, `1024x1536`, `1536x1024` values
enum:
- '1:1'
- '2:3'
- '3:2'
- 1024x1024
- 1024x1536
- 1536x1024
example: 1024x1024
'n':
type: integer
description: >-
Number of images to generate, currently only supports `1`, `2`, `4`
values.
**Note:**
- A single request will be pre-charged based on the value of `n`,
and the actual charge will be based on the number of generated
images
example: 1
image_urls:
type: array
description: >-
Reference image URL list for image-to-image and image editing
features
**Note:**
- Maximum number of input images per request: `5` images
- Single image size: no more than `10MB`
- Supported file formats: `.jpeg`, `.jpg`, `.png`, `.webp`
- Image URLs must be directly accessible by the server, or the image
URL should directly download when accessed (typically these URLs end
with image file extensions, such as `.png`, `.jpg`)
items:
type: string
format: uri
example:
- https://example.com/image1.png
- https://example.com/image2.png
mask_url:
type: string
description: >-
Mask image URL
**Note:**
- When using this parameter, the mask image and reference image must
be in PNG format with the same dimensions
- Mask image size cannot exceed 4MB
- This parameter cannot be used when the `image_urls` parameter
contains more than 1 image
format: uri
example: https://example.com/mask.png
callback_url:
type: string
description: >-
HTTPS callback address after task completion
**Callback Timing:**
- Triggered when task is completed, failed, or cancelled
- Sent after billing confirmation is completed
**Security Restrictions:**
- Only HTTPS protocol is supported
- Callback to internal IP addresses is prohibited (127.0.0.1,
10.x.x.x, 172.16-31.x.x, 192.168.x.x, etc.)
- URL length must not exceed `2048` characters
**Callback Mechanism:**
- Timeout: `10` seconds
- Maximum `3` retries on failure (retries after `1` second/`2`
seconds/`4` seconds)
- Callback response body format is consistent with the task query
API response format
- Callback address returning 2xx status code is considered
successful, other status codes will trigger retry
format: uri
example: https://your-domain.com/webhooks/image-task-completed
ImageGenerationResponse:
type: object
properties:
created:
type: integer
description: Task creation timestamp
example: 1757156493
id:
type: string
description: Task ID
example: task-unified-1757156493-imcg5zqt
model:
type: string
description: Actual model name used
example: gpt-4o-image
object:
type: string
enum:
- image.generation.task
description: Specific task type
progress:
type: integer
description: Task progress percentage (0-100)
minimum: 0
maximum: 100
example: 0
status:
type: string
description: Task status
enum:
- pending
- processing
- completed
- failed
example: pending
task_info:
$ref: '#/components/schemas/TaskInfo'
description: Asynchronous task information
type:
type: string
enum:
- text
- image
- audio
- video
description: Task output type
example: image
usage:
$ref: '#/components/schemas/Usage'
description: Usage and billing information
ErrorResponse:
type: object
properties:
error:
type: object
properties:
code:
type: integer
description: HTTP error status code
message:
type: string
description: Error description
type:
type: string
description: Error type
param:
type: string
description: Related parameter name
fallback_suggestion:
type: string
description: Suggestion when error occurs
TaskInfo:
type: object
properties:
can_cancel:
type: boolean
description: Whether the task can be cancelled
example: true
estimated_time:
type: integer
description: Estimated completion time (seconds)
minimum: 0
example: 100
Usage:
type: object
description: Usage and billing information
properties:
billing_rule:
type: string
description: Billing rule
enum:
- per_call
- per_token
- per_second
example: per_call
credits_reserved:
type: number
description: Estimated credits consumed
minimum: 0
example: 2.5
user_group:
type: string
description: User group category
example: default
securitySchemes: bearerAuth: type: http scheme: bearer description: >- ##All APIs require Bearer Token authentication##
**Get API Key:**
Visit [API Key Management Page](https://ai.odkkk.com/apiv1/dashboard/keys) to
get your API Key
**Add to request header when using:**
```
Authorization: Bearer YOUR_API_KEY
```
````
To find navigation and other pages in this documentation, fetch the llms.txt file at: https://ai.odkkk.com/apiv1/docs/llms.txt