Integração da API de Grok Imagine
Use Grok Imagine pela Rivya Public API v1 com o ID de modelo grok-imagine, entradas compatíveis, parâmetros, regras da Files API, créditos e exemplos de resposta.
grok-imagine
text, file
Obrigatório para modos com referência
4
Imagem
FIXED
5000 caracteres
Contrato da requisição
Envie o ID do modelo no nível superior. Controles específicos do modelo ficam em params.
| Chave | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
| model | string | Sim | grok-imagine | Use grok-imagine como ID do modelo da API. |
| prompt | string | Sim | - | Máximo de 5000 caracteres para este modelo. |
| params | object | Não | - | Objeto de parâmetros específico do modelo. Use as linhas abaixo para ver as chaves permitidas. |
| client_request_id | string | Não | - | ID opcional do cliente para rastrear requisições no seu sistema. |
Parâmetros do modelo
| Chave | Tipo | Obrigatório | Padrão | Intervalo | Opções | Descrição |
|---|---|---|---|---|---|---|
| aspect_ratio | select | Não | 1:1 | - | 1:1, 2:3, 3:2, 16:9, 9:16 | Proporção |
| enable_pro | select | Não | false | - | false, true | Este é o seletor de qualidade do Grok Imagine apenas para texto para imagem. Padrão custa menos, enquanto Qualidade tende a trazer mais detalhes; o caminho atual de edição por imagem não usa essa opção. |
Política de upload
Faça upload dos arquivos de referência primeiro; depois coloque a URL retornada e o durationToken dentro de params.referenceMediaItems.
Imagem de referência: Envie até 1 arquivo de imagem para projetos com imagem.
1
image
Referências de vídeo e áudio devem carregar durationToken de /api/v1/files quando a verificação de duração for exigida.
| kind | Tamanho máximo | Tipos MIME |
|---|---|---|
| image | 10 MB | image/jpeg, image/png, image/webp |
Requisição mínima
{
"model": "grok-imagine",
"prompt": "A clean editorial product image on a soft studio background",
"params": {
"aspect_ratio": "1:1",
"enable_pro": "false"
}
}Requisição com arquivo de referência
{
"model": "grok-imagine",
"prompt": "A clean editorial product image on a soft studio background",
"params": {
"aspect_ratio": "1:1",
"enable_pro": "false",
"referenceMediaItems": [
{
"url": "https://cdn.example.com/reference-image.png",
"kind": "image",
"name": "reference-image.png",
"mimeType": "image/png"
}
]
}
}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_grok_imagine_example",
"status": "queued",
"model": "grok-imagine",
"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
}Erros comuns
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
Alguns modos exigem uploads de referência pela Files API.