Skip to main content
POST
Gebruik deze route om een of meer afbeeldingen te bewerken met Grok-afbeeldingsmodellen. De aanvraagbody gebruikt application/json.

​
Afbeeldingsinvoer opgeven

  • Verstuur precies één van image of images.
  • Gebruik image voor één bronafbeelding.
  • Gebruik images voor twee of drie bronafbeeldingen.
  • Gebruik in elk afbeeldingsobject url voor een openbare URL of data-URI. image_url is een compatibiliteitsalias voor url.
  • Gebruik aspect_ratio om de uitvoervorm voor bewerkingen met meerdere afbeeldingen te bepalen.
Kies een Grok-afbeeldingsmodel-ID op de Models-pagina. De API-voorbeelden gebruiken grok-imagine-image-quality.
Verstuur Grok-aanvragen voor het bewerken van afbeeldingen als JSON. Multipart-formuliergegevens geven deze aanvraagstructuur niet weer.
De methode images.edit() van de OpenAI SDK verstuurt multipart-formuliergegevens. Gebruik een rechtstreekse HTTP-aanvraag voor Grok JSON-afbeeldingsbewerkingen. Zie voor details over providerparameters de handleiding voor het bewerken van xAI-afbeeldingen.

Autorisaties

​
Authorization
string
header
vereist

Use your CometAPI API key as the bearer value.

Body

application/json
​
model
enum<string>
vereist

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

Beschikbare opties:
grok-imagine-image,
grok-imagine-image-quality
Voorbeeld:

"grok-imagine-image-quality"

​
prompt
string
vereist

A text instruction that describes the requested edit.

Minimum string length: 1
Voorbeeld:

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

​
image
object
vereist

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
standaard:1

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

Vereist bereik: 1 <= x <= 10
​
aspect_ratio
enum<string>

The output shape for a multi-image edit.

Beschikbare opties:
1:1,
3:4,
4:3,
16:9,
2:3,
3:2,
9:19.5,
19.5:9,
9:20,
20:9,
1:2
Voorbeeld:

"16:9"

​
resolution
enum<string>

The requested output resolution.

Beschikbare opties:
1k,
2k
Voorbeeld:

"1k"

​
response_format
enum<string>
standaard:url

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

Beschikbare opties:
url,
b64_json

Respons

200 - application/json

The edited image results.

​
data
object[]
vereist

The edited images.

Minimum array length: 1
​
usage
object
vereist

Usage details for the request.