Rivya AI Docs

Seedream 3.0 API Integration

Use Seedream 3.0 through Rivya Public API v1 with model id seedream-3-0, supported inputs, parameters, Files API rules, credits, and response examples.

Available via APIText input readyImage
API model id

seedream-3-0

Inputs

text

Files API

Not required for the minimal request

Base credits

5

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
modelstringYesseedream-3-0Use the seedream-3-0 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
image_sizeselectNosquare_hd-square, square_hd, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9Controls the output framing shape. Square HD is the current default and works well for most general compositions.
guidance_scalenumberNo2.5min 1 / max 10 / step 0.1-Valid values run from 1 to 10. Higher values usually follow the prompt more closely, but can also make the output feel more rigid.
seednumberNo-min 0 / max 2147483647-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.

Minimal request

{
  "model": "seedream-3-0",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "image_size": "square_hd",
    "guidance_scale": 2.5,
    "seed": 0
  }
}

Create response

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

{
  "id": "task_seedream_3_0_example",
  "status": "queued",
  "model": "seedream-3-0",
  "reserved_credits": 5,
  "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.