Rivya AI Docs
Model API Pages

Seedream 5.0 Pro API Integration

Use Seedream 5.0 Pro through Rivya Public API v1 with model id seedream-5-pro, supported inputs, parameters, Files API rules, credits, and response examples.

Available via APIText or URL ready; reference modes use Files APIImage
API model id

seedream-5-pro

Inputs

text, file

Files API

Required for reference modes

Base credits

per_image_plus_reference_image · basic=7 · high=14 · additional_input_image=0.5 · ⌈total⌉

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-5-proUse the seedream-5-pro 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
aspect_ratioselectNo1:1-1:1, 4:3, 3:4, 16:9, 9:16, 2:3, 3:2, 21:9Aspect ratio
qualityselectNobasic-basic, highQuality
output_formatselectNopng-png, jpegOutput format
nsfw_checkerselectNofalse-false, trueEnable the model's optional content filter. No automated filter can guarantee complete coverage.

Upload policy

Upload reference files first, then place the returned URL and duration token inside params.referenceMediaItems.

Reference rule

Reference images: Upload up to 10 JPEG, PNG, or WebP images, no more than 10 MB each.

Max files

10

Accepted file kinds

image

Duration token

Video and audio references should carry durationToken from /api/v1/files when duration verification is required.

kindMax sizeMIME types
image10 MBimage/jpeg, image/png, image/webp

Minimal request

{
  "model": "seedream-5-pro",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1",
    "quality": "basic",
    "output_format": "png",
    "nsfw_checker": "false"
  }
}

Reference-file request

{
  "model": "seedream-5-pro",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1",
    "quality": "basic",
    "output_format": "png",
    "nsfw_checker": "false",
    "referenceMediaItems": [
      {
        "url": "https://cdn.example.com/reference-image.png",
        "kind": "image",
        "name": "reference-image.png",
        "mimeType": "image/png",
        "width": 1024,
        "height": 1024,
        "sizeBytes": 1048576,
        "imageDimensionsToken": "image_dimensions_token_from_original_files_api_upload_response"
      }
    ]
  }
}

Create response

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

{
  "id": "task_seedream_5_pro_example",
  "status": "queued",
  "model": "seedream-5-pro",
  "reserved_credits": 7,
  "final_credits": 0,
  "settlement_status": "RESERVED",
  "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

Some modes require Files API reference uploads.