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

Body

application/json

name*string

mode*enum

simpleadvanced

prompt*string

additionalPromptstring

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

optimizePromptboolean

Optimize description for image generation

paramsarray of ApiCreatePrintParam (object)

processModeenum

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

relaxfast

tagsarray of string

Tags make it easy to find generations

metaDataobject

Pass on metadata to a ImageGeneration

Response

200400500

Body

application/json

idstring

name*string

prompt*string

status*enum

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

012345

params*array of ApiPrintParam (object)

processModeenum

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

relaxfast

imagesarray of ApiFindImage (object)

nbImagesnumber

tagsarray of string

metaDataobject

createdAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/v1/image-generations', {
    method: 'POST',
    headers: {
      "api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "mode": "simple",
      "prompt": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "prompt": "text",
  "status": 0,
  "params": [
    {
      "name": "sujetMode",
      "value": "text"
    }
  ],
  "processMode": "relax",
  "images": [
    {
      "id": "text",
      "url": "text",
      "urlFull": "text",
      "validate": false,
      "free": false
    }
  ],
  "nbImages": 0,
  "tags": [
    "text"
  ],
  "createdAt": "2024-11-21T07:50:06.611Z"
}

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

printId*string

Header parameters

Body

application/json

namestring

modeenum

simpleadvanced

promptstring

additionalPromptstring

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

optimizePromptboolean

Optimize description for image generation

paramsarray of ApiCreatePrintParam (object)

processModeenum

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

relaxfast

tagsarray of string

Tags make it easy to find generations

metaDataobject

Pass on metadata to a ImageGeneration

Response

200400500

Body

application/json

idstring

name*string

prompt*string

status*enum

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

012345

params*array of ApiPrintParam (object)

processModeenum

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

relaxfast

imagesarray of ApiFindImage (object)

nbImagesnumber

tagsarray of string

metaDataobject

createdAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/v1/image-generations/{printId}', {
    method: 'PUT',
    headers: {
      "api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "prompt": "text",
  "status": 0,
  "params": [
    {
      "name": "sujetMode",
      "value": "text"
    }
  ],
  "processMode": "relax",
  "images": [
    {
      "id": "text",
      "url": "text",
      "urlFull": "text",
      "validate": false,
      "free": false
    }
  ],
  "nbImages": 0,
  "tags": [
    "text"
  ],
  "createdAt": "2024-11-21T07:50:06.611Z"
}

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

printId*string

Header parameters

Response

200400500

Request

JavaScriptCurlPython

const response = await fetch('/v1/image-generations/retry/{printId}', {
    method: 'POST',
    headers: {
      "api-key": "text"
    },
});
const data = await response.json();

Find Image Generations

Retrieves a list of all image generations.

Get image generations

GET/v1/image-generations

Query parameters

Header parameters

Response

200400500

Body

application/json

filteredResultsnumber

prints*array of ApiPrintDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/image-generations', {
    method: 'GET',
    headers: {
      "api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "filteredResults": 0,
  "prints": [
    {
      "id": "text",
      "name": "text",
      "prompt": "text",
      "status": 0,
      "params": [
        {
          "name": "sujetMode",
          "value": "text"
        }
      ],
      "processMode": "relax",
      "images": [
        {
          "id": "text",
          "url": "text",
          "urlFull": "text",
          "validate": false,
          "free": false
        }
      ],
      "nbImages": 0,
      "tags": [
        "text"
      ],
      "createdAt": "2024-11-21T07:50:06.611Z"
    }
  ]
}

Get Image Generation

Retrieves an image generation from its ID.

Get an image generation

GET/v1/image-generations/{imageGenerationId}

Path parameters

imageGenerationId*string

Header parameters

Response

200400500

Body

application/json

idstring

name*string

prompt*string

status*enum

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

012345

params*array of ApiPrintParam (object)

processModeenum

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

relaxfast

imagesarray of ApiFindImage (object)

nbImagesnumber

tagsarray of string

metaDataobject

createdAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/v1/image-generations/{imageGenerationId}', {
    method: 'GET',
    headers: {
      "api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "prompt": "text",
  "status": 0,
  "params": [
    {
      "name": "sujetMode",
      "value": "text"
    }
  ],
  "processMode": "relax",
  "images": [
    {
      "id": "text",
      "url": "text",
      "urlFull": "text",
      "validate": false,
      "free": false
    }
  ],
  "nbImages": 0,
  "tags": [
    "text"
  ],
  "createdAt": "2024-11-21T07:50:06.611Z"
}

Delete Image Generation(s)

Delete one or more image generations.

Delete image generations

DELETE/v1/image-generations

Header parameters

Body

application/json

printIds*array of string

Print IDs to delete

Response

200400500

Request

JavaScriptCurlPython

const response = await fetch('/v1/image-generations', {
    method: 'DELETE',
    headers: {
      "api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "printIds": [
        "text"
      ]
    }),
});
const data = await response.json();