GPT Image 2 API Integration
GPT Image 2 کو Rivya Public API v1 کے ذریعے model id gpt-image-2، supported inputs، parameters، Files API rules، credits اور response examples کے ساتھ استعمال کریں۔
gpt-image-2
text, file
Reference modes کے لیے required
3
تصویر
FIXED
20000 characters
Request contract
model id کو top level پر بھیجیں۔ Model-specific controls params میں رہتے ہیں۔
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| model | string | Yes | gpt-image-2 | gpt-image-2 API model id استعمال کریں۔ |
| prompt | string | Yes | - | اس model کے لیے زیادہ سے زیادہ 20000 characters۔ |
| params | object | No | - | Model-specific parameter object۔ allowed keys کے لیے نیچے والی rows استعمال کریں۔ |
| client_request_id | string | No | - | آپ کے system میں requests trace کرنے کے لیے optional client-side id۔ |
Model parameters
| Key | Type | Required | Default | Range | Options | Description |
|---|---|---|---|---|---|---|
| aspect_ratio | select | No | 1:1 | - | auto, 1:1, 9:16, 16:9, 4:3, 3:4 | Aspect ratio |
| resolution | select | No | 1K | - | 1K, 2K, 4K | Resolution |
Upload policy
Reference files پہلے upload کریں، پھر returned URL اور duration token کو params.referenceMediaItems کے اندر رکھیں۔
Reference images: GPT Image 2 image-to-image tasks کے لئے 16 image references تک upload کریں۔
16
image
duration verification required ہو تو video اور audio references کو /api/v1/files سے durationToken ساتھ رکھنا چاہیے۔
| kind | Max size | MIME types |
|---|---|---|
| image | 10 MB | image/jpeg, image/png, image/webp |
Minimal request
{
"model": "gpt-image-2",
"prompt": "A clean editorial product image on a soft studio background",
"params": {
"aspect_ratio": "1:1",
"resolution": "1K"
}
}Reference-file request
{
"model": "gpt-image-2",
"prompt": "A clean editorial product image on a soft studio background",
"params": {
"aspect_ratio": "1:1",
"resolution": "1K",
"referenceMediaItems": [
{
"url": "https://cdn.example.com/reference-image.png",
"kind": "image",
"name": "reference-image.png",
"mimeType": "image/png"
}
]
}
}Create response
create endpoint ایک public task id واپس کرتا ہے۔ task succeeded یا failed ہونے تک status endpoint poll کریں۔
{
"id": "task_gpt_image_2_example",
"status": "queued",
"model": "gpt-image-2",
"reserved_credits": 3,
"final_credits": 0,
"created_at": "2026-05-11T00:00:00.000Z",
"updated_at": "2026-05-11T00:00:00.000Z",
"result": null,
"error": null
}Common errors
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
کچھ modes کو Files API reference uploads درکار ہوتے ہیں۔