Documentação da Rivya AI
Páginas de API por modelo

Integração da API de Z-Image

Use Z-Image pela Rivya Public API v1 com o ID de modelo z-image, entradas compatíveis, parâmetros, regras da Files API, créditos e exemplos de resposta.

Disponível via APIInput de texto prontoImagem
ID do modelo da API

z-image

Entradas

text

Files API

Não obrigatório para a requisição mínima

Créditos base

1

Capacidade

Imagem

Cobrança

FIXED

Limite de prompt

1000 caracteres

Contrato da requisição

Envie o ID do modelo no nível superior. Controles específicos do modelo ficam em params.

ChaveTipoObrigatórioPadrãoDescrição
modelstringSimz-imageUse z-image como ID do modelo da API.
promptstringSim-Máximo de 1000 caracteres para este modelo.
paramsobjectNão-Objeto de parâmetros específico do modelo. Use as linhas abaixo para ver as chaves permitidas.
client_request_idstringNão-ID opcional do cliente para rastrear requisições no seu sistema.

Parâmetros do modelo

ChaveTipoObrigatórioPadrãoIntervaloOpçõesDescrição
aspect_ratioselectNão1:1-1:1, 4:3, 3:4, 16:9, 9:16Proporção

Requisição mínima

{
  "model": "z-image",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1"
  }
}

Resposta de criação

O endpoint de criação retorna um ID público de tarefa. Consulte o endpoint de status até a tarefa ser concluída ou falhar.

{
  "id": "task_z_image_example",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "created_at": "2026-05-11T00:00:00.000Z",
  "updated_at": "2026-05-11T00:00:00.000Z",
  "result": null,
  "error": null
}

Erros comuns

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

O endpoint de criação retorna um ID público de tarefa. Consulte o endpoint de status até a tarefa ser concluída ou falhar.