Rivya AI Docs
Model API Pages

Ideogram V3 API Integration

Ideogram V3 کو Rivya Public API v1 کے ذریعے model id ideogram-v3، supported inputs، parameters، Files API rules، credits اور response examples کے ساتھ استعمال کریں۔

API کے ذریعے availableText input readyتصویر
API model id

ideogram-v3

Inputs

text

Files API

Minimal request کے لیے required نہیں

Base credits

7

Capability

تصویر

Billing

FIXED

Prompt limit

5000 characters

Request contract

model id کو top level پر بھیجیں۔ Model-specific controls params میں رہتے ہیں۔

KeyTypeRequiredDefaultDescription
modelstringYesideogram-v3ideogram-v3 API model id استعمال کریں۔
promptstringYes-اس model کے لیے زیادہ سے زیادہ 5000 characters۔
paramsobjectNo-Model-specific parameter object۔ allowed keys کے لیے نیچے والی rows استعمال کریں۔
client_request_idstringNo-آپ کے system میں requests trace کرنے کے لیے optional client-side id۔

Model parameters

KeyTypeRequiredDefaultRangeOptionsDescription
rendering_speedselectNoBALANCED-TURBO, BALANCED, QUALITYSpeed، cost، اور detail کو balance کرتا ہے۔ Turbo سب سے تیز اور cheapest ہے، Quality سب سے detailed اور most expensive ہے، اور Balanced default middle ground ہے۔
styleselectNoAUTO-AUTO, GENERAL, REALISTIC, DESIGNStyle
expand_promptselectNotrue-true, falseIdeogram کا prompt expansion switch۔ اسے on کرنے سے model آپ کی description کو flesh out کرتا ہے؛ جب آپ tight prompt control چاہتے ہوں تو اسے off رکھنا بہتر ہے۔
image_sizeselectNosquare_hd-square, square_hd, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9Image size
seednumberNo-min 0-ہر بار نیا random result چاہیے ہو تو اسے empty چھوڑیں۔ اسی integer کو دوبارہ use کرنے سے previous result reproduce یا fine-tune کرنا آسان ہوتا ہے۔ Result صرف اسی وقت زیادہ قریب رہتا ہے جب prompt اور دوسرے key settings بھی similar رہیں، اور یہ guaranteed 1:1 match نہیں ہوتا۔
negative_prompttextNo---Negative prompt

Minimal request

{
  "model": "ideogram-v3",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "rendering_speed": "BALANCED",
    "style": "AUTO",
    "expand_prompt": "true",
    "image_size": "square_hd",
    "seed": 0,
    "negative_prompt": "Avoid کرنے کے لئے optional things"
  }
}

Create response

create endpoint ایک public task id واپس کرتا ہے۔ task succeeded یا failed ہونے تک status endpoint poll کریں۔

{
  "id": "task_ideogram_v3_example",
  "status": "queued",
  "model": "ideogram-v3",
  "reserved_credits": 7,
  "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

create endpoint ایک public task id واپس کرتا ہے۔ task succeeded یا failed ہونے تک status endpoint poll کریں۔