Skip to main content
POST
Use esta rota para editar uma ou mais imagens com modelos de imagem Grok. O corpo da solicitação usa application/json.

​
Forneça imagens de entrada

  • Envie exatamente um de image ou images.
  • Use image para uma imagem de origem.
  • Use images para duas ou três imagens de origem.
  • Em cada objeto de imagem, use url para uma URL pública ou URI de dados. image_url é um alias de compatibilidade para url.
  • Use aspect_ratio para controlar o formato da saída em edições de várias imagens.
Escolha um ID de modelo de imagem Grok na página de modelos. Os exemplos da API usam grok-imagine-image-quality.
Envie solicitações de edição de imagens do Grok como JSON. Dados de formulário multipart não representam essa estrutura de solicitação.
O método images.edit() do SDK da OpenAI envia dados de formulário multipart. Use uma solicitação HTTP direta para edições de imagens JSON do Grok. Para detalhes sobre os parâmetros do provedor, consulte o guia de edição de imagens da xAI.

Autorizações

​
Authorization
string
header
obrigatório

Use your CometAPI API key as the bearer value.

Corpo

application/json
​
model
enum<string>
obrigatório

The Grok image model ID. See the Models page for available model IDs.

Opções disponíveis:
grok-imagine-image,
grok-imagine-image-quality
Exemplo:

"grok-imagine-image-quality"

​
prompt
string
obrigatório

A text instruction that describes the requested edit.

Minimum string length: 1
Exemplo:

"Replace the daytime sky with a soft sunset and preserve the building"

​
image
object
obrigatório

One source image. Use this field instead of images.

​
images
object[]

Two or three source images. Use this field instead of image.

Required array length: 2 - 3 elements

A source image represented by url or the compatibility alias image_url.

​
n
integer
padrão:1

The number of edited images to generate. Use an integer from 1 through 10.

Intervalo necessário: 1 <= x <= 10
​
aspect_ratio
enum<string>

The output shape for a multi-image edit.

Opções disponíveis:
1:1,
3:4,
4:3,
16:9,
2:3,
3:2,
9:19.5,
19.5:9,
9:20,
20:9,
1:2
Exemplo:

"16:9"

​
resolution
enum<string>

The requested output resolution.

Opções disponíveis:
1k,
2k
Exemplo:

"1k"

​
response_format
enum<string>
padrão:url

The image representation in each response item. Use url for a temporary download URL or b64_json for Base64-encoded image bytes.

Opções disponíveis:
url,
b64_json

Resposta

200 - application/json

The edited image results.

​
data
object[]
obrigatório

The edited images.

Minimum array length: 1
​
usage
object
obrigatório

Usage details for the request.