Rivya AI 文档
模型 API 接入文档

Flux Kontext Pro API 接入文档

通过 Rivya Public API v1 调用 Flux Kontext Pro,包含模型 ID flux-kontext-pro、输入类型、参数、Files API 规则、积分和响应示例。

API 可调用文本或 URL 可用;参考模式使用 Files API图片
API 模型 ID

flux-kontext-pro

输入类型

text, file

Files API

参考素材模式需要

基础积分

4

能力类型

图片

计费方式

FIXED

提示词上限

未配置提示词上限

请求字段

模型 ID 放在顶层字段。模型专属控制项放入 params。

Key类型必填默认值说明
modelstringflux-kontext-pro使用 flux-kontext-pro 作为 API 模型 ID。
promptstring-支持文本输入的模型使用这个字段传入提示词。
paramsobject-模型专属参数对象。可用 key 见下方参数表。
client_request_idstring-可选客户端请求 ID,便于你在自己的系统中追踪请求。

模型参数

Key类型必填默认值范围枚举值说明
aspectRatioselect16:9-21:9, 16:9, 4:3, 1:1, 3:4, 9:16宽高比
outputFormatselectjpeg-jpeg, pngJPEG 更省体积,PNG 更适合透明背景或无损边缘。
enableTranslationselecttrue-true, false自动翻译提示词
promptUpsamplingselectfalse-false, true开启后会先自动补充和润色提示词,再交给模型生成。通常更容易出细节,但结果也可能比原始提示词更主动发挥。
safetyTolerancenumber2min 0 / max 6-控制内容审核的宽松程度。文生图通常可用 0 到 6,编辑场景更窄;数值越低越严格,越高越宽松。
watermarktext---水印文本

上传策略

先上传参考文件,再把返回的 URL 和 durationToken 放入 params.referenceMediaItems。

参考素材规则

参考图片: 可上传最多 1 个图片参考素材,用于图片编辑项目。

最大文件数

1

支持文件类型

image

Duration token

视频和音频参考素材需要时长校验时,应携带 /api/v1/files 返回的 durationToken。

kind大小上限MIME 类型
image10 MBimage/jpeg, image/png, image/webp

最小请求

{
  "model": "flux-kontext-pro",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspectRatio": "16:9",
    "outputFormat": "jpeg",
    "enableTranslation": "true",
    "promptUpsampling": "false",
    "safetyTolerance": 2,
    "watermark": "可选水印文本"
  }
}

参考文件请求

{
  "model": "flux-kontext-pro",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspectRatio": "16:9",
    "outputFormat": "jpeg",
    "enableTranslation": "true",
    "promptUpsampling": "false",
    "safetyTolerance": 2,
    "watermark": "可选水印文本",
    "referenceMediaItems": [
      {
        "url": "https://cdn.example.com/reference-image.png",
        "kind": "image",
        "name": "reference-image.png",
        "mimeType": "image/png"
      }
    ]
  }
}

创建响应

创建接口会返回公开任务 ID。继续轮询状态接口,直到任务成功或失败。

{
  "id": "task_flux_kontext_pro_example",
  "status": "queued",
  "model": "flux-kontext-pro",
  "reserved_credits": 4,
  "final_credits": 0,
  "created_at": "2026-05-11T00:00:00.000Z",
  "updated_at": "2026-05-11T00:00:00.000Z",
  "result": null,
  "error": null
}

常见错误

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

部分模式需要通过 Files API 上传参考素材。