Images generation
Create Image generation
Image generation is used to obtain a proposal of 4 images based on a description and various parameters.
Additional Prompt, not affected by optimization if enabled. Added at the beginning
Optimize description for image generation
Mode of the image generation (only for "Dedicated" user)
fast
Possible values: Tags make it easy to find generations
Pass on metadata to a ImageGeneration
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-06-24T05:10:51.056Z"
}
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.
Additional Prompt, not affected by optimization if enabled. Added at the beginning
Optimize description for image generation
Mode of the image generation (only for "Dedicated" user)
fast
Possible values: Tags make it easy to find generations
Pass on metadata to a ImageGeneration
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-06-24T05:10:51.056Z"
}
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.
Search prints by name
Search prints by tag
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-06-24T05:10:51.056Z"
}
]
}
Get Image Generation
Retrieves an image generation from its ID.
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-06-24T05:10:51.056Z"
}
Delete Image Generation(s)
Delete one or more image generations.
Print IDs to delete
DELETE /v1/image-generations HTTP/1.1
Host:
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"printIds": [
"text"
]
}
No content
Last updated
Was this helpful?