Rivya AI Docs

Ideogram V3 API Integration

Use Ideogram V3 through Rivya Public API v1 with model id ideogram-v3, supported inputs, parameters, Files API rules, credits, and response examples.

Available via APIText input readyImage
API model id

ideogram-v3

Inputs

text

Files API

Not required for the minimal request

Base credits

7

Capability

Image

Billing

FIXED

Prompt limit

5000 characters

Request contract

Send the model id at the top level. Model-specific controls belong in params.

KeyTypeRequiredDefaultDescription
modelstringYesideogram-v3Use the ideogram-v3 API model id.
promptstringYes-Maximum 5000 characters for this model.
paramsobjectNo-Model-specific parameter object. Use the rows below for allowed keys.
client_request_idstringNo-Optional client-side id for tracing requests in your system.

Model parameters

KeyTypeRequiredDefaultRangeOptionsDescription
rendering_speedselectNoBALANCED-TURBO, BALANCED, QUALITYBalances speed, cost, and detail. Turbo is the fastest and cheapest, Quality is the most detailed and most expensive, and Balanced is the default middle ground.
styleselectNoAUTO-AUTO, GENERAL, REALISTIC, DESIGNStyle
expand_promptselectNotrue-true, falseIdeogram's prompt expansion switch. Turning it on helps the model flesh out your description; turning it off is better when you want tight prompt control.
image_sizeselectNosquare_hd-square, square_hd, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9Image size
seednumberNo-min 0-Leave it empty for a new random result each time. Reusing the same integer makes it easier to reproduce or fine-tune a previous result. It stays closer only when the prompt and other key settings also remain similar, and it is not a 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": "Optional things to avoid"
  }
}

Create response

The create endpoint returns a public task id. Poll the status endpoint until the task succeeds or fails.

{
  "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

The create endpoint returns a public task id. Poll the status endpoint until the task succeeds or fails.