Ctrlk
My Account
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Images generation

Create Image generation

Image generation is used to obtain a proposal of 4 images based on a description and various parameters.

See details of the steps involved in image generation : https://developer.all-images.ai/integration-guide/image-generation

Create an image generation

post
Header parameters
api-keystringRequired
Body
namestringRequired
modestring · enumRequiredPossible values:
promptstring · max: 4096Required
additionalPromptstring · max: 1024Optional

Additional Prompt, not affected by optimization if enabled. Added at the beginning

optimizePromptbooleanOptional

Optimize description for image generation

processModestring · enumOptional

Mode of the image generation (only for "Dedicated" user)

Default: fastPossible values:
tagsstring[]Optional

Tags make it easy to find generations

metaDataobjectOptional

Pass on metadata to a ImageGeneration

Responses
200Success
application/json
idstringOptional
namestringRequired
promptstringRequired
statusnumber · enumRequired

0 = Create, 1 = Pending, 2 = Processing, 3 = Done, 4 = Error

Possible values:
processModestring · enumOptional

Mode of the image generation (only for "Dedicated" user)

Default: fastPossible values:
nbImagesnumberOptional
tagsstring[]Optional
metaDataobjectOptional
createdAtstring · date-timeOptional
post/v1/image-generations
POST /v1/image-generations HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "name": "text",
  "mode": "simple",
  "prompt": "text",
  "additionalPrompt": "text",
  "optimizePrompt": true,
  "params": [
    {
      "name": "sujetMode",
      "value": "text"
    }
  ],
  "processMode": "fast",
  "tags": [
    "text"
  ],
  "metaData": {}
}
{
  "id": "text",
  "name": "text",
  "prompt": "text",
  "status": 0,
  "params": [
    {
      "name": "sujetMode",
      "value": "text"
    }
  ],
  "processMode": "fast",
  "images": [
    {
      "id": "text",
      "url": "text",
      "urlFull": "text",
      "validate": true,
      "free": true,
      "titles": {}
    }
  ],
  "nbImages": 1,
  "tags": [
    "text"
  ],
  "metaData": {},
  "createdAt": "2026-01-01T00:00:00.000Z"
}

Update Image Generation

An image generation can only be updated if it is not in "Pending" or "In Progress" status. You can only specify the values to be modified in the request.

Update an image generation

put
Path parameters
printIdstringRequired
Header parameters
api-keystringRequired
Body
namestringOptional
modestring · enumOptionalPossible values:
promptstring · max: 4096Optional
additionalPromptstring · max: 1024Optional

Additional Prompt, not affected by optimization if enabled. Added at the beginning

optimizePromptbooleanOptional

Optimize description for image generation

processModestring · enumOptional

Mode of the image generation (only for "Dedicated" user)

Default: fastPossible values:
tagsstring[]Optional

Tags make it easy to find generations

metaDataobjectOptional

Pass on metadata to a ImageGeneration

Responses
200Success
application/json
idstringOptional
namestringRequired
promptstringRequired
statusnumber · enumRequired

0 = Create, 1 = Pending, 2 = Processing, 3 = Done, 4 = Error

Possible values:
processModestring · enumOptional

Mode of the image generation (only for "Dedicated" user)

Default: fastPossible values:
nbImagesnumberOptional
tagsstring[]Optional
metaDataobjectOptional
createdAtstring · date-timeOptional
put/v1/image-generations/{printId}
PUT /v1/image-generations/{printId} HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "name": "text",
  "mode": "simple",
  "prompt": "text",
  "additionalPrompt": "text",
  "optimizePrompt": true,
  "params": [
    {
      "name": "sujetMode",
      "value": "text"
    }
  ],
  "processMode": "fast",
  "tags": [
    "text"
  ],
  "metaData": {}
}
{
  "id": "text",
  "name": "text",
  "prompt": "text",
  "status": 0,
  "params": [
    {
      "name": "sujetMode",
      "value": "text"
    }
  ],
  "processMode": "fast",
  "images": [
    {
      "id": "text",
      "url": "text",
      "urlFull": "text",
      "validate": true,
      "free": true,
      "titles": {}
    }
  ],
  "nbImages": 1,
  "tags": [
    "text"
  ],
  "metaData": {},
  "createdAt": "2026-01-01T00:00:00.000Z"
}

Retry Image Generation

If a generation is in error, it can be restarted (after modifying the description, for example).

Retry an image generation failed

post
Path parameters
printIdstringRequired
Header parameters
api-keystringRequired
Responses
200Success
No content
post/v1/image-generations/retry/{printId}
POST /v1/image-generations/retry/{printId} HTTP/1.1
api-key: text
Accept: */*

No content

Find Image Generations

Retrieves a list of all image generations.

Get image generations

get
Query parameters
limitnumberOptional
offsetnumberOptional
sortstringOptional
namestringOptional

Search prints by name

tagstringOptional

Search prints by tag

Header parameters
api-keystringRequired
Responses
200Success
application/json
filteredResultsobjectOptional
get/v1/image-generations
GET /v1/image-generations HTTP/1.1
api-key: text
Accept: */*

{
  "filteredResults": {},
  "prints": [
    {
      "id": "text",
      "name": "text",
      "prompt": "text",
      "status": 0,
      "params": [
        {
          "name": "sujetMode",
          "value": "text"
        }
      ],
      "processMode": "fast",
      "images": [
        {
          "id": "text",
          "url": "text",
          "urlFull": "text",
          "validate": true,
          "free": true,
          "titles": {}
        }
      ],
      "nbImages": 1,
      "tags": [
        "text"
      ],
      "metaData": {},
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Get Image Generation

Retrieves an image generation from its ID.

Get an image generation

get
Path parameters
imageGenerationIdstringRequired
Header parameters
api-keystringRequired
Responses
200Success
application/json
idstringOptional
namestringRequired
promptstringRequired
statusnumber · enumRequired

0 = Create, 1 = Pending, 2 = Processing, 3 = Done, 4 = Error

Possible values:
processModestring · enumOptional

Mode of the image generation (only for "Dedicated" user)

Default: fastPossible values:
nbImagesnumberOptional
tagsstring[]Optional
metaDataobjectOptional
createdAtstring · date-timeOptional
get/v1/image-generations/{imageGenerationId}
GET /v1/image-generations/{imageGenerationId} HTTP/1.1
api-key: text
Accept: */*

{
  "id": "text",
  "name": "text",
  "prompt": "text",
  "status": 0,
  "params": [
    {
      "name": "sujetMode",
      "value": "text"
    }
  ],
  "processMode": "fast",
  "images": [
    {
      "id": "text",
      "url": "text",
      "urlFull": "text",
      "validate": true,
      "free": true,
      "titles": {}
    }
  ],
  "nbImages": 1,
  "tags": [
    "text"
  ],
  "metaData": {},
  "createdAt": "2026-01-01T00:00:00.000Z"
}

Delete Image Generation(s)

Delete one or more image generations.

Delete image generations

delete
Header parameters
api-keystringRequired
Body
printIdsstring[]Required

Print IDs to delete

Responses
200Success
No content
delete/v1/image-generations
DELETE /v1/image-generations HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "printIds": [
    "text"
  ]
}
No content
PreviousImagesNextAPI Keys

Last updated