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

/v1/image-generations

Header parameters

api-keystringrequired

Body

namestringrequired

promptstring · max: 4096required

additionalPromptstring · max: 1024

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

optimizePromptboolean

Optimize description for image generation

metaDataobject

Pass on metadata to a ImageGeneration

modestring · enumrequired

Options: simple, advanced

processModestring · enum · default: fast

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

Options: relax, fast

paramsobject[]

tagsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/image-generations' \
  --header 'api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "prompt": "text",
    "additionalPrompt": "text",
    "optimizePrompt": true,
    "metaData": {},
    "mode": "simple",
    "processMode": "fast",
    "params": [
      {
        "value": "text",
        "name": "sujetMode"
      }
    ],
    "tags": [
      "text"
    ]
  }'

200

400

500

200

{
  "id": "text",
  "name": "text",
  "prompt": "text",
  "nbImages": 1,
  "metaData": {},
  "createdAt": "2025-02-28T07:10:40.666Z",
  "status": 0,
  "processMode": "fast",
  "params": [
    {
      "value": "text",
      "name": "sujetMode"
    }
  ],
  "images": [
    {
      "id": "text",
      "url": "text",
      "urlFull": "text",
      "validate": true,
      "free": true,
      "titles": {}
    }
  ],
  "tags": [
    "text"
  ]
}

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

/v1/image-generations/{printId}

Path parameters

printIdstringrequired

Header parameters

api-keystringrequired

Body

namestring

promptstring · max: 4096

additionalPromptstring · max: 1024

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

optimizePromptboolean

Optimize description for image generation

metaDataobject

Pass on metadata to a ImageGeneration

modestring · enum

Options: simple, advanced

processModestring · enum · default: fast

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

Options: relax, fast

paramsobject[]

tagsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v1/image-generations/{printId}' \
  --header 'api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "prompt": "text",
    "additionalPrompt": "text",
    "optimizePrompt": true,
    "metaData": {},
    "mode": "simple",
    "processMode": "fast",
    "params": [
      {
        "value": "text",
        "name": "sujetMode"
      }
    ],
    "tags": [
      "text"
    ]
  }'

200

400

500

200

{
  "id": "text",
  "name": "text",
  "prompt": "text",
  "nbImages": 1,
  "metaData": {},
  "createdAt": "2025-02-28T07:10:40.666Z",
  "status": 0,
  "processMode": "fast",
  "params": [
    {
      "value": "text",
      "name": "sujetMode"
    }
  ],
  "images": [
    {
      "id": "text",
      "url": "text",
      "urlFull": "text",
      "validate": true,
      "free": true,
      "titles": {}
    }
  ],
  "tags": [
    "text"
  ]
}

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

/v1/image-generations/retry/{printId}

Path parameters

printIdstringrequired

Header parameters

api-keystringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/image-generations/retry/{printId}' \
  --header 'api-key: text'

200

400

500

200

No body

Find Image Generations

Retrieves a list of all image generations.

Get image generations

get

/v1/image-generations

Query parameters

limitnumber

offsetnumber

sortstring

namestring

Search prints by name

tagstring

Search prints by tag

Header parameters

api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/image-generations' \
  --header 'api-key: text'

200

400

500

200

{
  "filteredResults": 1,
  "prints": [
    {
      "id": "text",
      "name": "text",
      "prompt": "text",
      "nbImages": 1,
      "metaData": {},
      "createdAt": "2025-02-28T07:10:40.666Z",
      "status": 0,
      "processMode": "fast",
      "params": [
        {
          "value": "text",
          "name": "sujetMode"
        }
      ],
      "images": [
        {
          "id": "text",
          "url": "text",
          "urlFull": "text",
          "validate": true,
          "free": true,
          "titles": {}
        }
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

Get Image Generation

Retrieves an image generation from its ID.

Get an image generation

get

/v1/image-generations/{imageGenerationId}

Path parameters

imageGenerationIdstringrequired

Header parameters

api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/image-generations/{imageGenerationId}' \
  --header 'api-key: text'

200

400

500

200

{
  "id": "text",
  "name": "text",
  "prompt": "text",
  "nbImages": 1,
  "metaData": {},
  "createdAt": "2025-02-28T07:10:40.666Z",
  "status": 0,
  "processMode": "fast",
  "params": [
    {
      "value": "text",
      "name": "sujetMode"
    }
  ],
  "images": [
    {
      "id": "text",
      "url": "text",
      "urlFull": "text",
      "validate": true,
      "free": true,
      "titles": {}
    }
  ],
  "tags": [
    "text"
  ]
}

Delete Image Generation(s)

Delete one or more image generations.

Delete image generations

delete

/v1/image-generations

Header parameters

api-keystringrequired

Body

printIdsstring[]required

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/image-generations' \
  --header 'api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "printIds": [
      "text"
    ]
  }'

200

400

500

200

No body