↓
Rivya AI Docs
Model API guides

Flux Kontext Pro API reference

Check Flux Kontext Pro availability, inputs, parameters, file requirements, credit pricing, and request examples for Rivya Public API v1. Model ID: flux-kontext-pro.

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

flux-kontext-pro

Inputs

text, file

Files API

Required for reference modes

Credit pricing

Credit rate: 4 per image The final cost is rounded up to whole credits.

Capability

Image

Billing

FIXED

Prompt limit

No documented prompt limit

Request fields

Set model at the top level. Put model-specific controls and reference inputs in params, using the format documented for this model.

KeyTypeRequiredDefaultDescription
modelstringYesflux-kontext-proSet model to flux-kontext-pro.
promptstringYes-Prompt text for models that support text input.
paramsobjectNo-The model-specific params object. Use the documented keys and reference-file format for this model.
client_request_idstringNo-Optional ID for tracing this request in your system. It does not replace Idempotency-Key.

Model parameters

KeyTypeRequiredDefaultRangeOptionsDescription
aspectRatioselectNo16:9-21:9, 16:9, 4:3, 1:1, 3:4, 9:16Aspect ratio
outputFormatselectNojpeg-jpeg, pngChoose JPEG or PNG for the generated file. Selecting PNG does not by itself make the background transparent.
enableTranslationselectNotrue-true, falseTranslate prompt to English
promptUpsamplingselectNofalse-false, trueAsk the provider to expand the prompt before generation. Leave this disabled if you do not want to request that extra rewriting.
safetyTolerancenumberNo2min 0 / max 6-Sets the provider's content-filtering level. Use an integer from 0 to 6 for text-to-image generation, or from 0 to 2 when editing a reference image.
watermarktextNo---Watermark

Upload policy

Upload reference files through Files API first. Keep the original URLs, verified metadata, and tokens. Follow this model's request example: some models use params.referenceMediaItems, while others use different fields.

Reference rule

Reference image: Upload a JPEG, PNG, or WebP image to edit, up to 10 MB. Sign in before uploading.

Max files

1

Accepted file kinds

image

Duration token

When duration verification is required, use duration_token from /api/v1/files as durationToken in the request. Keep any additional signed metadata this model requires.

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

Minimal request

{
  "model": "flux-kontext-pro",
  "prompt": "A product bottle on a light gray background, lit softly from the left.",
  "params": {
    "aspectRatio": "16:9",
    "outputFormat": "jpeg",
    "enableTranslation": "true",
    "promptUpsampling": "false",
    "safetyTolerance": 2,
    "watermark": "Optional watermark identifier"
  }
}

Reference-file request

{
  "model": "flux-kontext-pro",
  "prompt": "A product bottle on a light gray background, lit softly from the left.",
  "params": {
    "aspectRatio": "16:9",
    "outputFormat": "jpeg",
    "enableTranslation": "true",
    "promptUpsampling": "false",
    "safetyTolerance": 2,
    "watermark": "Optional watermark identifier",
    "referenceMediaItems": [
      {
        "url": "https://cdn.example.com/reference-image.png",
        "kind": "image",
        "name": "reference-image.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Example response

An accepted generation request returns a task ID. Poll the status endpoint until the task succeeds or fails. A status request failure does not mean generation failed.

{
  "id": "task_flux_kontext_pro_example",
  "status": "queued",
  "model": "flux-kontext-pro",
  "reserved_credits": 4,
  "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.