GPT-Image-1 API Reference

Overview

Property	Value
Model ID	`gpt-image-1`
Type	Text-to-Image, Image-to-Image
Pricing	$0.035/image
Average Time	40-70 seconds

Authentication

All API requests require authentication using a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Endpoints

1. Submit Generation Task

POST https://api.apixo.ai/api/v1/generateTask/gpt-image-1

2. Query Task Status

GET https://api.apixo.ai/api/v1/statusTask/gpt-image-1?taskId={taskId}

Request Parameters

Request Body Structure

{
  "request_type": "async",
  "callback_url": "https://your-server.com/callback",
  "input": {
    "mode": "gpt-image-1",
    "prompt": "Your image description",
    "aspect_ratio": "1:1",
    ...
  }
}

Top-Level Parameters

Parameter	Type	Required	Description
`request_type`	string	Yes	Request mode: `async` (poll results) or `callback` (webhook notification)
`callback_url`	string	No	Webhook URL for callback mode. Must be publicly accessible
`input`	object	Yes	Generation parameters (see below)

Input Parameters

Parameter	Type	Required	Default	Description
`mode`	string	Yes	`gpt-image-1`	Model version: `gpt-image-1` ($0.035/image)
`prompt`	string	Yes	-	Image description (max 10,000 characters)
`image_urls`	string[]	No	-	Up to 5 reference image URLs for image-to-image editing
`aspect_ratio`	string	Yes	`1:1`	Output ratio: `1:1`, `2:3`, `3:2`
`nVariants`	integer	Yes	`1`	Number of image variations: `1`, `2`, `4`
`isEnhance`	boolean	No	`false`	Enable prompt enhancement for refined outputs

Response Format

Task Submission Response

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678"
  }
}

Status Query Response

Processing:

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "processing",
    "createTime": 1698765400000
  }
}

Success:

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://example.com/image.jpg\"]}",
    "costTime": 55000,
    "createTime": 1698765400000,
    "completeTime": 1698765455000
  }
}

Failed:

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "failed",
    "failCode": "CONTENT_VIOLATION",
    "failMsg": "Content does not meet safety guidelines",
    "createTime": 1698765400000,
    "completeTime": 1698765455000
  }
}

Response Fields:

Field	Type	Description
`code`	integer	HTTP status code (200 = success)
`data.taskId`	string	Unique task identifier
`data.state`	string	Task state: `pending`, `processing`, `success`, `failed`
`data.resultJson`	string	JSON string with `resultUrls` array (on success)
`data.costTime`	integer	Generation time in milliseconds
`data.failCode`	string	Error code (on failure)
`data.failMsg`	string	Error message (on failure)

Callback Response

When the task is completed, the system will send a POST request to your callBackUrl in the following format:

Success Callback

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://example.com/result.jpg\"]}",
    "completeTime": 1698765455000,
    "createTime": 1698765400000,
    "costTime": 55000
  }
}

Failure Callback

{
  "code": 400,
  "message": "failed",
  "data": {
    "taskId": "task_12345678",
    "state": "failed",
    "failCode": "CONTENT_VIOLATION",
    "failMsg": "Content does not meet safety guidelines",
    "completeTime": 1698765455000,
    "createTime": 1698765400000,
    "costTime": 55000
  }
}

Quick Start

1. Text-to-Image Generation

curl -X POST https://api.apixo.ai/api/v1/generateTask/gpt-image-1 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "async",
    "input": {
      "mode": "gpt-image-1",
      "prompt": "A beautiful sunset over the mountains",
      "aspect_ratio": "1:1",
      "nVariants": 1
    }
  }'

Response:

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678"
  }
}

2. Check Task Status

curl -X GET "https://api.apixo.ai/api/v1/statusTask/gpt-image-1?taskId=task_12345678" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response (Success):

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://example.com/image.jpg\"]}"
  }
}

3. Image-to-Image Editing

curl -X POST https://api.apixo.ai/api/v1/generateTask/gpt-image-1 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "async",
    "input": {
      "mode": "gpt-image-1",
      "prompt": "Make the background brighter and more vibrant",
      "image_urls": ["https://example.com/input.jpg"],
      "aspect_ratio": "1:1",
      "nVariants": 2
    }
  }'

Best Practices

Request Mode Selection

Mode	Use When
Callback	Production environments with public server endpoints
Async	Client-side apps or when webhook setup is not feasible

Performance Tips

Async Mode: Wait 40-50 seconds before first poll, then poll every 10 seconds
Timeout: Set maximum wait time to 3 minutes
Rate Limiting: Avoid excessive concurrent requests
Error Handling: Always check state field and handle failures gracefully

Resource Management

Image URLs may be temporary - download and store important results
Clean up failed tasks appropriately
Log taskId for debugging and support