All-Images.ai
My Account
  • Welcome
  • All-Images.ai API
    • Overview
    • Authentication
    • Errors
    • Pagination
    • API Reference
      • Images
      • Images generation
      • API Keys
      • API Keys Webhook
    • API Explorer
  • Integration guide
    • Image generation
      • Create Image generation
      • Lifecycle of Image generation
    • Webhooks
      • Image generation
  • Changelog
    • API
Powered by GitBook
On this page

Was this helpful?

  1. All-Images.ai API
  2. API Reference

Images generation

PreviousImagesNextAPI Keys

Last updated 10 months ago

Was this helpful?

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 :

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.

Retry Image Generation

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

Find Image Generations

Retrieves a list of all image generations.

Get Image Generation

Retrieves an image generation from its ID.

Delete Image Generation(s)

Delete one or more image generations.

https://developer.all-images.ai/integration-guide/image-generation

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
400Error
500Error
get
GET /v1/image-generations HTTP/1.1
Host: 
api-key: text
Accept: */*
{
  "filteredResults": 1,
  "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": "2025-05-14T17:25:15.563Z"
    }
  ]
}

Get an image generation

get
Path parameters
imageGenerationIdstringRequired
Header parameters
api-keystringRequired
Responses
200Success
application/json
400Error
500Error
get
GET /v1/image-generations/{imageGenerationId} HTTP/1.1
Host: 
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": "2025-05-14T17:25:15.563Z"
}

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
400Error
500Error
post
POST /v1/image-generations HTTP/1.1
Host: 
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": "2025-05-14T17:25:15.563Z"
}

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
400Error
500Error
put
PUT /v1/image-generations/{printId} HTTP/1.1
Host: 
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": "2025-05-14T17:25:15.563Z"
}

Delete image generations

delete
Header parameters
api-keystringRequired
Body
printIdsstring[]Required

Print IDs to delete

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

{
  "printIds": [
    "text"
  ]
}

No content

Retry an image generation failed

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

No content

  • Create Image generation
  • POSTCreate an image generation
  • Update Image Generation
  • PUTUpdate an image generation
  • Retry Image Generation
  • POSTRetry an image generation failed
  • Find Image Generations
  • GETGet image generations
  • Get Image Generation
  • GETGet an image generation
  • Delete Image Generation(s)
  • DELETEDelete image generations